com.ebasetech.xi.api.controls
Interface StaticMenuItemControl

All Superinterfaces:

Control, Element, EventOwner, MenuItemControl, MessageContainer, MessageProperties, java.io.Serializable, WebFormEventOwner

public interface StaticMenuItemControl
extends MenuItemControl

A Static Menu Item Control represents a static menu item in either a Vertical Menu or a Horizontal Menu.

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

Since:

V4.4

Method Summary

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

Methods inherited from interface com.ebasetech.xi.api.controls.MenuItemControl

getItemName, getName

Methods inherited from interface com.ebasetech.xi.api.controls.Control

getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.MessageContainer

addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, existErrorMessages, existMessages, existWarningMessages

Methods inherited from interface com.ebasetech.xi.api.controls.MessageProperties

getErrorMessageStyle, getWarningMessageStyle

Method Detail

getText

Text getText()

Returns the Text object for the menu item text.

Since:

V4.4

getImageURL

java.lang.String getImageURL()

Returns the URL of the optional image to be displayed on the menu item. The URL can be either relative or absolute.

Further documentation.

Since:

V4.4

setImageURL

void setImageURL(java.lang.String imageURL)

Sets the URL of the optional image to be displayed on the menu item. The URL can be either relative or absolute. When absolute, is should start with the protocol e.g. http://www.google.com.

Further documentation.

Since:

V4.4

getImageMouseOverText

Text getImageMouseOverText()

Returns the Text object for the menu item image mouse over text.

Since:

V4.4

getImageAltText

Text getImageAltText()

Returns the Text object for the menu item image alternate text.

Since:

V4.4

getImageStyle

java.lang.String getImageStyle()

Returns the inline CSS style applied to the menu item image.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Further documentation.

Since:

V4.4

See Also:

setImageStyle(String)

setImageStyle

void setImageStyle(java.lang.String imageStyle)

Sets the inline CSS style to be applied to the menu item image. Style is entered as for the HTML style parameter.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Further documentation.

Since:

V4.4

getImageClass

java.lang.String getImageClass()

Returns the list of CSS classes applied to the menu item image.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Further documentation.

Since:

V4.4

See Also:

setImageClass(String)

setImageClass

void setImageClass(java.lang.String imageClass)

Sets one or more CSS classes to be applied to the menu item image. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Further documentation.

Since:

V4.4

isEnabled

boolean isEnabled()

When enabled, the menu item can be clicked; when disabled the menu item is still displayed but cannot be clicked.

Further documentation.

Since:

V4.4

setEnabled

void setEnabled(boolean enabled)

Sets whether or not the menu item can be clicked by the user.

Further documentation.

Since:

V4.4

getTextImageGap

java.lang.String getTextImageGap()

The gap between the menu item text and any configured image.

Further documentation.

Since:

V4.4

See Also:

setTextImageGap(String)

setTextImageGap

void setTextImageGap(java.lang.String textImageGap)

Sets the gap between the menu item text and any configured image. Any valid value for the CSS font-size property can be used.

Further documentation.

Examples:

 controls.STATICMENUITEM1.textImageGap = "30px";
 

Since:

V4.4

getImagePosition

java.lang.String getImagePosition()

The position of the optional image relative to the menu item text. See setImagePosition(String) for details of supported values when setting this property.

Further documentation.

Since:

V4.4

setImagePosition

void setImagePosition(java.lang.String imagePosition)

Sets the position of the optional image relative to the menu item text.

Supported values:

Value	Description
Left	Image is positioned to the left of the text
Right	Image is positioned to the right of the text
None	No image will be displayed

Further documentation.

Examples:

 controls.STATICMENUITEM1.imagePosition = "Left";
 

Since:

V4.4

getAllState

MenuStateProperties getAllState()

Styling properties that apply to all states - selected, unselected, hover. These properties can be overridden by setting properties to be applied when a menu item has an explicit state. These properties override any corresponding properties configured for the parent menu control.

Since:

V4.4

See Also:

getUnselectedState(), getSelectedState(), getHoverState()

getUnselectedState

MenuStateProperties getUnselectedState()

Styling properties applied to the menu item when it is unselected. These properties override any properties set using the allState property, and also override any corresponding properties configured for the parent menu control.

Since:

V4.4

getSelectedState

MenuStateProperties getSelectedState()

Styling properties applied to the menu item when it is selected. These properties override any properties set using the allState property, and also override any corresponding properties configured for the parent menu control.

Since:

V4.4

getHoverState

MenuStateProperties getHoverState()

Styling properties applied to the menu item when the mouse is hovered over the menu item. These properties override any properties set using the allState property, and also override any corresponding properties configured for the parent menu control.

Since:

V4.4

getImageProperties

ImageStyleProperties getImageProperties()

Styling properties applied to optional menu item image.

Further documentation.

Since:

V4.4