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

%ZEN.Component.csMenuItem


class %ZEN.Component.csMenuItem extends group

%ZEN.Component.csMenuItem

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 11 4


Summary


Properties
%condition %import %includeFiles %page
%resource align altCaption altIcon
altKey aux caption cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle contextKey disabled
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
icon iconDisabled id index
key label labelClass labelDisabledClass
labelPosition labelStyle layout name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent showLabel slice
title toggleMode toggleState 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 initializeClientSideProjection 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


Parameters


• parameter INCLUDEFILES = "zenCSLM.js,zenMenus.js";
CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Properties


• property altCaption as %ZEN.Datatype.string;
If defined, alternate label for a toggled menu pick
• property altIcon as %ZEN.Datatype.uri;
URI of alternate image to display under toggled conditions.
• property altKey as %ZEN.Datatype.string;
If defined, global keyboard shortcut to invoke alternate behavior
• property caption as %ZEN.Datatype.caption;
label normally associated with the menu pick
• property contextKey as %ZEN.Datatype.string;
If defined, keystroke of caption to invoke functionality when menu is active
• property icon as %ZEN.Datatype.uri;
URI of image to display under normal conditions.
• property iconDisabled as %ZEN.Datatype.uri;
URI of image to display when option is grayed-out.
• property key as %ZEN.Datatype.string;
If defined, global keyboard shortcut to simulate a mouse click
• property onclick as %ZEN.Datatype.eventHandler;
onclick event handler: This event is fired when the mouse is clicked on the csMenuItem or when the key or altKey shortcuts have been typed
• property toggleMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If defined, a flag to indicate that a checkmark (instead of an alternate caption) should be used to indicate a toggled state of the menu pick
• property toggleState as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If toggleMode is true or an alternate caption has been defined, this flag is used to indicate the current state of the menu pick. A value of zero indicates the base state (no check mark visible, primary caption in use). A value of 1 indicates that either a check mark is visible or the alternate caption is currently being displayed. This attribute may also be used to set the initial state of the menu pick.

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 initializeClientSideProjection() [ Language = javascript ]
Unpack the short form of the widget as dished up by the web server in to the full DOM subtree used in the browser
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.