Home > Class Reference > %SYS namespace > %ZEN.Component.group


class %ZEN.Component.group extends %ZEN.Component.abstractGroup

Container component. A group is used to contain and layout a set of child components.


Subclasses can set this to change default cellAlign for a group.
Subclasses can set this to change default cellSize for a group.
Subclasses can set this to change default cellStyle for a group.
Subclasses can set this to change default cellVAlign for a group.
parameter DEFAULTGROUPCLASS = group;
Subclasses can set this to change default css class for a group.
Subclasses can set this to change default groupStyle for a group.
Subclasses can set this to change default labelPosition for a group.
parameter DEFAULTLAYOUT = vertical;
Subclasses can set this to change default layout for a group.


property cellAlign as %ZEN.Datatype.string (MAXLEN = 10, VALUELIST = ",left,right,center,even") [ InitialExpression = ..#DEFAULTCELLALIGN ];
Specifies horizontal alignment of cells layed out within this group.
Property methods: cellAlignDisplayToLogical(), cellAlignGet(), cellAlignIsValid(), cellAlignLogicalToDisplay(), cellAlignLogicalToOdbc(), cellAlignNormalize(), cellAlignSet()
property cellSize as %ZEN.Datatype.string (MAXLEN = 10, VALUELIST = ",same,stretch") [ InitialExpression = ..#DEFAULTCELLSIZE ];
Specifies how the size of cells within this group should be calculated (along layout direction).
Property methods: cellSizeDisplayToLogical(), cellSizeGet(), cellSizeIsValid(), cellSizeLogicalToDisplay(), cellSizeLogicalToOdbc(), cellSizeNormalize(), cellSizeSet()
property cellStyle as %ZEN.Datatype.style [ InitialExpression = ..#DEFAULTCELLSTYLE ];
Specifies additional style for cells layed out within this group. This is primarily intended for cell padding.
Property methods: cellStyleDisplayToLogical(), cellStyleGet(), cellStyleIsValid(), cellStyleLogicalToDisplay(), cellStyleLogicalToOdbc(), cellStyleNormalize(), cellStyleSet()
property cellVAlign as %ZEN.Datatype.string (MAXLEN = 10, VALUELIST = ",top,bottom,middle,even") [ InitialExpression = ..#DEFAULTCELLVALIGN ];
Specifies vertical alignment of cells layed out within this group.
Property methods: cellVAlignDisplayToLogical(), cellVAlignGet(), cellVAlignIsValid(), cellVAlignLogicalToDisplay(), cellVAlignLogicalToOdbc(), cellVAlignNormalize(), cellVAlignSet()
property groupClass as %ZEN.Datatype.cssClass [ InitialExpression = ..#DEFAULTGROUPCLASS ];
Optional CSS class used for table displayed by this group.
Property methods: groupClassDisplayToLogical(), groupClassGet(), groupClassIsValid(), groupClassLogicalToDisplay(), groupClassLogicalToOdbc(), groupClassNormalize(), groupClassSet()
property groupStyle as %ZEN.Datatype.style [ InitialExpression = ..#DEFAULTGROUPSTYLE ];
Optional style used for table displayed by this group.
Property methods: groupStyleDisplayToLogical(), groupStyleGet(), groupStyleIsValid(), groupStyleLogicalToDisplay(), groupStyleLogicalToOdbc(), groupStyleNormalize(), groupStyleSet()
property labelPosition as %ZEN.Datatype.string (MAXLEN = 10, VALUELIST = ",left,top") [ InitialExpression = ..#DEFAULTLABELPOSITION ];
Specifies where labels should be displayed for components within this group. "top" places the labels above the components. "left" places the labels to the left of the components.
Property methods: labelPositionDisplayToLogical(), labelPositionGet(), labelPositionIsValid(), labelPositionLogicalToDisplay(), labelPositionLogicalToOdbc(), labelPositionNormalize(), labelPositionSet()
property layout as %ZEN.Datatype.string (MAXLEN = 250, ZENENCRYPT = 1) [ InitialExpression = ..#DEFAULTLAYOUT ];
Specifies how components within this group should be layed out. (VALUELIST = ",vertical,horizontal")
Property methods: layoutDisplayToLogical(), layoutGet(), layoutIsValid(), layoutLogicalToDisplay(), layoutLogicalToOdbc(), layoutNormalize(), layoutSet()
property onclick as %ZEN.Datatype.eventHandler;
onclick event handler: This event is fired when the mouse is clicked on the group.
Note, if you need to specify an onclick event for a group, you have to be very familiar with event handling in HTML/JavaScript. Your event handling code will have to take into consideration that this event is fired whenever the mouse is clicked within the enclosing div element for this group. For example, clicking on a button within the group will fire the onclick handlers for both the button and the group.
You can detect if the click was directly on the group by examining the event object (passed via the zenEvent variable). For example:
// look at source element; IE does not support standard target property.
var target = (null == zenEvent.target) ? zenEvent.srcElement : zenEvent.target;
// all enclosing divs will define an attribute called 'zen'.
var zen = target.getAttribute('zen');
if (zen) {
Property methods: onclickDisplayToLogical(), onclickGet(), onclickIsValid(), onclickLogicalToDisplay(), onclickLogicalToOdbc(), onclickNormalize(), onclickSet()


method %DrawHTML() [ Language = objectscript ]
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
method %OnDrawEnclosingDiv() as %String [ Language = objectscript ]
Override this method to inject additional event handlers into the enclosing div.
clientmethod 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.

Inherited Methods

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


%DeepSee.Report.UI.popGroup %ZEN.Component.cssGroup %ZEN.Component.navigator
%ZEN.Component.abstractPage %ZEN.Component.dragGroup %ZEN.Component.pane
%ZEN.Component.buttonBar %ZEN.Component.expando %ZEN.Component.repeatingGroup
%ZEN.Component.composite %ZEN.Component.fieldSet %ZEN.Component.tab
%ZEN.Component.contextMenu %ZEN.Component.form %ZEN.Component.tabFrame
%ZEN.Component.csComboBox %ZEN.Component.hgroup %ZEN.Component.tabGroup
%ZEN.Component.csMenuBar %ZEN.Component.loginForm %ZEN.Component.vgroup
%ZEN.Component.csMenuBarItem %ZEN.Component.menu
%ZEN.Component.csMenuItem %ZEN.Component.modalGroup