This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %ZEN.Component.menu

%ZEN.Component.menu

class %ZEN.Component.menu extends %ZEN.Component.group, %ZEN.Component.menuCell

Specialized group for defining menus.

Property Inventory

Method Inventory

Parameters

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

Properties

property layout as %ZEN.Datatype.string (MAXLEN = 250, ZENENCRYPT = 0) [ 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 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 methods: onactivateDisplayToLogical(), onactivateGet(), onactivateIsValid(), onactivateLogicalToDisplay(), onactivateLogicalToOdbc(), onactivateNormalize(), onactivateSet()
property onshowHelp as %ZEN.Datatype.eventHandler;
onshowHelp event handler: This event is fired when the user moves the mouse over this menu item.
Property methods: onshowHelpDisplayToLogical(), onshowHelpGet(), onshowHelpIsValid(), onshowHelpLogicalToDisplay(), onshowHelpLogicalToOdbc(), onshowHelpNormalize(), onshowHelpSet()
Internal property used to keep track of state on client
Property methods: subMenuActiveDisplayToLogical(), subMenuActiveGet(), subMenuActiveIsValid(), subMenuActiveLogicalToDisplay(), subMenuActiveLogicalToOdbc(), subMenuActiveLogicalToXSD(), subMenuActiveNormalize(), subMenuActiveSet(), subMenuActiveXSDToLogical()
Internal property used to indicate if this is a submenu and, if so, how many level deep.
Property methods: subMenuLevelDisplayToLogical(), subMenuLevelGet(), subMenuLevelIsValid(), subMenuLevelLogicalToDisplay(), subMenuLevelLogicalToOdbc(), subMenuLevelNormalize(), subMenuLevelSet()

Methods

method %DrawHTML()
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.
clientmethod onActionHandler() [ Language = javascript ]
This callback is invoked just before this menu (acting as a menuItem) fires its action.
clientmethod onEndModalHandler(zindex) [ Language = javascript ]
Notification that this component is about to stop being modal.
clientmethod 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.
clientmethod onItemShowHelpHandler(mode, item) [ Language = javascript ]
clientmethod onShowHelpHandler(mode) [ Language = javascript ]
This callback is invoked when the mouse moves over (true) or out of (false) this menu item.
clientmethod onStartModalHandler(zindex) [ Language = javascript ]
Notification that this component is about to become modal.
clientmethod showSubMenu() [ Language = javascript ]
Display the submenu.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window