Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%ZEN] >  [Component] >  [group]
Private  Storage   

class %ZEN.Component.group extends abstractGroup

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 9 4


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 parent showLabel slice
title tuple valign visible
width window

Methods
%AddChild %AddChildAfter %AddChildBefore %AddToSaveSet
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawComponentHTML %DrawHTML %DrawJSStrings %EnclosingDivId
%Eval %EvalC %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

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

Parameters

• parameter DEFAULTCELLALIGN;
Subclasses can set this to change default cellAlign for a group.
• parameter DEFAULTCELLSIZE;
Subclasses can set this to change default cellSize for a group.
• parameter DEFAULTCELLSTYLE;
Subclasses can set this to change default cellStyle for a group.
• parameter DEFAULTCELLVALIGN;
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.
• parameter DEFAULTGROUPSTYLE;
Subclasses can set this to change default groupStyle for a group.
• parameter DEFAULTLABELPOSITION = "top";
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.

Properties

• 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 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 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 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 groupClass as %ZEN.Datatype.cssClass [ InitialExpression = ..#DEFAULTGROUPCLASS ];
Optional CSS class used for table displayed by this group.
• property groupStyle as %ZEN.Datatype.style [ InitialExpression = ..#DEFAULTGROUPSTYLE ];
Optional style used for table displayed by this group.
• 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 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 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) {
}

Methods

• method %DrawHTML()
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
Override this method to inject additional event handlers into the enclosing div.
• 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.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.