Class %DeepSee.UI.Settings

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

DeepSee Settings page.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	5	30

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	StdTitle	aboutPage	align
aux	backgroundTimerInterval	btnApply	btnNew
btnRemove	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	cssLevel	currIcon	currSetting
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

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms	%Attr
%BindExport	%ClassIsLatestVersion	%ClassName	%ConstructClone
%CreateOptions	%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	%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
%Register	%RemoveChild	%RemoveChildren	%RemoveComponent
%RemoveFromSaveSet	%RunBackgroundMethod	%Self	%SerializeObject
%SetBackgroundMethodStatus	%SetErrorById	%SetErrorByName	%SetModified
%SetValueById	%SetValueByName	%SetValuesByName	%StartScript
%ValidateObject	%ZENVersion	ApplyIconToServer	ApplySettingToServer
BuildMenu	CheckContextLinks	CheckEnterpriseManager	ConvertParameter
Decrypt	DoLogout	DrawLocator	DrawRibbon
DrawTitle	Encrypt	EscapeHTML	EscapeURL
GetCSPURL	GetContextLinks	GetDocURL	GetNewURL
GetQuickLinks	GetUserIcons	GetUserSettings	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RewriteURL	SaveToServer
SetCustom	SetOption	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	addIcon
addSetting	adjustSizes	applyIcon	applySetting
cancelPopup	changePassword	childrenMutated	correctIELayering
createComponent	createComponentNS	customChange	deleteComponent
disableCommandButton	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	enableCommandButton
endModal	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
onPopupAction	onRefreshContents	onSerialize	onServerMethodCall
onServerMethodError	onServerMethodReturn	onStartModalHandler	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	optionChange	popupActionHandler
refreshContents	reloadPage	removeChild	removeIcon
removeSetting	render	renderContents	renderIconList
renderSVG	renderSettings	saveSettings	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
selectIcon	selectSetting	setComponentId	setConnectivityStatusMsg
setHidden	setModified	setOverlayMode	setPageTitle
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showCommandButton	showContact	showHelp	startModal
startProgressBar	stopProgressBar	switchNamespace

Parameters

• parameter DOCBOOKID = "D2GS_uis_settings";

Docbook ID for this page.

• parameter PAGENAME = "Settings";

Name of this page.

• parameter RESOURCE = "%DeepSee_Admin,%Development";

All Analytics pages require %DeepSee_Portal USE.

Properties

• 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;

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.

• 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.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search