Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [UI] >  [ListingGroupManager]
Private  Storage   

class %DeepSee.UI.ListingGroupManager extends %DeepSee.UI.standardPage

DeepSee term list manager page. This page lets you view and edit "term lists" (lookup tables used by DeepSee models).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 9 44


Summary

This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

Properties
%condition %import %includeFiles %model
%page %resource StdTitle aboutPage
align aux backgroundTimerInterval canViewSQL
canWrite canWritePage cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode dataSource disabled
docbookId dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle homePage
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
limitPopups listingGroupName name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent reload replaceExisting
searchKey sessionCookie showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod
%EndScript %Eval %EvalC %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion BuildMenu CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt Delete DoLogout
DrawHelp DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL GetCSPURL
GetContextLinks GetDocPage GetListingGroupContent GetListingTree
GetNewURL GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link ListingGroupExists LoadListingSource LookUpClassName
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer SubmitListingGroupContent
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addListing adjustSizes
applyDescription browseSubjectAreas canUserModify cancelPopup
changeListingGroup changePassword changeUseSQL childrenMutated
controlFormAccess correctIELayering createComponent createComponentNS
createListing deleteComponent deleteListing deleteListingGroup
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler editDescription
editItem enableCommandButton endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction formChanged getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getListingGroup getOpener getPageTitle
getProperty getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isOfType launchPopupWindow
loadListingGroup logout makeId navigate
newListingGroup notImplemented onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents reloadPage removeChild render
renderContents renderSVG saveListingGroup searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
selectCubeList setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setRibbonMessage setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showHelp startModal
startProgressBar stopProgressBar switchNamespace treeExpand
treePrepare updateForm


Parameters

• parameter DEFAULTVIEWMODE;
If this page has multiple views, this is its initial display mode.
• parameter DOCBOOKID;
Docbook ID for this page.
• parameter PAGENAME = "DeepSee Listing Group Manager";
Displayed name of this page.

Properties

• property %model as %DeepSee.Model.ListingGroup.listingGroup;
The current copy of the listing group
• property canViewSQL as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user is allowed to access teh custom SQL fields.
• property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify this particular listing group.
• property canWritePage as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, the user has write access to the page.
• property dataSource as %ZEN.Datatype.string;
Source class for these listings
• property listingGroupName as %ZEN.Datatype.string(ZENURL="LISTINGGROUP");
Name of listing group.
• property reload as %ZEN.Datatype.boolean(ZENURL="RELOAD") [ InitialExpression = 0 ];
Indicates the page reloaded itself if LISTINGGROUP is empty
• property replaceExisting as %ZEN.Datatype.string(ZENURL="REPLACE");
• property sessionCookie as %ZEN.Datatype.string;
Current CSP session.

Methods

• method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
• method %OnCreatePage() as %Status
This callback is called just after the server-side page object is created but before its children are created.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetProductName() as %String
Get the product name for the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• method %Register() as %Status
Register this visit to the recent items list.
• method Delete(pName As %String) as %String [ ZenMethod ]
Delete a term list.
• method DrawHelp(pSeed As %String) as %Status
Draw the help panel.
• method GetListingGroupContent(ByRef pParameters, Output pObject As %RegisteredObject) as %Status [ ZenMethod ]
• method GetListingTree(pRoot As %String, Output pTree, ByRef pParms) [ ZenMethod ]
Load the dynaTree control's contents from the server.
• method ListingGroupExists(pListGroupName As %String) as %Boolean [ ZenMethod ]
• method LoadListingSource() as %String
Return Data Connector list
• method LookUpClassName(pListingGroupName="") as %String [ ZenMethod ]
Find the class name given a name of a listing group
• method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content is best wrapped within a single td element. It can also consist of multiple td elements.

To achieve a fixed position for elements within the ribbon, for a fixed width page you can use a single enclosing td that contains a table and a single tr, with td elements inside that single tr that contain your content for the ribbon.

To achieve a fixed position for elements within the ribbon, for a page whose width varies depending on its contents (thereby stretching the ribbon) you can use multiple td elements to contain your content and then a final td element that is empty and has width 40% (or so) to push your contents towards the left and keep them in their proper locations.

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• method SubmitListingGroupContent(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Perfrom the actual work of saving the current listing group definition to the storage class. If called with pCommand = "compile" the class will also be compiled, activating the listings defined in the group.
• method addListing() [ Language = javascript ]
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method applyDescription(what) [ Language = javascript ]
Set textarea description back into the text description field.
• method browseSubjectAreas() [ Language = javascript ]
Launch the subject area finder.
• method canUserModify() [ Language = javascript ]
Test if the user has write privilege.
• method changeListingGroup() [ Language = javascript ]
Switch to a different listing group.
• method changeUseSQL() [ Language = javascript ]
User checked/unchecked the Use SQL field
• method controlFormAccess() [ Language = javascript ]
• method createListing() [ Language = javascript ]
Create new listing object.
• method deleteListing() [ Language = javascript ]
• method deleteListingGroup() [ Language = javascript ]
Delete the current listing group.
• method editDescription(what) [ Language = javascript ]
Toggle to show/hide Description textarea; set what's in text into textarea.
• method editItem(what) [ Language = javascript ]
Invoke dialog to edit certain items: RangeExpression, FormatString, SourceProperty, SourceExpression, CubeResource, ListingResource, ListingField.
• method formChanged(ctrl) [ Language = javascript ]
Change to details form.
• method getListingGroup() [ Language = javascript ]
Get the json provider component that contains the current listing group.
• method getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row. This should be implemented in a subclass.
• method loadListingGroup() [ Language = javascript ]
Client side method for loading the json object from the server
• method newListingGroup() [ Language = javascript ]
Create a new listing group.
• method notImplemented() [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method saveListingGroup(rename, compile, silent=0) [ Language = javascript ]
save the listing group to its storage class.
• method selectCubeList() [ Language = javascript ]
Launch a dialog to select the target cubes for this listing group
• method setRibbonMessage(message) [ Language = javascript ]
OCnvenience utility for setting the ribbon message
• method treeExpand(tree) [ Language = javascript ]
Set the tree to expanded, no matter what state it is in currently
• method treePrepare() [ Language = javascript ]
Do any actions necessary for proper presentation when the tree is first loaded
• method updateForm() [ Language = javascript ]
Update the group and listing details forms.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.