Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.UI.Settings
Private  Storage   


class %DeepSee.UI.Settings extends

DeepSee Settings page.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 5 30


This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode SVGClassList
StdTitle UserSVGPackageList aboutPage align
aux backgroundTimerInterval btnApply btnNew
btnRemove cellAlign cellSize cellStyle
cellVAlign children composite contactPage
containerStyle cssLevel currIcon currSetting
currSortMode currStep currViewMode designMode
disabled docbookId dragAndDrop dragEnabled
dropEnabled dynamic enableAutoRefresh enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle homePage id index
inlineSVG isPopup isSoftModal label
labelClass labelDisabledClass labelPosition labelStyle
lastModalIndex layout limitPopups name
nextIndex onafterdrag onbeforedrag onclick
ondrag ondrop onhide onoverlay
onrefresh onshow onupdate overlayMode
pageModified parent popupParent renderFlag
searchKey showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddImportedComponents %AddToSaveSet %ApplyURLParms
%Attr %BindExport %BuildObjectGraph %ClassIsLatestVersion
%ClassName %Close %ConstructClone %CreateApplication
%CreateOptions %CreatePage %DetermineCSSLevel %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinition
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSGetSettings %DrawJSSerialize %DrawJSStrings %DrawObjectDefinitions
%DrawObjectProperties %DrawSVGDef %DrawStyleDefinitions %DrawStyleHTML
%DrawStyleSVG %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GenerateCode %GetAllNamespaces %GetChildIndex %GetClassCRC
%GetClassDepth %GetComponent %GetComponentById %GetComponentByName
%GetComponentPropertyById %GetDependentComponents %GetEventHandlers %GetIncludeFiles
%GetIncludeInfo %GetLinks %GetLocatorLinks %GetPageName
%GetPaneContents %GetParameter %GetRootLink %GetSuperClassList
%GetValueById %GetValueByName %GetXMLName %IncrementCount
%IsA %IsEmbedded %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %ObjectSynch %OnAddToPage
%OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage
%OnCreateApplication %OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv
%OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties
%OnFinishBackgroundTask %OnGetPageName %OnGetProductName %OnGetSmallMenu
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%ReallyAddChild %Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %XMLGenerate %ZENDeserialize
%ZENVersion ApplyIconToServer ApplySettingToServer BuildMenu
CheckContextLinks CheckEnterpriseManager ConvertParameter Decrypt
DoLogout DrawLocator DrawRibbon DrawTitle
Encrypt EncryptBroker EscapeHTML EscapeURL
GetCSPURL GetContextLinks GetDocURL GetNewURL
GetQuickLinks GetUserIcons GetUserSettings HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields InvokeClassMethod InvokeInstanceMethod
IsPrivate Link LoadZenComponent MonitorBackgroundTask
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS ReallyRefreshContents
RewriteURL SaveToServer SetCustom SetOption
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
addIcon addSetting adjustSizes applyIcon
applySetting backgroundTimerHandler cancelPopup changePassword
childrenMutated clearBackgroundTask correctIELayering createComponent
createComponentNS customChange deleteComponent disableCommandButton
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent findElement fireOnLoadEvent fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getPageTitle
getProperty getSettings getTargetPage getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler optionChange popupActionHandler progressBarHandler
refreshContents reloadPage removeChild removeIcon
removeSetting render renderContents renderIconList
renderSVG renderSettings saveSettings searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
selectIcon selectSetting setBackgroundTask setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showHelp
startModal startProgressBar stopProgressBar switchNamespace
testConnectivity updateControlsInGroup


• parameter DOCBOOKID = "D2GS_uis_settings";
Docbook ID for this page.
• parameter PAGENAME = "Settings";
Name of this page.


• property btnApply as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Apply") ];
• property btnNew as %ZEN.Datatype.caption [ InitialExpression = $$$Text("New") ];
• property btnRemove as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove") ];
• property currIcon as %Integer;
• property currSetting as %Integer;


• 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.
• method addIcon() [ Language = javascript ]
Add a new user icon.
• method addSetting() [ Language = javascript ]
Add a new setting.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method applyIcon() [ Language = javascript ]
Apply current icon.
• method applySetting() [ Language = javascript ]
Apply current setting.
• method customChange(value) [ Language = javascript ]
Click on custom option.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method optionChange(page, worklist, n, cls, value) [ Language = javascript ]
Click on worklist option.
• method removeIcon(idx) [ Language = javascript ]
Remove current icon.
• method removeSetting(idx) [ Language = javascript ]
Remove current setting.
• method renderIconList() [ Language = javascript ]
Draw list of user icons.
• method renderSettings() [ Language = javascript ]
Draw list of user settings.
• method saveSettings() [ Language = javascript ]
Save settings.
• method selectIcon(n) [ Language = javascript ]
Select an icon.
• method selectSetting(n) [ Language = javascript ]
Select a setting.