This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.UI.ListingGroupManager

%DeepSee.UI.ListingGroupManager

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).

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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

Properties (Including Private)

property %model as %DeepSee.Model.ListingGroup.listingGroup;
The current copy of the listing group
Property methods: %modelGet(), %modelGetSwizzled(), %modelIsValid(), %modelNewObject(), %modelSet()
property canViewSQL as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user is allowed to access teh custom SQL fields.
Property methods: canViewSQLDisplayToLogical(), canViewSQLGet(), canViewSQLIsValid(), canViewSQLLogicalToDisplay(), canViewSQLLogicalToOdbc(), canViewSQLLogicalToXSD(), canViewSQLNormalize(), canViewSQLSet(), canViewSQLXSDToLogical()
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify this particular listing group.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWritePageDisplayToLogical(), canWritePageGet(), canWritePageIsValid(), canWritePageLogicalToDisplay(), canWritePageLogicalToOdbc(), canWritePageLogicalToXSD(), canWritePageNormalize(), canWritePageSet(), canWritePageXSDToLogical(), canWriteSet(), canWriteXSDToLogical()
property canWritePage as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, the user has write access to the page.
Property methods: canWritePageDisplayToLogical(), canWritePageGet(), canWritePageIsValid(), canWritePageLogicalToDisplay(), canWritePageLogicalToOdbc(), canWritePageLogicalToXSD(), canWritePageNormalize(), canWritePageSet(), canWritePageXSDToLogical()
property dataSource as %ZEN.Datatype.string;
Source class for these listings
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property listingGroupName as %ZEN.Datatype.string (ZENURL = "LISTINGGROUP");
Name of listing group.
Property methods: listingGroupNameDisplayToLogical(), listingGroupNameGet(), listingGroupNameIsValid(), listingGroupNameLogicalToDisplay(), listingGroupNameLogicalToOdbc(), listingGroupNameNormalize(), listingGroupNameSet()
property reload as %ZEN.Datatype.boolean (ZENURL = "RELOAD") [ InitialExpression = 0 ];
Indicates the page reloaded itself if LISTINGGROUP is empty
Property methods: reloadDisplayToLogical(), reloadGet(), reloadIsValid(), reloadLogicalToDisplay(), reloadLogicalToOdbc(), reloadLogicalToXSD(), reloadNormalize(), reloadPage(), reloadSet(), reloadXSDToLogical()
property replaceExisting as %ZEN.Datatype.string (ZENURL = "REPLACE");
Property methods: replaceExistingDisplayToLogical(), replaceExistingGet(), replaceExistingIsValid(), replaceExistingLogicalToDisplay(), replaceExistingLogicalToOdbc(), replaceExistingNormalize(), replaceExistingSet()
property sessionCookie as %ZEN.Datatype.string;
Current CSP session.
Property methods: sessionCookieDisplayToLogical(), sessionCookieGet(), sessionCookieIsValid(), sessionCookieLogicalToDisplay(), sessionCookieLogicalToOdbc(), sessionCookieNormalize(), sessionCookieSet()

Methods (Including Private)

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.
clientmethod addListing() [ Language = javascript ]
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod applyDescription(what) [ Language = javascript ]
Set textarea description back into the text description field.
clientmethod browseSubjectAreas() [ Language = javascript ]
Launch the subject area finder.
clientmethod canUserModify() [ Language = javascript ]
Test if the user has write privilege.
clientmethod changeListingGroup() [ Language = javascript ]
Switch to a different listing group.
clientmethod changeUseSQL() [ Language = javascript ]
User checked/unchecked the Use SQL field
clientmethod controlFormAccess() [ Language = javascript ]
clientmethod createListing() [ Language = javascript ]
Create new listing object.
clientmethod deleteListing() [ Language = javascript ]
clientmethod deleteListingGroup() [ Language = javascript ]
Delete the current listing group.
clientmethod editDescription(what) [ Language = javascript ]
Toggle to show/hide Description textarea; set what's in text into textarea.
clientmethod editItem(what) [ Language = javascript ]
Invoke dialog to edit certain items: RangeExpression, FormatString, SourceProperty, SourceExpression, CubeResource, ListingResource, ListingField.
clientmethod formChanged(ctrl) [ Language = javascript ]
Change to details form.
clientmethod getListingGroup() [ Language = javascript ]
Get the json provider component that contains the current listing group.
clientmethod loadListingGroup() [ Language = javascript ]
Client side method for loading the json object from the server
clientmethod newListingGroup() [ Language = javascript ]
Create a new listing group.
clientmethod notImplemented() [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod saveListingGroup(rename, compile, silent=0) [ Language = javascript ]
save the listing group to its storage class.
clientmethod selectCubeList() [ Language = javascript ]
Launch a dialog to select the target cubes for this listing group
clientmethod setRibbonMessage(message) [ Language = javascript ]
OCnvenience utility for setting the ribbon message
clientmethod treeExpand(tree) [ Language = javascript ]
Set the tree to expanded, no matter what state it is in currently
clientmethod treePrepare() [ Language = javascript ]
Do any actions necessary for proper presentation when the tree is first loaded
clientmethod updateForm() [ Language = javascript ]
Update the group and listing details forms.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window