Skip to main content

%DeepSee.UI.ListingGroupManager

Class %DeepSee.UI.ListingGroupManager Extends %DeepSee.UI.standardPage [ System = 4 ]

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

Parameters​

PAGENAME​

Parameter PAGENAME = "DeepSee Listing Group Manager";

Displayed name of this page.

RESOURCE​

Parameter RESOURCE = "%DeepSee_ListingGroup,%DeepSee_ListingGroupEdit";

DEFAULTVIEWMODE;​

Parameter DEFAULTVIEWMODE;

If this page has multiple views, this is its initial display mode.

DOCBOOKID;​

Parameter DOCBOOKID;

Properties​

reload​

Property reload As %ZEN.Datatype.boolean(ZENURL = "RELOAD") [ InitialExpression = 0 ];

Indicates the page reloaded itself if LISTINGGROUP is empty

%model​

Property %model As %DeepSee.Model.ListingGroup.listingGroup;

The current copy of the listing group

canWritePage​

Property canWritePage As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, the user has write access to the page.

canWrite​

Property canWrite As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, user can modify this particular listing group.

canViewSQL​

Property canViewSQL As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, user is allowed to access teh custom SQL fields.

listingGroupName​

Property listingGroupName As %ZEN.Datatype.string(ZENURL = "LISTINGGROUP");

Name of listing group.

replaceExisting​

Property replaceExisting As %ZEN.Datatype.string(ZENURL = "REPLACE");

dataSource​

Property dataSource As %ZEN.Datatype.string;

Source class for these listings

sessionCookie​

Property sessionCookie As %ZEN.Datatype.string;

Current CSP session.

XDatas​

Style​

XData Style

This Style block contains page-specific CSS style definitions.

contentPane​

XData contentPane [ XMLNamespace = "http://www.intersystems.com/zen" ]

Methods​

OnGetRibbonInfo​

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.

newListingGroup​

ClientMethod newListingGroup() [ Language = javascript ]

Create a new listing group.

deleteListingGroup​

ClientMethod deleteListingGroup() [ Language = javascript ]

Delete the current listing group.

saveListingGroup​

ClientMethod saveListingGroup(rename, compile, silent = 0) [ Language = javascript ]

save the listing group to its storage class.

changeListingGroup​

ClientMethod changeListingGroup() [ Language = javascript ]

Switch to a different listing group.

loadListingGroup​

ClientMethod loadListingGroup() [ Language = javascript ]

Client side method for loading the json object from the server

editItem​

ClientMethod editItem(what) [ Language = javascript ]

Invoke dialog to edit certain items: RangeExpression, FormatString, SourceProperty, SourceExpression, CubeResource, ListingResource, ListingField.

selectCubeList​

ClientMethod selectCubeList() [ Language = javascript ]

Launch a dialog to select the target cubes for this listing group

GetListingTree​

Method GetListingTree(pRoot As %String, Output pTree, ByRef pParms) [ ZenMethod ]

Load the dynaTree control's contents from the server.

LookUpClassName​

Method LookUpClassName(pListingGroupName = "") As %String [ ZenMethod ]

Find the class name given a name of a listing group

DrawHelp​

Method DrawHelp(pSeed As %String) As %Status

Draw the help panel.

%OnGetTitle​

Method %OnGetTitle() As %String

Get the (localized) title string for the page. This should be implemented in a subclass.

getPageTitle​

ClientMethod getPageTitle() As %String [ Language = javascript ]

Get the title string to add to the locator row. This should be implemented in a subclass.

%OnGetPageName​

Method %OnGetPageName() As %String

Get the (localized) name of the page.

%OnGetProductName​

Method %OnGetProductName() As %String

Get the product name for the page.

ListingGroupExists​

Method ListingGroupExists(pListGroupName As %String) As %Boolean [ ZenMethod ]

GetListingGroupContent​

Method GetListingGroupContent(ByRef pParameters, Output pObject As %RegisteredObject) As %Status [ ZenMethod ]

SubmitListingGroupContent​

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.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

This class method callback is called just before the server-side page object is created.

onloadHandler​

ClientMethod onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

controlFormAccess​

ClientMethod controlFormAccess() [ Language = javascript ]

onlayoutHandler​

ClientMethod onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

adjustSizes​

ClientMethod adjustSizes() [ Language = javascript ]

Adjust sizes of components on the page.

getListingGroup​

ClientMethod getListingGroup() [ Language = javascript ]

Get the json provider component that contains the current listing group.

Delete​

Method Delete(pName As %String) As %String [ ZenMethod ]

Delete a term list.

browseSubjectAreas​

ClientMethod browseSubjectAreas() [ Language = javascript ]

Launch the subject area finder.

updateForm​

ClientMethod updateForm() [ Language = javascript ]

Update the group and listing details forms.

formChanged​

ClientMethod formChanged(ctrl) [ Language = javascript ]

Change to details form.

createListing​

ClientMethod createListing() [ Language = javascript ]

Create new listing object.

addListing​

ClientMethod addListing() [ Language = javascript ]

deleteListing​

ClientMethod deleteListing() [ Language = javascript ]

treeExpand​

ClientMethod treeExpand(tree) [ Language = javascript ]

Set the tree to expanded, no matter what state it is in currently

treePrepare​

ClientMethod treePrepare() [ Language = javascript ]

Do any actions necessary for proper presentation when the tree is first loaded

changeUseSQL​

ClientMethod changeUseSQL() [ Language = javascript ]

User checked/unchecked the Use SQL field

editDescription​

ClientMethod editDescription(what) [ Language = javascript ]

Toggle to show/hide Description textarea; set what's in text into textarea.

applyDescription​

ClientMethod applyDescription(what) [ Language = javascript ]

Set textarea description back into the text description field.

LoadListingSource​

Method LoadListingSource() As %String

Return Data Connector list

onPopupAction​

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this page fires an action.

canUserModify​

ClientMethod canUserModify() [ Language = javascript ]

Test if the user has write privilege.

notImplemented​

ClientMethod notImplemented() [ Language = javascript ]

%OnCreatePage​

Method %OnCreatePage() As %Status

This callback is called just after the server-side page object is created but before its children are created.

%Register​

Method %Register() As %Status

Register this visit to the recent items list.

OnDrawRibbon​

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.

setRibbonMessage​

ClientMethod setRibbonMessage(message) [ Language = javascript ]

OCnvenience utility for setting the ribbon message