Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %ZEN.Component.abstractGroup
Private  Storage   

%ZEN.Component.abstractGroup


abstract class %ZEN.Component.abstractGroup extends
component

Abstract container component. This is the base class from which various types of grouping elements are derived.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 3 22


Summary


Properties
%condition %import %includeFiles %page
%partial %resource align aux
children composite containerStyle disabled
dragEnabled dropEnabled dynamic enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle name onafterdrag onbeforedrag
ondrag ondrop onhide onrefresh
onshow onupdate overlayMode parent
renderFlag showLabel slice title
tuple valign visible width
window

Methods
%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddToSaveSet %Attr %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawClassDefinition
%DrawComponentHTML %DrawHTML %DrawJSGetSettings %DrawJSSerialize
%DrawJSStrings %DrawObjectProperties %DrawSVGDef %DrawStyleHTML
%DrawStyleSVG %EnclosingDivId %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetChildIndex
%GetClassCRC %GetClassDepth %GetEventHandlers %GetIncludeFiles
%GetIncludeInfo %GetParameter %GetSuperClassList %GetXMLName
%IncrementCount %IsA %IsModified %MakeId
%New %NormalizeObject %ObjectModified %ObjectSynch
%OnAddToPage %OnAddToPageAfter %OnAddToPageBefore %OnDrawEnclosingDiv
%OnDrawObjectProperties %OnMutateChildren %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%ReallyAddChild %RemoveChild %RemoveChildren %RemoveFromSaveSet
%Self %SerializeObject %SetModified %ValidateObject
%XMLGenerate %ZENDeserialize ReallyRefreshContents XMLAfterExport
XMLBeforeExport XMLDTD XMLExport XMLExportInternal
XMLExportToStream XMLExportToString XMLGetSchemaImports XMLImport
XMLImportInternal XMLIsObjectEmpty 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 progressBarHandler refreshContents
removeChild render renderContents renderSVG
setHidden setOverlayMode setProperty setPropertyAll
startProgressBar stopProgressBar updateControlsInGroup

Subclasses
%ZEN.Component.activeGroup %ZEN.Component.group %ZEN.ComponentEx.documentView

Parameters


• parameter DEFAULTGROUPCLASS = "group";
Subclasses can set this to change default css class for a group.
• parameter SYSMODULE = "core";
If set, this indicates that this system component should be placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files. Note that certain root classes are implicitly placed within the "core" module.
Classes outside of the Zen library should not set this, they should use the MODULE instead.

Properties


• property %partial as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
Internal property.
If true, this group was only partially serialized on the client (it is the ancestor of the object being serialized) and we should ignore changes made to the children array when shipping changes back to the client.
• property children as list of component(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE",ZENSETTING=0);
Set of components within this group.
• property disabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, this group and its children are disabled.

Methods


• final method %AddChild(pComponent As %ZEN.Component.object) as %Status
Add a child component pComponent to this group.
This is called when the server component tree is being created. This also adds pComponent to the page that this group belongs to; this group must be added to a page before adding any child components to it. In addition, the id property of the component must be set before calling this method.
• final method %AddChildAfter(pComponent As %ZEN.Component.object, pSibling As %ZEN.Component.object = "") as %Status
Add a child component pComponent to this group immediately after component pSibling.
If pSibling is not a member of this group, this method will fail.
This is called when the server component tree is being created. This also adds pComponent to the page that this group belongs to; this group must be added to a page before adding any child components to it. In addition, the id property of the component must be set before calling this method.
• final method %AddChildBefore(pComponent As %ZEN.Component.object, pSibling As %ZEN.Component.object = "") as %Status
Add a child component pComponent to this group immediately before component pSibling.
If pSibling is not a member of this group, this method will fail.
This is called when the server component tree is being created. This also adds pComponent to the page that this group belongs to; this group must be added to a page before adding any child components to it. In addition, the id property of the component must be set before calling this method.
• method %GetChildIndex(pChild As %ZEN.Component.component) as %Integer
Server-only method: Look for the given child object within this group's set of children and return its 1-based index number.
Returns -1 if unable to find the child.
• method %OnMutateChildren(pAdd As %Boolean) as %Boolean
Notification that children have been added or removed from this group.
• method %ReallyAddChild(pComponent As %ZEN.Component.object, pSibling As %ZEN.Component.object = "", pBefore As %Boolean = 0) as %Status
This is an internal method that does the actual work of adding a child component to a group.
Applications should not call this, instead use %AddChild, %AddChildAfter, and %AddChildBefore.
• method %RemoveChild(pComponent As %ZEN.Component.object) as %Boolean
Remove child component pComponent from this group. Returns true if the component was found and removed.
• method %RemoveChildren(pDynamicOnly As %Boolean = 0)
Remove all children from this group. If pDynamicOnly is true, then only delete components whose dynamic is set to true.
• method addChild(component, refresh) [ Language = javascript ]
Client-side method.
Dynamically add a component to this group on the client.
If refresh is true, then refresh the contents of this group to show the new component.
• method addChildAfter(component, sibling, refresh) [ Language = javascript ]
Client-side method.
Dynamically add a component to this group on the client after component sibling.
If refresh is true, then refresh the contents of this group to show the new component.
• method addChildBefore(component, sibling, refresh) [ Language = javascript ]
Client-side method.
Dynamically add a component to this group on the client before component sibling.
If refresh is true, then refresh the contents of this group to show the new component.
• abstract method childrenMutated() [ Language = javascript ]
Notification to subclasses that a child has been added or removed from this group.
• method exposeComponent() [ Language = javascript ]
This manages the ondisplay event callback handling. The display event fires when the page is first displayed, when the component or its containing group is refreshed from the server, or when the component or its containing group is displayed via a programmatic 'show()' call. Note that setting the style.display value from JavaScript DOES NOT trigger this event. In general, application code should not modify or overload this method; instead, use the onDisplayHandler() to customize this processing.
• method getChildIndex(child) [ Language = javascript ]
Look for the given child object within this group's set of children and return its 0-based index number.
Returns -1 if unable to find the child.
• method onRefreshContents() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• abstract method ondisabledHandler() [ Language = javascript ]
Client-side method that is called when a group's disabled state changes. This gives subclasses a chance to update their style when they are enabled/disabled.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method removeChild(component) [ Language = javascript ]
Client-side method.
Dynamically remove a component from this group on the client.
• method setOverlayMode(mode) [ Language = javascript ]
Set overlay mode for each child of this group.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
Assume that subclasses that simply wrap HTML controls have named the control 'control' or else have overridden this method.
• method setPropertyAll(property, value, value2) [ Language = javascript ]
Apply the given value to the specified property for this group and all of its children.
Note that this will not work for 'disabled'; for that use setProperty.
• method updateControlsInGroup() [ Language = javascript ]
Apply the current control values to all controls within a modalGroup.