Class %ZEN.Component.pane

class %ZEN.Component.pane extends group

The pane component is a specialized type of group that is useful for defining a common layout (or template) in a base class and providing content within a subclass. The pane component is used in two different ways:

Within a template super class, pane components are used as placeholders in which a subclass will inject components. Each pane is given a unique name using its paneName property.
Each subclass of the template class defines XData blocks whose names correspond to the name of the pane components. Each of these XData blocks contains a set of components within an enclosing pane element. When the subclass page is displayed, the contents of each pane will be supplied via the various pane XData definitions.

Note that the default layout of a pane is "vertical".

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	1	1

Summary

Properties
%condition	%import	%includeFiles	%page
%resource	align	aux	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	containerStyle	disabled	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	id
index	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	paneName	parent	showLabel
slice	title	tuple	valign
visible	width	window

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddToSaveSet	%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawComponentHTML	%DrawHTML	%DrawJSStrings
%EnclosingDivId	%Eval	%Extends	%ForceClientRender
%GetChildIndex	%GetEventHandlers	%GetParameter	%GetXMLName
%IsA	%IsModified	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnDrawEnclosingDiv	%OnDrawObjectProperties	%OnMutateChildren	%OnObjectSynch
%OnZENDeserialize	%OriginalNamespace	%PackageName	%QuoteValue
%QuoteValueL10N	%RemoveChild	%RemoveChildren	%RemoveFromSaveSet
%Self	%SerializeObject	%SetModified	%ValidateObject
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	childrenMutated
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	exposeComponent	findElement
fireOnUpdateEvent	getChildIndex	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getProperty	getSettings
getType	invokeSuper	isOfType	makeId
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onStartModalHandler
ondisabledHandler	onloadHandler	onunloadHandler	onupdateHandler
refreshContents	removeChild	render	renderContents
renderSVG	setHidden	setOverlayMode	setProperty
setPropertyAll	startProgressBar	stopProgressBar

Parameters

• parameter DEFAULTLAYOUT = "vertical";

Subclasses can set this to change default layout for a group.

Properties

• property paneName as %ZEN.Datatype.string;

Name of the pane definition that will provide the contents of this pane. This is the name of an XData block containing the contents definition for the pane.

Methods

• method %OnAddToPageBefore() as %Status

This callback is invoked when this pane element is added to the set of page components.
It asks the page to provide the contents of a pane.


[BASEXML] > [%ZEN] > [Component] > [pane]		Private Storage