Skip to main content

%DeepSee.UI.TermListManager

Class %DeepSee.UI.TermListManager 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 = "Term List Manager";

Displayed name of this page.

DEFAULTVIEWMODE;​

Parameter DEFAULTVIEWMODE;

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

DOCBOOKID​

Parameter DOCBOOKID = "D2MODADV_ch_term_list";

RESOURCE​

Parameter RESOURCE = "%DeepSee_PortalEdit";

Properties​

termListName​

Property termListName As %ZEN.Datatype.string(ZENURL = "TERMLIST");

Name of term list.

replaceExisting​

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

XDatas​

Style​

XData Style

This Style block contains page-specific CSS style definitions.

contentPane​

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

Methods​

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.

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.

overwriteTermList​

Method overwriteTermList(pStreamId As %Integer, pTermListName) As %Status [ ZenMethod ]

getTermListNameFromStream​

Method getTermListNameFromStream(pStreamId As %Integer) As %String [ ZenMethod ]

termListExists​

Method termListExists(pTermListName As %String) As %Boolean [ ZenMethod ]

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.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

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

changeTermList​

ClientMethod changeTermList() [ Language = javascript ]

Launch the term list finder dialog.

changeTermListFromUpload​

ClientMethod changeTermListFromUpload() [ Language = javascript ]

User has selected a new term list.

browseSubjectAreas​

ClientMethod browseSubjectAreas() [ Language = javascript ]

Launch the subject area finder.

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.

searchBoxHandler​

ClientMethod searchBoxHandler(searchKey) [ Language = javascript ]

Change in search box value. Can be overridden by subclasses.

updateForm​

ClientMethod updateForm() [ Language = javascript ]

Update details form.

formChanged​

ClientMethod formChanged(ctrl) [ Language = javascript ]

Change to details form.

hideValueColumn​

ClientMethod hideValueColumn(flag) [ Language = javascript ]

Hide/show the value column.

arrowHandler​

ClientMethod arrowHandler(which) [ Language = javascript ]

Arrow handler for grid.

addRow​

ClientMethod addRow() [ Language = javascript ]

Add a new record.

removeRow​

ClientMethod removeRow() [ Language = javascript ]

Remove a record.

headerClick​

ClientMethod headerClick(which, index) [ Language = javascript ]

Click on header in grid.

addColumn​

ClientMethod addColumn() [ Language = javascript ]

Add a new column.

deleteColumn​

ClientMethod deleteColumn() [ Language = javascript ]

Delete a new column.

newTermList​

ClientMethod newTermList() [ Language = javascript ]

Create a new term list.

exportTermList​

ClientMethod exportTermList() [ Language = javascript ]

Export the termlist.

deleteTermList​

ClientMethod deleteTermList() [ Language = javascript ]

Delete the termlist.

saveTermList​

ClientMethod saveTermList(rename) [ Language = javascript ]

Save the termlist.

GetTermListContent​

Method GetTermListContent(ByRef pParameters, Output pObject As %RegisteredObject) As %Status

Get content object for JSON provider.

SubmitTermList​

Method SubmitTermList(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) As %Status

Object submit handler JSON provider. This is called when the client saves the term list.

Delete​

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

Delete a term list.

%OnSubmit​

ClassMethod %OnSubmit(pSubmit As %ZEN.Submit) As %Status

This callback is called when the upload form on this page is submitted. pSubmit is a %ZEN.Submit object containing details of the form submit.

getGrid​

ClientMethod getGrid() [ Language = javascript ]

Get the grid component.

gridKeyDown​

ClientMethod gridKeyDown(evt) [ Language = javascript ]

Key down handler for grid.

%OnPreHTTP​

ClassMethod %OnPreHTTP() As %Boolean [ ServerOnly = 1 ]

Test for additional resources.