This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %ZEN.Component.accordionMenu extends %ZEN.Component.component, %ZEN.Component.dataView

Implements a simple HTML5 accordion menu component.
This is an HTML5 component; it will only correctly run on HTML5 compliant browsers.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DEFAULTENCLOSINGCLASS = zam-menu;
Inherited description: Subclasses can set this to change default enclosingClass used for this component.
parameter SYSMODULE;
Do not include in "form" module.


property ongetdata as %ZEN.Datatype.eventHandler;
ongetdata event handler: If defined, this event is returns an array of items to be displayed within the menu.
Property methods: ongetdataDisplayToLogical(), ongetdataGet(), ongetdataIsValid(), ongetdataLogicalToDisplay(), ongetdataLogicalToOdbc(), ongetdataNormalize(), ongetdataSet()
property onselect as %ZEN.Datatype.eventHandler;
onselect event handler: If defined, this event is fired when the user clicks on a item within the menu.
Property methods: onselectDisplayToLogical(), onselectGet(), onselectIsValid(), onselectLogicalToDisplay(), onselectLogicalToOdbc(), onselectNormalize(), onselectSet()
property selectedIndex as %ZEN.Datatype.string;
Current selected item.
This is a string of the form 'index1,index2,...', where each index is the 0-based ordinal position of a menu, its first level child, etc.
Property methods: selectedIndexDisplayToLogical(), selectedIndexGet(), selectedIndexIsValid(), selectedIndexLogicalToDisplay(), selectedIndexLogicalToOdbc(), selectedIndexNormalize(), selectedIndexSet()
property style as;
Additional style to apply to items in the menu.
Property methods: styleDisplayToLogical(), styleGet(), styleIsValid(), styleLogicalToDisplay(), styleLogicalToOdbc(), styleNormalize(), styleSet()


clientmethod adjustParentMenuSize(menuId, level, id) [ Language = javascript ]
Adjust the size of a menu item's parents.
clientmethod getMenuHTML(content, menuId) [ Language = javascript ]
Get HTML for a dynamic menu based on the given content object graph. Each node in the graph may define key, caption,action, targetId, image, and children.
clientmethod getModel() [ Language = javascript ]
Get the model used to drive the menu.
Action handler for menu item.
User click on a menu item.
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this grid has raised an event.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render this component.
clientmethod selectItem(index) [ Language = javascript ]
Select a given menu item and expand it (if it has children). index is the index number of the menu item (0-based).

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)