Class %DeepSee.Component.Widget.controlPanel

class %DeepSee.Component.Widget.controlPanel extends %DeepSee.Component.Widget.widget

A specialized DeepSee Dashboard widget that displays controls without attached content. The widget does not require a dataSource to allow definition of controls. Some controls themselves require a dataSource to add information, for example the filter controls.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	2	13

Summary

Properties
%condition	%definition	%import	%includeFiles
%page	%resource	align	aux
backgroundColor	cellAlign	cellSize	cellStyle
cellVAlign	centerHeader	children	clickActions
clickActive	clickFilterSpec	clickTargetProperties	clickTargets
colSpan	colorToolbar	composite	containerStyle
controlIndices	currFilterSpec	currItemNo	currSeriesNo
currValue	currValueName	dataSource	disabled
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	filterDefault	filterState	filterText
forceToolbar	groupClass	groupStyle	hasInitialFilters
header	headerLayout	height	hidden
hint	hintClass	hintStyle	homeCol
homeRow	id	imageAppLogo	imageAppLogoWidth
imageClose	imageCloseHover	imageCloseWidth	imageContract
imageContractHover	imageContractWidth	imageExpand	imageExpandHover
imageExpandWidth	imageMaximize	imageMaximizeHover	imageMaximizeWidth
imageMinimize	imageMinimizeHover	imageMinimizeWidth	imageResize
imageResizeSize	index	isClosed	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	linkWidgetKey	maximized	minWidth
moveEnabled	name	onafterdrag	onbeforedrag
onclick	onclosepending	ondrag	ondrop
onhide	onrefresh	onresize	onshow
onupdate	onwindowdrop	onwindowgrab	opacity
opacityToolbar	parent	prevHomeCol	prevHomeRow
previewMode	resizeEnabled	rowSpan	sessionCookie
settings	showLabel	showSidebar	showTitleBar
showToolbar	showToolbarBottomBorder	showToolbarOnlyWhenMaximized	sidebarContent
sidebarWidth	slice	subtype	title
tuple	valign	visible	widgetKey
widgetLayout	width	window

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddFooter
%AddSidebar	%AddToSaveSet	%Attr	%BindExport
%ClassIsLatestVersion	%ClassName	%ConstructClone	%CreateController
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawComponentHTML
%DrawHTML	%DrawJSStrings	%EnclosingDivId	%Eval
%EvalC	%Extends	%FindComponent	%ForceClientRender
%GetCatalogInfo	%GetChildIndex	%GetDataController	%GetEventHandlers
%GetParameter	%GetWidgetPropertyInfo	%GetWidgetSettings	%GetXMLName
%IsA	%IsModified	%MakeId	%MakeWidgetId
%New	%NormalizeObject	%ObjectModified	%OnAddToPageAfter
%OnAddToPageBefore	%OnCreateControls	%OnCreateWidget	%OnDrawEnclosingDiv
%OnDrawObjectProperties	%OnMutateChildren	%OnObjectSynch	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveFromSaveSet	%Self
%SerializeObject	%SetModified	%ValidateObject	GetKpiFilterCaption
ResolveText	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	abortClose	addChild	addChildAfter
addChildBefore	adjustChildArea	adjustContentSize	adjustHandleWidth
adjustResizeBox	adjustSizes	animateIcon	applyCSSSettings
applyFilter	childrenMutated	close	closeWidget
compress	constrainDragX	constrainDragY	controlEventHandler
disableCoverplate	disableDrag	disableHeaderMaxToggle	disableResize
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	enableCoverplate	enableDrag
enableHeaderMaxToggle	enableResize	endDrag	expand
exposeComponent	findComponent	findElement	fireOnUpdateEvent
getChildDiv	getChildIndex	getCoverplateDiv	getDataController
getDefinition	getEnclosingDiv	getFilterTableForPrinting	getHeaderDiv
getHeaderUserDiv	getHidden	getHintElement	getLabelElement
getOverrideSkipList	getOverrides	getProperty	getSVGFrame
getSettingDisplayValue	getSettingLists	getSettings	getState
getSubtypeClass	getType	getWindowHeight	getWindowWidth
hasOverrides	initializeHomeRowCol	invokeSuper	isCompressed
isMasterWidget	isMaximized	isOfType	isResizeInProgress
makeId	maximize	navCloseButtonClick	navDataArrange
navDataChange	navHeaderButtonClick	navPopupAction	navSelectItem
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onGrabHandler	onPopupAction	onRefreshContents	onReleaseHandler
onSerialize	onStartModalHandler	ondisabledHandler	onloadHandler
onresizeHandler	onunloadHandler	onupdateHandler	openWidget
printSVGContent	processAppMessage	raiseEventHandler	refreshContents
removeChild	removeWindowChrome	render	renderContents
renderCoverplate	renderHeader	renderResize	renderSVG
resetOverrides	resetWindowChrome	resize	restoreGeometry
restoreState	saveGeometry	selectWidget	setAppLogo
setBodyStyle	setCenterLayout	setCloseIcon	setContractIcon
setExpandIcon	setHeaderLayout	setHeaderStyle	setHidden
setIcon	setMaximizeIcon	setMinimizeIcon	setModifiedIfDragged
setOpacity	setOverlayMode	setProperty	setPropertyAll
setToolbarProperty	showBreakdown	showDimensions	showGeoListing
showListing	startDrag	startProgressBar	stopProgressBar
syncObject	updateMenuBar	verifyHeaderGeometry

Properties

• property showTitleBar as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

This widget can override the title bar display.

• property showToolbarBottomBorder as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Specify whether to display the separator between the toolbar and widget content

Methods

• method %CreateController(pGroup As %ZEN.Component.abstractGroup, Output pController As %ZEN.Auxiliary.abstractController) as %Status

If this widget has a data source, create a data controller that will serve this data to the client.
The controller's id is "controller" (within the scope of this widget).

• classmethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) as %Status

Return information used to list this widget within the "widget catalog".

• method %GetDataController() as %ZEN.Auxiliary.abstractController

If this widget contains a data controller, return it.

• classmethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) as %Status

Return information on additional "properties" supported by this widget for the given subtype.

• method %OnAddToPageBefore() as %Status

If implemented, this callback method is called at page render-time when this component is added to a page but before any of its children have been created.

• method %OnCreateControls(pGroup As %ZEN.Component.group) as %Status

This callback is called just before controls are added to the top of the widget. pGroup is the header in which new Zen control can be added.

• method %OnCreateWidget(pGroup As %ZEN.Component.group) as %Status

This callback is responsible for creating the contents of the widget.

• method adjustContentSize(load, width, height) [ Language = javascript ]

Called when page is loaded or widget is resized.

• method applyFilter(name, value) [ Language = javascript ]

Apply the given filter to this widget.

• method getDataController() [ Language = javascript ]

If this widget contains a data controller, return it. This allows for generic capabilities in this base class.

• method navSelectItem(key, value, final) [ Language = javascript ]

Select of item in navigator.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search