%DeepSee.UI.Settings
class %DeepSee.UI.Settings extends %DeepSee.UI.standardPage
DeepSee Settings page.Property Inventory
Method Inventory
- %CreateOptions()
- %OnAfterCreatePage()
- %OnGetPageName()
- %OnGetProductName()
- %OnGetTitle()
- %OnPreHTTP()
- ApplyIconToServer()
- ApplySettingToServer()
- GetUserIcons()
- GetUserSettings()
- OnGetRibbonInfo()
- SaveToServer()
- SetCustom()
- SetOption()
- addIcon()
- addSetting()
- adjustSizes()
- applyIcon()
- applySetting()
- customChange()
- onPopupAction()
- onlayoutHandler()
- optionChange()
- removeIcon()
- removeSetting()
- renderIconList()
- renderSettings()
- saveSettings()
- selectIcon()
- selectSetting()
Parameters
parameter DOCBOOKID = D2GS_uis_settings;
Inherited description: Docbook ID for this page.
parameter PAGENAME = Settings;
Inherited description: Name of this page.
parameter RESOURCE = %DeepSee_Admin,%Development;
Inherited description: All Analytics pages require %DeepSee_Portal USE.
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
- %condition
- %import
- %includeFiles
- %page
- %resource
- StdTitle
- aboutPage
- align
- aux
- backgroundTimerInterval
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- contactPage
- containerStyle
- cssLevel
- currSortMode
- currStep
- currViewMode
- disabled
- docbookId
- dragAndDrop
- dragEnabled
- dropEnabled
- enableAutoRefresh
- enclosingClass
- enclosingStyle
- error
- groupClass
- groupStyle
- height
- hidden
- hint
- hintClass
- hintStyle
- homePage
- id
- index
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- limitPopups
- metaData
- name
- onafterdrag
- onbeforedrag
- onclick
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- pageModified
- parent
- searchKey
- showLabel
- slice
- title
- tuple
- useSVG
- useSoftModals
- valign
- visible
- width
- window
- zenPersistentPopup
Inherited Methods
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddComponent()
- %AddImportedComponents()
- %AddToSaveSet()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetChildIndex()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetLinks()
- %GetLocatorLinks()
- %GetPageName()
- %GetParameter()
- %GetRootLink()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %IsA()
- %IsModified()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnBeforeCreatePage()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnGetSmallMenu()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnSubmit()
- %OnUseSoftModals()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %Register()
- %RemoveChild()
- %RemoveChildren()
- %RemoveComponent()
- %RemoveFromSaveSet()
- %RunBackgroundMethod()
- %Self()
- %SerializeObject()
- %SetBackgroundMethodStatus()
- %SetErrorById()
- %SetErrorByName()
- %SetModified()
- %SetValueById()
- %SetValueByName()
- %SetValuesByName()
- %StartScript()
- %ValidateObject()
- %ZENVersion()
- BuildMenu()
- CheckContextLinks()
- CheckEnterpriseManager()
- ConvertParameter()
- Decrypt()
- DoLogout()
- DrawLocator()
- DrawRibbon()
- DrawTitle()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- GetCSPURL()
- GetContextLinks()
- GetDocURL()
- GetNewURL()
- GetQuickLinks()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- JavaInstalled()
- Link()
- OnDrawRibbon()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- ReallyClearEscalation()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- cancelPopup()
- changePassword()
- childrenMutated()
- clearEscalation()
- correctIELayering()
- createComponent()
- createComponentNS()
- deleteComponent()
- disableCommandButton()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- enableCommandButton()
- endModal()
- escalateLogin()
- exposeComponent()
- findElement()
- fireOnResizeEvent()
- fireOnUnloadEvent()
- fireOnUpdateEvent()
- firePopupAction()
- getChildIndex()
- getComponent()
- getComponentById()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOpener()
- getPageMeta()
- getPageTitle()
- getProperty()
- getSettings()
- getTitleAreaHeight()
- getType()
- goHome()
- goMenu()
- gotoNamespace()
- gotoPage()
- hideCommandButton()
- invokeSuper()
- isOfType()
- launchPopupWindow()
- logout()
- makeId()
- navigate()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondisabledHandler()
- onhandleAutoLogoutWarn()
- onkeydownHandler()
- onkeyupHandler()
- onloadHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- popupActionHandler()
- refreshContents()
- reloadPage()
- removeChild()
- render()
- renderContents()
- renderSVG()
- searchBlur()
- searchBoxHandler()
- searchFocus()
- searchKeyDown()
- searchKeyPress()
- setComponentId()
- setConnectivityStatusMsg()
- setHidden()
- setModified()
- setOverlayMode()
- setPageTitle()
- setProperty()
- setPropertyAll()
- setSortMode()
- setSortModeHandler()
- setTraceOption()
- setViewMode()
- setViewModeHandler()
- showAbout()
- showCommandButton()
- showContact()
- showHelp()
- startModal()
- startProgressBar()
- stopProgressBar()
- switchNamespace()