com.ebasetech.xi.api.controls

Interface VerticalMenuControl

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, ContainerControl, Control, Element, EventOwner, MarginStyleProperties, MenuControl, MessageContainer, MessageProperties, PaddingStyleProperties, java.io.Serializable, WebFormEventOwner

public interface VerticalMenuControl
extends MenuControl

A Vertical Menu Control represents a menu where the top level is shown vertically; subsequent levels can also be shown vertically with the menu expanding to accommodate them, or they can be shown as dynamic drop out menus in the same way as for a Horizontal Menu Control.

A Vertical Menu Control could be used as a traditional menu where the user clicks an item to request an action or open a sub-menu, or alternatively it could be used as a navigator to show location in a website or progress through a form: when used as a navigator, each menu item can be clickable or not as required.

Further documentation

Since:

V4.4

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackgroundClass() Returns the list of CSS classes applied to the background of the drop out menu levels.
java.lang.String	getBackgroundStyle() Returns the inline CSS style applied to the background of the drop out menu levels.
VerticalMenuLevelProperties	getFirstLevel() First level menu properties - containing properties for just the first level menu items.
VerticalMenuLevelProperties	getFourthLevel() Fourth level menu properties - containing properties for just the fourth level menu items.
java.lang.String	getFourthLevelBackgroundClass() Returns the list of CSS classes applied to the background of the fourth menu level.
java.lang.String	getFourthLevelBackgroundStyle() Returns the inline CSS style applied to the background of the fourth menu level.
VerticalMenuLevelProperties	getGlobalLevel() Global menu properties - containing properties for the entire menu plus menu item properties that apply to both the top level and drop down levels.
int	getNumberOfLevels() The number of menu levels that will expand vertically.
VerticalMenuLevelProperties	getSecondLevel() Second level menu properties - containing properties for just the second level menu items.
java.lang.String	getSecondLevelBackgroundClass() Returns the list of CSS classes applied to the background of the second menu level.
java.lang.String	getSecondLevelBackgroundStyle() Returns the inline CSS style applied to the background of the second menu level.
VerticalMenuLevelProperties	getSubLevel() Drop out level menu properties - containing properties for just the drop out level menu items.
VerticalMenuLevelProperties	getThirdLevel() Third level menu properties - containing properties for just the third level menu items.
java.lang.String	getThirdLevelBackgroundClass() Returns the list of CSS classes applied to the background of the third menu level.
java.lang.String	getThirdLevelBackgroundStyle() Returns the inline CSS style applied to the background of the third menu level.
java.lang.String	getTopLevelBackgroundClass() Returns the list of CSS classes applied to the background of the first menu level.
java.lang.String	getTopLevelBackgroundStyle() Returns the inline CSS style applied to the background of the first menu level.
void	setBackgroundClass(java.lang.String backgroundClass) Sets one or more CSS classes to be applied to the background of the drop out menu levels.
void	setBackgroundStyle(java.lang.String backgroundStyle) Sets the inline CSS style to be applied to the background of the drop out menu levels.
void	setFourthLevelBackgroundClass(java.lang.String fourthLevelBackgroundClass) Sets one or more CSS classes to be applied to the background of the fourth menu level.
void	setFourthLevelBackgroundStyle(java.lang.String fourthLevelBackgroundStyle) Sets the inline CSS style to be applied to the background of the fourth menu level.
void	setNumberOfLevels(int numberOfLevels) Sets the number of menu levels that will expand vertically.
void	setSecondLevelBackgroundClass(java.lang.String secondLevelBackgroundClass) Sets one or more CSS classes to be applied to the background of the second menu level.
void	setSecondLevelBackgroundStyle(java.lang.String secondLevelBackgroundStyle) Sets the inline CSS style to be applied to the background of the second menu level.
void	setThirdLevelBackgroundClass(java.lang.String thirdLevelBackgroundClass) Sets one or more CSS classes to be applied to the background of the third menu level.
void	setThirdLevelBackgroundStyle(java.lang.String thirdLevelBackgroundStyle) Sets the inline CSS style to be applied to the background of the third menu level.
void	setTopLevelBackgroundClass(java.lang.String topLevelBackgroundClass) Sets one or more CSS classes to be applied to the background of the first menu level.
void	setTopLevelBackgroundStyle(java.lang.String topLevelBackgroundStyle) Sets the inline CSS style to be applied to the background of the first menu level.

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

getFourthLevelClass, getFourthLevelHoverStyle, getFourthLevelHoverTextStyle, getFourthLevelLeafClass, getFourthLevelLeafHoverStyle, getFourthLevelLeafHoverTextStyle, getFourthLevelLeafSelectedClass, getFourthLevelLeafSelectedStyle, getFourthLevelLeafSelectedTextClass, getFourthLevelLeafSelectedTextStyle, getFourthLevelLeafStyle, getFourthLevelLeafTextClass, getFourthLevelLeafTextStyle, getFourthLevelSelectedClass, getFourthLevelSelectedStyle, getFourthLevelSelectedTextClass, getFourthLevelSelectedTextStyle, getFourthLevelStyle, getFourthLevelTextClass, getFourthLevelTextStyle, getHoverStyle, getHoverTextStyle, getItemClass, getItemStyle, getLeafClass, getLeafHoverStyle, getLeafHoverTextStyle, getLeafSelectedClass, getLeafSelectedStyle, getLeafSelectedTextClass, getLeafSelectedTextStyle, getLeafStyle, getLeafTextClass, getLeafTextStyle, getName, getSecondLevelClass, getSecondLevelHoverStyle, getSecondLevelHoverTextStyle, getSecondLevelLeafClass, getSecondLevelLeafHoverStyle, getSecondLevelLeafHoverTextStyle, getSecondLevelLeafSelectedClass, getSecondLevelLeafSelectedStyle, getSecondLevelLeafSelectedTextClass, getSecondLevelLeafSelectedTextStyle, getSecondLevelLeafStyle, getSecondLevelLeafTextClass, getSecondLevelLeafTextStyle, getSecondLevelSelectedClass, getSecondLevelSelectedStyle, getSecondLevelSelectedTextClass, getSecondLevelSelectedTextStyle, getSecondLevelStyle, getSecondLevelTextClass, getSecondLevelTextStyle, getSelected, getSelectedClass, getSelectedStyle, getSelectedTextClass, getSelectedTextStyle, getTextClass, getTextStyle, getThirdLevelClass, getThirdLevelHoverStyle, getThirdLevelHoverTextStyle, getThirdLevelLeafClass, getThirdLevelLeafHoverStyle, getThirdLevelLeafHoverTextStyle, getThirdLevelLeafSelectedClass, getThirdLevelLeafSelectedStyle, getThirdLevelLeafSelectedTextClass, getThirdLevelLeafSelectedTextStyle, getThirdLevelLeafStyle, getThirdLevelLeafTextClass, getThirdLevelLeafTextStyle, getThirdLevelSelectedClass, getThirdLevelSelectedStyle, getThirdLevelSelectedTextClass, getThirdLevelSelectedTextStyle, getThirdLevelStyle, getThirdLevelTextClass, getThirdLevelTextStyle, getTopLevelClass, getTopLevelHoverStyle, getTopLevelHoverTextStyle, getTopLevelLeafClass, getTopLevelLeafHoverStyle, getTopLevelLeafHoverTextStyle, getTopLevelLeafSelectedClass, getTopLevelLeafSelectedStyle, getTopLevelLeafSelectedTextClass, getTopLevelLeafSelectedTextStyle, getTopLevelLeafStyle, getTopLevelLeafTextClass, getTopLevelLeafTextStyle, getTopLevelSelectedClass, getTopLevelSelectedStyle, getTopLevelSelectedTextClass, getTopLevelSelectedTextStyle, getTopLevelStyle, getTopLevelTextClass, getTopLevelTextStyle, getWidth, isMarkParentsAsSelected, isShareable, isSkipValidation, setFourthLevelClass, setFourthLevelHoverStyle, setFourthLevelHoverTextStyle, setFourthLevelLeafClass, setFourthLevelLeafHoverStyle, setFourthLevelLeafHoverTextStyle, setFourthLevelLeafSelectedClass, setFourthLevelLeafSelectedStyle, setFourthLevelLeafSelectedTextClass, setFourthLevelLeafSelectedTextStyle, setFourthLevelLeafStyle, setFourthLevelLeafTextClass, setFourthLevelLeafTextStyle, setFourthLevelSelectedClass, setFourthLevelSelectedStyle, setFourthLevelSelectedTextClass, setFourthLevelSelectedTextStyle, setFourthLevelStyle, setFourthLevelTextClass, setFourthLevelTextStyle, setHoverStyle, setHoverTextStyle, setItemClass, setItemStyle, setLeafClass, setLeafHoverStyle, setLeafHoverTextStyle, setLeafSelectedClass, setLeafSelectedStyle, setLeafSelectedTextClass, setLeafSelectedTextStyle, setLeafStyle, setLeafTextClass, setLeafTextStyle, setMarkParentsAsSelected, setSecondLevelClass, setSecondLevelHoverStyle, setSecondLevelHoverTextStyle, setSecondLevelLeafClass, setSecondLevelLeafHoverStyle, setSecondLevelLeafHoverTextStyle, setSecondLevelLeafSelectedClass, setSecondLevelLeafSelectedStyle, setSecondLevelLeafSelectedTextClass, setSecondLevelLeafSelectedTextStyle, setSecondLevelLeafStyle, setSecondLevelLeafTextClass, setSecondLevelLeafTextStyle, setSecondLevelSelectedClass, setSecondLevelSelectedStyle, setSecondLevelSelectedTextClass, setSecondLevelSelectedTextStyle, setSecondLevelStyle, setSecondLevelTextClass, setSecondLevelTextStyle, setSelected, setSelectedClass, setSelectedStyle, setSelectedTextClass, setSelectedTextStyle, setSkipValidation, setTextClass, setTextStyle, setThirdLevelClass, setThirdLevelHoverStyle, setThirdLevelHoverTextStyle, setThirdLevelLeafClass, setThirdLevelLeafHoverStyle, setThirdLevelLeafHoverTextStyle, setThirdLevelLeafSelectedClass, setThirdLevelLeafSelectedStyle, setThirdLevelLeafSelectedTextClass, setThirdLevelLeafSelectedTextStyle, setThirdLevelLeafStyle, setThirdLevelLeafTextClass, setThirdLevelLeafTextStyle, setThirdLevelSelectedClass, setThirdLevelSelectedStyle, setThirdLevelSelectedTextClass, setThirdLevelSelectedTextStyle, setThirdLevelStyle, setThirdLevelTextClass, setThirdLevelTextStyle, setTopLevelClass, setTopLevelHoverStyle, setTopLevelHoverTextStyle, setTopLevelLeafClass, setTopLevelLeafHoverStyle, setTopLevelLeafHoverTextStyle, setTopLevelLeafSelectedClass, setTopLevelLeafSelectedStyle, setTopLevelLeafSelectedTextClass, setTopLevelLeafSelectedTextStyle, setTopLevelLeafStyle, setTopLevelLeafTextClass, setTopLevelLeafTextStyle, setTopLevelSelectedClass, setTopLevelSelectedStyle, setTopLevelSelectedTextClass, setTopLevelSelectedTextStyle, setTopLevelStyle, setTopLevelTextClass, setTopLevelTextStyle, setWidth

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

getChildControls

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

addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, 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, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages

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

getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle

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

getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding

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

getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin

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

getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat

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

getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth

Method Detail

getGlobalLevel

VerticalMenuLevelProperties getGlobalLevel()

Global menu properties - containing properties for the entire menu plus menu item properties that apply to both the top level and drop down levels.

Further documentation.

Since:

V4.4

getFirstLevel

VerticalMenuLevelProperties getFirstLevel()

First level menu properties - containing properties for just the first level menu items. These override any properties configured at the global level.

Further documentation.

Since:

V4.4

getSecondLevel

VerticalMenuLevelProperties getSecondLevel()

Second level menu properties - containing properties for just the second level menu items. These override any properties configured at the global level.

Further documentation.

Since:

V4.4

getThirdLevel

VerticalMenuLevelProperties getThirdLevel()

Third level menu properties - containing properties for just the third level menu items. These override any properties configured at the global level.

Further documentation.

Since:

V4.4

getFourthLevel

VerticalMenuLevelProperties getFourthLevel()

Fourth level menu properties - containing properties for just the fourth level menu items. These override any properties configured at the global level.

Further documentation.

Since:

V4.4

getSubLevel

VerticalMenuLevelProperties getSubLevel()

Drop out level menu properties - containing properties for just the drop out level menu items. These override any properties configured at the global level.

Further documentation.

Since:

V4.4

getNumberOfLevels

int getNumberOfLevels()

The number of menu levels that will expand vertically. After this, subsequent menu levels will be shown as dynamic dropdowns

Further documentation.

Since:

V4.4

setNumberOfLevels

void setNumberOfLevels(int numberOfLevels)

Sets the number of menu levels that will expand vertically. After this, subsequent menu levels will be shown as dynamic dropdowns

Further documentation.

Since:

V4.4

getTopLevelBackgroundClass

java.lang.String getTopLevelBackgroundClass()

Returns the list of CSS classes applied to the background of the first menu level.

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:

setTopLevelBackgroundClass(String)

setTopLevelBackgroundClass

void setTopLevelBackgroundClass(java.lang.String topLevelBackgroundClass)

Sets one or more CSS classes to be applied to the background of the first menu level. 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

getTopLevelBackgroundStyle

java.lang.String getTopLevelBackgroundStyle()

Returns the inline CSS style applied to the background of the first menu level.

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:

setTopLevelBackgroundStyle(String)

setTopLevelBackgroundStyle

void setTopLevelBackgroundStyle(java.lang.String topLevelBackgroundStyle)

Sets the inline CSS style to be applied to the background of the first menu level. 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

getSecondLevelBackgroundClass

java.lang.String getSecondLevelBackgroundClass()

Returns the list of CSS classes applied to the background of the second menu level.

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:

setSecondLevelBackgroundClass(String)

setSecondLevelBackgroundClass

void setSecondLevelBackgroundClass(java.lang.String secondLevelBackgroundClass)

Sets one or more CSS classes to be applied to the background of the second menu level. 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

getSecondLevelBackgroundStyle

java.lang.String getSecondLevelBackgroundStyle()

Returns the inline CSS style applied to the background of the second menu level.

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:

setSecondLevelBackgroundStyle(String)

setSecondLevelBackgroundStyle

void setSecondLevelBackgroundStyle(java.lang.String secondLevelBackgroundStyle)

Sets the inline CSS style to be applied to the background of the second menu level. 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

getThirdLevelBackgroundClass

java.lang.String getThirdLevelBackgroundClass()

Returns the list of CSS classes applied to the background of the third menu level.

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:

setThirdLevelBackgroundClass(String)

setThirdLevelBackgroundClass

void setThirdLevelBackgroundClass(java.lang.String thirdLevelBackgroundClass)

Sets one or more CSS classes to be applied to the background of the third menu level. 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

getThirdLevelBackgroundStyle

java.lang.String getThirdLevelBackgroundStyle()

Returns the inline CSS style applied to the background of the third menu level.

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:

setThirdLevelBackgroundStyle(String)

setThirdLevelBackgroundStyle

void setThirdLevelBackgroundStyle(java.lang.String thirdLevelBackgroundStyle)

Sets the inline CSS style to be applied to the background of the third menu level. 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

getFourthLevelBackgroundClass

java.lang.String getFourthLevelBackgroundClass()

Returns the list of CSS classes applied to the background of the fourth menu level.

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:

setFourthLevelBackgroundClass(String)

setFourthLevelBackgroundClass

void setFourthLevelBackgroundClass(java.lang.String fourthLevelBackgroundClass)

Sets one or more CSS classes to be applied to the background of the fourth menu level. 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

getFourthLevelBackgroundStyle

java.lang.String getFourthLevelBackgroundStyle()

Returns the inline CSS style applied to the background of the fourth menu level.

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:

setFourthLevelBackgroundStyle(String)

setFourthLevelBackgroundStyle

void setFourthLevelBackgroundStyle(java.lang.String fourthLevelBackgroundStyle)

Sets the inline CSS style to be applied to the background of the fourth menu level. 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

getBackgroundClass

java.lang.String getBackgroundClass()

Returns the list of CSS classes applied to the background of the drop out menu levels.

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:

setBackgroundClass(String)

setBackgroundClass

void setBackgroundClass(java.lang.String backgroundClass)

Sets one or more CSS classes to be applied to the background of the drop out menu levels. 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

getBackgroundStyle

java.lang.String getBackgroundStyle()

Returns the inline CSS style applied to the background of the drop out menu levels.

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:

setBackgroundStyle(String)

setBackgroundStyle

void setBackgroundStyle(java.lang.String backgroundStyle)

Sets the inline CSS style to be applied to the background of the drop out menu levels. 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