StaticMenuItemControl

A Static Menu Item Control represents a static menu item in either a VerticalMenuControl or a HorizontalMenuControl.

Each menu item can contain a text and/or a single image; if an image is displayed as part of the item, its location can be to the right or left of the text.

An override on click event can be set for each individual menu item; if this property is not set, the on click event for the parent Menu Control is executed.

Each menu item can either be enabled or disabled. When disabled, the menu item is still displayed but cannot be clicked by the user.

Further documentation

StaticMenuItemControl Functions

getAllState	StaticMenuItemControl.getAllState( )	Styling properties that apply to all states - selected, unselected, hover.
isEnabled	StaticMenuItemControl.isEnabled( )	When enabled, the menu item can be clicked; when disabled the menu item is still displayed but cannot be clicked.
setEnabled	StaticMenuItemControl.setEnabled( enabled )	Sets whether or not the menu item can be clicked by the user.
getHoverState	StaticMenuItemControl.getHoverState( )	Styling properties applied to the menu item when the mouse is hovered over the menu item.
getImageAltText	StaticMenuItemControl.getImageAltText( )	Returns the com.ebasetech.xi.api.Text object for the menu item image alternate text.
getImageClass	StaticMenuItemControl.getImageClass( )	Returns the list of CSS classes applied to the menu item image.
setImageClass	StaticMenuItemControl.setImageClass( imageClass )	Sets one or more CSS classes to be applied to the menu item image.
getImageMouseOverText	StaticMenuItemControl.getImageMouseOverText( )	Returns the com.ebasetech.xi.api.Text object for the menu item image mouse over text.
getImagePosition	StaticMenuItemControl.getImagePosition( )	The position of the optional image relative to the menu item text.
setImagePosition	StaticMenuItemControl.setImagePosition( imagePosition )	Sets the position of the optional image relative to the menu item text.
getImageProperties	StaticMenuItemControl.getImageProperties( )	Styling properties applied to optional menu item image.
getImageStyle	StaticMenuItemControl.getImageStyle( )	Returns the inline CSS style applied to the menu item image.
setImageStyle	StaticMenuItemControl.setImageStyle( imageStyle )	Sets the inline CSS style to be applied to the menu item image.
getImageURL	StaticMenuItemControl.getImageURL( )	Returns the URL of the optional image to be displayed on the menu item.
setImageURL	StaticMenuItemControl.setImageURL( imageURL )	Sets the URL of the optional image to be displayed on the menu item.
getSelectedState	StaticMenuItemControl.getSelectedState( )	Styling properties applied to the menu item when it is selected.
getText	StaticMenuItemControl.getText( )	Returns the com.ebasetech.xi.api.Text object for the menu item text.
getTextImageGap	StaticMenuItemControl.getTextImageGap( )	The gap between the menu item text and any configured image.
setTextImageGap	StaticMenuItemControl.setTextImageGap( textImageGap )	Sets the gap between the menu item text and any configured image.
getUnselectedState	StaticMenuItemControl.getUnselectedState( )	Styling properties applied to the menu item when it is unselected.

MenuItemControl Functions

getItemName	StaticMenuItemControl.getItemName( )	The name that uniquely identifies each menu item within a menu.
getName	StaticMenuItemControl.getName( )

Control Functions

addCssClass	StaticMenuItemControl.addCssClass( cssClass )	Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll	StaticMenuItemControl.getAll( )	Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.
isContainer	StaticMenuItemControl.isContainer( )	Returns true if this control is a container control i.e.
getCssClass	StaticMenuItemControl.getCssClass( )	Returns the list of CSS classes configured for the control.
setCssClass	StaticMenuItemControl.setCssClass( cssClass )	Sets one or more CSS classes to be applied to the control.
isDisplayOnly	StaticMenuItemControl.isDisplayOnly( )	Returns `true` if the control is marked as display only, otherwise returns `false`.
setDisplayOnly	StaticMenuItemControl.setDisplayOnly( displayOnly )	Marks the control and all its children as display only (when `displayOnly` is `true`) or enterable (when `displayOnly` is `false`).
isDisplayOnlyIncludingParents	StaticMenuItemControl.isDisplayOnlyIncludingParents( )	Returns `true` if the control or any of its parents is marked as display only, otherwise returns `false`.
getErrorMsgClass	StaticMenuItemControl.getErrorMsgClass( )	Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass	StaticMenuItemControl.setErrorMsgClass( errorMsgClass )	Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle	StaticMenuItemControl.getErrorMsgStyle( )	Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle	StaticMenuItemControl.setErrorMsgStyle( errorMsgStyle )	Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField	StaticMenuItemControl.isEventField( )	Returns `true` if the control is an event field i.e.
hasModifier	StaticMenuItemControl.hasModifier( modifier )	Returns true if the control has the specified modifier, otherwise returns false.
isHidden	StaticMenuItemControl.isHidden( )	Returns `true` if the control is marked as hidden, otherwise returns `false`.
setHidden	StaticMenuItemControl.setHidden( hidden )	Hides or shows the control and all its children.
hide	StaticMenuItemControl.hide( )	Hides the control, this is equivalent to setting property `hidden` to `true`.
getInfoMsgClass	StaticMenuItemControl.getInfoMsgClass( )	Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass	StaticMenuItemControl.setInfoMsgClass( infoMsgClass )	Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle	StaticMenuItemControl.getInfoMsgStyle( )	Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle	StaticMenuItemControl.setInfoMsgStyle( infoMsgStyle )	Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg	StaticMenuItemControl.isInheritMsg( )	Returns `true` if Use parent control setting is checked in the Message Options properties for the control, otherwise returns `false`.
getLayoutCell	StaticMenuItemControl.getLayoutCell( )	Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg	StaticMenuItemControl.isLocalMsg( )	Returns `true` if Local Message is checked in the Message Options properties for the control, otherwise returns `false`.
isNewLine	StaticMenuItemControl.isNewLine( )	Returns the new line property.
setNewLine	StaticMenuItemControl.setNewLine( newLine )	Sets or unsets the control's new line property.
getNextSiblingControl	StaticMenuItemControl.getNextSiblingControl( )	Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage	StaticMenuItemControl.getPage( )	Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl	StaticMenuItemControl.getParentControl( )	Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl	StaticMenuItemControl.getPreviousSiblingControl( )	Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh	StaticMenuItemControl.refresh( )	Refreshes this control in the user's browser when the page is next displayed.
removeCssClass	StaticMenuItemControl.removeCssClass( cssClass )	Removes one or more CSS classes from the control.
requestFocus	StaticMenuItemControl.requestFocus( )	Sets the browser focus to the control.
getRootHtmlElementProperties	StaticMenuItemControl.getRootHtmlElementProperties( )	Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show	StaticMenuItemControl.show( )	Shows the control, this is equivalent to setting property `hidden` to `false`.
isShowing	StaticMenuItemControl.isShowing( )	Returns `true` if the control will be included in the web page when it's next displayed to the user, otherwise returns `false`.
getStyle	StaticMenuItemControl.getStyle( )	Returns the inline CSS style configured for the control.
setStyle	StaticMenuItemControl.setStyle( style )	Sets inline CSS style to be applied to the control.
getWarningMsgClass	StaticMenuItemControl.getWarningMsgClass( )	Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass	StaticMenuItemControl.setWarningMsgClass( warningMsgClass )	Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle	StaticMenuItemControl.getWarningMsgStyle( )	Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle	StaticMenuItemControl.setWarningMsgStyle( warningMsgStyle )	Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MessageProperties Functions

getErrorMessageStyle	StaticMenuItemControl.getErrorMessageStyle( )	Returns the MessageStyleProperties object representing error message styling properties.
getInfoMessageStyle	StaticMenuItemControl.getInfoMessageStyle( )	Returns the MessageStyleProperties object representing info message styling properties.
getWarningMessageStyle	StaticMenuItemControl.getWarningMessageStyle( )	Returns the MessageStyleProperties object representing warning message styling properties.

MessageContainer Functions

addErrorMessage	StaticMenuItemControl.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	StaticMenuItemControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	StaticMenuItemControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	StaticMenuItemControl.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	StaticMenuItemControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	StaticMenuItemControl.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	StaticMenuItemControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	StaticMenuItemControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	StaticMenuItemControl.existErrorMessages( )	Returns `true` if undisplayed error messages exist for this element, otherwise returns `false`.
existInfoMessages	StaticMenuItemControl.existInfoMessages( )	Returns `true` if undisplayed info messages exist for this element, otherwise returns `false`.
existMessages	StaticMenuItemControl.existMessages( )	Returns `true` if undisplayed info, warning or error messages exist for this element, otherwise returns `false`.
existWarningMessages	StaticMenuItemControl.existWarningMessages( )	Returns `true` if undisplayed warning messages exist for this element, otherwise returns `false`.

Element Functions

getElementName	StaticMenuItemControl.getElementName( )	Returns the element name
getElementType	StaticMenuItemControl.getElementType( )	Returns the element type