com.ebasetech.xi.api.controls

Interface MenuLevelProperties

All Known Subinterfaces:

VerticalMenuLevelProperties

public interface MenuLevelProperties

The MenuLevelProperties interface represents styling properties applied to all menu items at a specific level of a menu.

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
MenuStateProperties	getAllState() Default styling properties for menu items in all states - selected, unselected, hover.
java.lang.String	getHAlign() Horizontal alignment of the content within each menu item.
MenuStateProperties	getHoverState() Styling properties applied to menu items when the mouse is hovered over a tab.
BorderStyleProperties	getItemBorder() Border properties for each menu item.
PaddingStyleProperties	getItemPadding() Padding properties for each menu item.
java.lang.String	getItemWidth() The width of all menu items.
MenuStateProperties	getNormalState() Styling properties applied to unselected menu items.
MenuStateProperties	getSelectedState() Styling properties applied to selected menu items.
void	setHAlign(java.lang.String hAlign) Sets the horizontal alignment of the content within each menu item.
void	setItemWidth(java.lang.String itemWidth) Sets the width of all menu items.

Method Detail

getItemWidth

java.lang.String getItemWidth()

The width of all menu items. See setItemWidth(String) for details of supported values when setting this property.

Since:

V4.4

setItemWidth

void setItemWidth(java.lang.String itemWidth)

Sets the width of all menu items.

Any valid value for the CSS width property can be specified e.g. 30px

Since:

V4.4

getHAlign

java.lang.String getHAlign()

Horizontal alignment of the content within each menu item. See setHAlign(String) for details of supported values when setting this property.

Since:

V4.4

setHAlign

void setHAlign(java.lang.String hAlign)

Sets the horizontal alignment of the content within each menu item.

Supported values:

Value	Constant
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT

Example:

 controls.HORIZONTALMENU1.globalLevel.setHAlign(ControlConstants.HORIZONTAL_ALIGNMENT_CENTER);
 

Since:

V4.4

getItemPadding

PaddingStyleProperties getItemPadding()

Padding properties for each menu item.

Since:

V4.4

getItemBorder

BorderStyleProperties getItemBorder()

Border properties for each menu item.

Since:

V4.4

getAllState

MenuStateProperties getAllState()

Default styling properties for menu items in all states - selected, unselected, hover. These properties can be overridden by setting properties to be applied when a menu item has an explicit state. The properties can also be overridden for individual menu items.

Since:

V4.4

See Also:

getNormalState(), getSelectedState(), getHoverState()

getNormalState

MenuStateProperties getNormalState()

Styling properties applied to unselected menu items. These properties override any properties set using the allState property. The properties can also be overridden for individual menu items.

Since:

V4.4

getSelectedState

MenuStateProperties getSelectedState()

Styling properties applied to selected menu items. These properties override any properties set using the allState property. The properties can also be overridden for individual menu items.

Since:

V4.4

getHoverState

MenuStateProperties getHoverState()

Styling properties applied to menu items when the mouse is hovered over a tab. These properties override any properties set using the allState property. The properties can also be overridden for individual menu items.

Since:

V4.4