This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%DeepSee.UI.Settings

class %DeepSee.UI.Settings extends %DeepSee.UI.standardPage

DeepSee Settings page.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOCBOOKID = D2GS_uis_settings;
Inherited description: Docbook ID for this page.
parameter PAGENAME = Settings;
Inherited description: Name of this page.

Properties

property btnApply as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Apply") ];
Property methods: btnApplyDisplayToLogical(), btnApplyGet(), btnApplyIsValid(), btnApplyLogicalToDisplay(), btnApplyLogicalToOdbc(), btnApplyNormalize(), btnApplySet()
property btnNew as %ZEN.Datatype.caption [ InitialExpression = $$$Text("New") ];
Property methods: btnNewDisplayToLogical(), btnNewGet(), btnNewIsValid(), btnNewLogicalToDisplay(), btnNewLogicalToOdbc(), btnNewNormalize(), btnNewSet()
property btnRemove as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove") ];
Property methods: btnRemoveDisplayToLogical(), btnRemoveGet(), btnRemoveIsValid(), btnRemoveLogicalToDisplay(), btnRemoveLogicalToOdbc(), btnRemoveNormalize(), btnRemoveSet()
property currIcon as %Integer;
Property methods: currIconDisplayToLogical(), currIconGet(), currIconIsValid(), currIconLogicalToDisplay(), currIconNormalize(), currIconSet(), currIconXSDToLogical()
property currSetting as %Integer;
Property methods: currSettingDisplayToLogical(), currSettingGet(), currSettingIsValid(), currSettingLogicalToDisplay(), currSettingNormalize(), currSettingSet(), currSettingXSDToLogical()

Methods

method %CreateOptions(pPage As %String, pWorklist As %Integer, pGroup As %ZEN.Component.group, ByRef pOptions) as %Status
Create list of worklist option controls.
method %OnAfterCreatePage() as %Status
Decorate the page.
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.
classmethod %OnPreHTTP() as %Boolean
Test for additional resources.
classmethod ApplyIconToServer(pName As %String, pPath As %String, pOldName As %String) as %String [ ZenMethod ]
Apply a user icon value (if pName is not ""). If pOldName is non-"", delete it.
classmethod ApplySettingToServer(pName As %String, pValue As %String, pComment As %String, pContext As %String, pOldName As %String) as %String [ ZenMethod ]
Apply a setting value (if pName is not ""). If pOldName is non-"", delete it.
method GetUserIcons(ByRef pParameters, Output pMetaData, Output pData) as %Status
Return the current user icons for the JSON provider.
method GetUserSettings(ByRef pParameters, Output pMetaData, Output pData) as %Status
Return the current user settings for the JSON provider.
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.
classmethod SaveToServer(pData As %ZEN.proxyObject) as %String [ ZenMethod ]
Save settings to the settings global.
classmethod SetCustom(pValue As %Boolean) [ ZenMethod ]
Set custom worklist option.
classmethod SetOption(pPage As %String, pWorklist As %String, pClass As %String, pNum As %Integer, pValue As %Boolean) [ ZenMethod ]
Click on worklist option.
clientmethod addIcon() [ Language = javascript ]
Add a new user icon.
clientmethod addSetting() [ Language = javascript ]
Add a new setting.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod applyIcon() [ Language = javascript ]
Apply current icon.
clientmethod applySetting() [ Language = javascript ]
Apply current setting.
clientmethod customChange(value) [ Language = javascript ]
Click on custom option.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Inherited description: Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod optionChange(page, worklist, n, cls, value) [ Language = javascript ]
Click on worklist option.
clientmethod removeIcon(idx) [ Language = javascript ]
Remove current icon.
clientmethod removeSetting(idx) [ Language = javascript ]
Remove current setting.
clientmethod renderIconList() [ Language = javascript ]
Draw list of user icons.
clientmethod renderSettings() [ Language = javascript ]
Draw list of user settings.
clientmethod saveSettings() [ Language = javascript ]
Save settings.
clientmethod selectIcon(n) [ Language = javascript ]
Select an icon.
clientmethod selectSetting(n) [ Language = javascript ]
Select a setting.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback