Home > Class Reference > ENSLIB namespace > %ZEN.Component.tabGroup
Private  Storage   

%ZEN.Component.tabGroup


class %ZEN.Component.tabGroup extends group

A specialized group used to enclose a set of overlayed tabs. One tab is visible at a time. This group does not support standard layout as it simply overlays each of its children.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 21


Summary


Properties
%condition %import %includeFiles %page
%resource align aux cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle currTab 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 onhideTab
onrefresh onshow onshowTab onupdate
parent remember showBody showLabel
showTabBar 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 %GetTab
%GetXMLName %IsA %IsModified %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnDrawEnclosingDiv %OnDrawObjectProperties %OnMutateChildren
%OnObjectSynch %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveFromSaveSet %Self %SerializeObject %SetCurrTab
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore childrenMutated dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getChildIndex
getCurrTabNo getEnclosingDiv getHidden getHintElement
getLabelElement getProperty getSettings getTabBarElement
getTabBodyElement getTabCount getTabIndex getType
ieResizeBody invokeSuper isOfType makeId
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onStartModalHandler
ondisabledHandler onhideTabHandler onloadHandler onshowTabHandler
onunloadHandler onupdateHandler refreshContents removeChild
render renderContents renderSVG setBodySize
setHidden setOverlayMode setProperty setPropertyAll
showNextTab showPreviousTab showTab startProgressBar
stopProgressBar tabDisabledHandler

Subclasses
%ZEN.Component.lookoutMenu

Properties


• property currTab as %ZEN.Datatype.integer(ZENEXPRESSION=1) [ InitialExpression = 1 ];
Number (1-based) of current tab displayed within tabGroup.
• property onhideTab as %ZEN.Datatype.eventHandler;
onhideTab event handler: This event is fired when a new tab is hidden.
• property onshowTab as %ZEN.Datatype.eventHandler;
onshowTab event handler: This event is fired when a new tab is made visible.
• property remember as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, remember most recent tab in a session cookie.
• property showBody as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true (the default), render the div containing the tab's bodys. If false, the content will still be rendered, but not contained in a div.
• property showTabBar as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display a set of tab buttons along the top of this group. The default is false.

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 %GetTab(pIndex As %Integer)
Server-only method: Find the specified tab by index number (1-based).
• method %OnMutateChildren(pAdd As %Boolean) as %Boolean
Notification that children have been added or removed from this group.
• method %SetCurrTab(pTab As %ZEN.Component.tab)
Server-side method to set current tab of this tabGroup to pTab.
• method childrenMutated() [ Language = javascript ]
Notification to subclasses that a child has been added or removed from this group.
• method getCurrTabNo() [ Language = javascript ]
Return index (1-based) of current tab within the tabGroup.
• method getTabBarElement() [ Language = javascript ]
Return the HTML TABLE element for the tab bar.
• method getTabBodyElement() [ Language = javascript ]
Return the HTML DIV element for the tab body.
• method getTabCount() [ Language = javascript ]
Return number of tabs within the tabGroup.
• method getTabIndex(tab) [ Language = javascript ]
Look for the given tab object within this tabGroup's set of tabs and return its 1-based index number.
Returns -1 if unable to find the tab.
• method ieResizeBody() [ Language = javascript ]
IE does not properly support the min-height CSS property. This routine forces a correction to the size of the tabBody should it be rendered too small.
• method onRefreshContents() [ Language = javascript ]
Called after refreshContents.
• abstract method onhideTabHandler(tabno) [ Language = javascript ]
Class-specific notification that a tab has been hidden. Implemented by subclasses.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• abstract method onshowTabHandler(tabno) [ Language = javascript ]
Class-specific notification that a new tab has been selected. Implemented by subclasses.
• method setBodySize(height, width) [ Language = javascript ]
Set the size of the tab body and all tabs. width and height are in pixels.
You must override the CSS min-height for the tabBody for this to be effective.
• 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 showNextTab(skipDisabled) [ Language = javascript ]
Display the next tab in the tabGroup.
• method showPreviousTab(skipDisabled) [ Language = javascript ]
Display the previous tab in the tabGroup.
• method showTab(tabno) [ Language = javascript ]
Display the specified tab (given its 1-based tab number) and hide the current tab.
• method tabDisabledHandler(tab) [ Language = javascript ]
Called by tabs of this group to notify that they have changed their disabled state.