DocBook|Search
Class Reference
%ZEN.Component.menu
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%ZEN] >  [Component] >  [menu]
Private  Storage  

class %ZEN.Component.menu extends group, menuCell

Specialized group for defining menus.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 8


Summary

Properties
%condition %import %includeFiles %page
%resource align aux caption
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle disabled
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
help hidden hint hintClass
hintStyle id image imageHeight
imageWidth index label labelClass
labelDisabledClass labelPosition labelStyle layout
link linkResource name onactivate
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onshowHelp onupdate parent showLabel
slice subMenuActive subMenuLevel target
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
%DrawMenuCell %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 onActionHandler onCreate onDelete
onDisplayHandler onEndModalHandler onItemActionHandler onItemShowHelpHandler
onPopupAction onRefreshContents onSerialize onShowHelpHandler
onStartModalHandler ondisabledHandler onloadHandler onunloadHandler
onupdateHandler refreshContents removeChild render
renderContents renderSVG setHidden setOverlayMode
setProperty setPropertyAll showSubMenu startProgressBar
stopProgressBar

Subclasses
%ZEN.Component.hmenu %ZEN.Component.vmenu

Parameters

• parameter DEFAULTGROUPCLASS = "menuTable";
Subclasses can set this to change default css class for a group.
• parameter DEFAULTLAYOUT = "horizontal";
Subclasses can set this to change default layout for a group.

Properties

• property onactivate as %ZEN.Datatype.eventHandler;
onactivate event handler: If this menu is a submenu, then this event is fired just before the submenu is made visible.
• property onshowHelp as %ZEN.Datatype.eventHandler;
onshowHelp event handler: This event is fired when the user moves the mouse over this menu item.
• property subMenuActive as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Internal property used to keep track of state on client
• property subMenuLevel as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
Internal property used to indicate if this is a submenu and, if so, how many level deep.

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 onActionHandler() [ Language = javascript ]
This callback is invoked just before this menu (acting as a menuItem) fires its action.
• method onEndModalHandler(zindex) [ Language = javascript ]
Notification that this component is about to stop being modal.
• method onItemActionHandler(depth) [ Language = javascript ]
This callback is invoked just after a menuItem within this menu fires its action. depth indicated how many submenu levels down this event originated. If 1, then it came from *this* menu.
• method onItemShowHelpHandler(mode, item) [ Language = javascript ]
• method onShowHelpHandler(mode) [ Language = javascript ]
This callback is invoked when the mouse moves over (true) or out of (false) this menu item.
• method onStartModalHandler(zindex) [ Language = javascript ]
Notification that this component is about to become modal.
• method showSubMenu() [ Language = javascript ]
Display the submenu.