Skip to main content

%DeepSee.UI.Settings

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

DeepSee Settings page.

Parameters​

PAGENAME​

Parameter PAGENAME = "Settings";

RESOURCE​

Parameter RESOURCE = "%DeepSee_Admin,%Development";

DOCBOOKID​

Parameter DOCBOOKID = "D2GS_uis_settings";

Properties​

currSetting​

Property currSetting As %Integer;

currIcon​

Property currIcon As %Integer;

btnNew​

Property btnNew As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("New")} ];

btnApply​

Property btnApply As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Apply")} ];

btnRemove​

Property btnRemove As %ZEN.Datatype.caption [ InitialExpression = {$$$Text("Remove")} ];

XDatas​

Style​

XData Style

contentPane​

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

This XML defines the contents of the contents pane for this page.

Methods​

%OnGetTitle​

Method %OnGetTitle() As %String

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

%OnGetProductName​

Method %OnGetProductName() As %String

Get the product name for the page.

%OnGetPageName​

Method %OnGetPageName() As %String

Get the (localized) name of 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.

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.

saveSettings​

ClientMethod saveSettings() [ Language = javascript ]

Save settings.

SaveToServer​

ClassMethod SaveToServer(pData As %ZEN.proxyObject) As %String [ ZenMethod ]

Save settings to the settings global.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

Decorate the page.

%CreateOptions​

Method %CreateOptions(pPage As %String, pWorklist As %Integer, pGroup As %ZEN.Component.group, ByRef pOptions) As %Status

Create list of worklist option controls.

optionChange​

ClientMethod optionChange(page, worklist, n, cls, value) [ Language = javascript ]

Click on worklist option.

SetOption​

ClassMethod SetOption(pPage As %String, pWorklist As %String, pClass As %String, pNum As %Integer, pValue As %Boolean) [ ZenMethod ]

Click on worklist option.

customChange​

ClientMethod customChange(value) [ Language = javascript ]

Click on custom option.

SetCustom​

ClassMethod SetCustom(pValue As %Boolean) [ ZenMethod ]

Set custom worklist option.

GetUserIcons​

Method GetUserIcons(ByRef pParameters, Output pMetaData, Output pData) As %Status

Return the current user icons for the JSON provider.

GetUserSettings​

Method GetUserSettings(ByRef pParameters, Output pMetaData, Output pData) As %Status

Return the current user settings for the JSON provider.

renderIconList​

ClientMethod renderIconList() [ Language = javascript ]

Draw list of user icons.

renderSettings​

ClientMethod renderSettings() [ Language = javascript ]

Draw list of user settings.

selectIcon​

ClientMethod selectIcon(n) [ Language = javascript ]

Select an icon.

selectSetting​

ClientMethod selectSetting(n) [ Language = javascript ]

Select a setting.

addIcon​

ClientMethod addIcon() [ Language = javascript ]

Add a new user icon.

addSetting​

ClientMethod addSetting() [ Language = javascript ]

Add a new setting.

applyIcon​

ClientMethod applyIcon() [ Language = javascript ]

Apply current icon.

applySetting​

ClientMethod applySetting() [ Language = javascript ]

Apply current setting.

removeIcon​

ClientMethod removeIcon(idx) [ Language = javascript ]

Remove current icon.

removeSetting​

ClientMethod removeSetting(idx) [ Language = javascript ]

Remove current setting.

ApplyIconToServer​

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.

ApplySettingToServer​

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.

onPopupAction​

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

%OnPreHTTP​

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

Test for additional resources.