VerticalMenuControl

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 HorizontalMenuControl.

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

VerticalMenuControl Functions

getBackgroundClass VerticalMenuControl.getBackgroundClass( ) Returns the list of CSS classes applied to the background of the drop out menu levels.
setBackgroundClass VerticalMenuControl.setBackgroundClass( backgroundClass ) Sets one or more CSS classes to be applied to the background of the drop out menu levels.
getBackgroundStyle VerticalMenuControl.getBackgroundStyle( ) Returns the inline CSS style applied to the background of the drop out menu levels.
setBackgroundStyle VerticalMenuControl.setBackgroundStyle( backgroundStyle ) Sets the inline CSS style to be applied to the background of the drop out menu levels.
getFirstLevel VerticalMenuControl.getFirstLevel( ) First level menu properties - containing properties for just the first level menu items.
getFourthLevel VerticalMenuControl.getFourthLevel( ) Fourth level menu properties - containing properties for just the fourth level menu items.
getFourthLevelBackgroundClass VerticalMenuControl.getFourthLevelBackgroundClass( ) Returns the list of CSS classes applied to the background of the fourth menu level.
setFourthLevelBackgroundClass VerticalMenuControl.setFourthLevelBackgroundClass( fourthLevelBackgroundClass ) Sets one or more CSS classes to be applied to the background of the fourth menu level.
getFourthLevelBackgroundStyle VerticalMenuControl.getFourthLevelBackgroundStyle( ) Returns the inline CSS style applied to the background of the fourth menu level.
setFourthLevelBackgroundStyle VerticalMenuControl.setFourthLevelBackgroundStyle( fourthLevelBackgroundStyle ) Sets the inline CSS style to be applied to the background of the fourth menu level.
getGlobalLevel VerticalMenuControl.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.
getNumberOfLevels VerticalMenuControl.getNumberOfLevels( ) The number of menu levels that will expand vertically.
setNumberOfLevels VerticalMenuControl.setNumberOfLevels( numberOfLevels ) Sets the number of menu levels that will expand vertically.
getSecondLevel VerticalMenuControl.getSecondLevel( ) Second level menu properties - containing properties for just the second level menu items.
getSecondLevelBackgroundClass VerticalMenuControl.getSecondLevelBackgroundClass( ) Returns the list of CSS classes applied to the background of the second menu level.
setSecondLevelBackgroundClass VerticalMenuControl.setSecondLevelBackgroundClass( secondLevelBackgroundClass ) Sets one or more CSS classes to be applied to the background of the second menu level.
getSecondLevelBackgroundStyle VerticalMenuControl.getSecondLevelBackgroundStyle( ) Returns the inline CSS style applied to the background of the second menu level.
setSecondLevelBackgroundStyle VerticalMenuControl.setSecondLevelBackgroundStyle( secondLevelBackgroundStyle ) Sets the inline CSS style to be applied to the background of the second menu level.
getSubLevel VerticalMenuControl.getSubLevel( ) Drop out level menu properties - containing properties for just the drop out level menu items.
getThirdLevel VerticalMenuControl.getThirdLevel( ) Third level menu properties - containing properties for just the third level menu items.
getThirdLevelBackgroundClass VerticalMenuControl.getThirdLevelBackgroundClass( ) Returns the list of CSS classes applied to the background of the third menu level.
setThirdLevelBackgroundClass VerticalMenuControl.setThirdLevelBackgroundClass( thirdLevelBackgroundClass ) Sets one or more CSS classes to be applied to the background of the third menu level.
getThirdLevelBackgroundStyle VerticalMenuControl.getThirdLevelBackgroundStyle( ) Returns the inline CSS style applied to the background of the third menu level.
setThirdLevelBackgroundStyle VerticalMenuControl.setThirdLevelBackgroundStyle( thirdLevelBackgroundStyle ) Sets the inline CSS style to be applied to the background of the third menu level.
getTopLevelBackgroundClass VerticalMenuControl.getTopLevelBackgroundClass( ) Returns the list of CSS classes applied to the background of the first menu level.
setTopLevelBackgroundClass VerticalMenuControl.setTopLevelBackgroundClass( topLevelBackgroundClass ) Sets one or more CSS classes to be applied to the background of the first menu level.
getTopLevelBackgroundStyle VerticalMenuControl.getTopLevelBackgroundStyle( ) Returns the inline CSS style applied to the background of the first menu level.
setTopLevelBackgroundStyle VerticalMenuControl.setTopLevelBackgroundStyle( topLevelBackgroundStyle ) Sets the inline CSS style to be applied to the background of the first menu level.

MenuControl Functions

getFourthLevelClass VerticalMenuControl.getFourthLevelClass( ) Returns the list of CSS classes applied to fourth level non-leaf unselected menu items.
setFourthLevelClass VerticalMenuControl.setFourthLevelClass( fourthLevelClass ) Sets one or more CSS classes to be applied to fourth level non-leaf unselected menu items.
getFourthLevelHoverStyle VerticalMenuControl.getFourthLevelHoverStyle( ) Returns the inline CSS style applied to fourth level non-leaf unselected menu items when the mouse is hovered over the item.
setFourthLevelHoverStyle VerticalMenuControl.setFourthLevelHoverStyle( fourthLevelHoverStyle ) Sets the inline CSS style to be applied to fourth level non-leaf unselected menu items when the mouse is hovered over the item.
getFourthLevelHoverTextStyle VerticalMenuControl.getFourthLevelHoverTextStyle( ) Returns the inline CSS style applied to the texts of fourth level non-leaf unselected menu items when the mouse is hovered over the item.
setFourthLevelHoverTextStyle VerticalMenuControl.setFourthLevelHoverTextStyle( fourthLevelHoverTextStyle ) Sets the inline CSS style to be applied to the texts of fourth level non-leaf selected menu items when the mouse is hovered over the item.
getFourthLevelLeafClass VerticalMenuControl.getFourthLevelLeafClass( ) Returns the list of CSS classes applied to fourth level leaf unselected menu items.
setFourthLevelLeafClass VerticalMenuControl.setFourthLevelLeafClass( fourthLevelLeafClass ) Sets one or more CSS classes to be applied to fourth level leaf unselected menu items.
getFourthLevelLeafHoverStyle VerticalMenuControl.getFourthLevelLeafHoverStyle( ) Returns the inline CSS style applied to fourth level leaf unselected menu items when the mouse is hovered over the item.
setFourthLevelLeafHoverStyle VerticalMenuControl.setFourthLevelLeafHoverStyle( fourthLevelLeafHoverStyle ) Sets the inline CSS style to be applied to fourth level leaf unselected menu items when the mouse is hovered over the item.
getFourthLevelLeafHoverTextStyle VerticalMenuControl.getFourthLevelLeafHoverTextStyle( ) Returns the inline CSS style applied to the texts of fourth level leaf unselected menu items when the mouse is hovered over the item.
setFourthLevelLeafHoverTextStyle VerticalMenuControl.setFourthLevelLeafHoverTextStyle( fourthLevelLeafHoverTextStyle ) Sets the inline CSS style to be applied to the texts of fourth level leaf selected menu items when the mouse is hovered over the item.
getFourthLevelLeafSelectedClass VerticalMenuControl.getFourthLevelLeafSelectedClass( ) Returns the inline CSS style applied to fourth level leaf selected menu items.
setFourthLevelLeafSelectedClass VerticalMenuControl.setFourthLevelLeafSelectedClass( fourthLevelLeafSelectedClass ) Sets the inline CSS style to be applied to fourth level leaf selected menu items.
getFourthLevelLeafSelectedStyle VerticalMenuControl.getFourthLevelLeafSelectedStyle( ) Returns the inline CSS style applied to fourth level leaf selected menu items.
setFourthLevelLeafSelectedStyle VerticalMenuControl.setFourthLevelLeafSelectedStyle( fourthLevelLeafSelectedStyle ) Sets the inline CSS style to be applied to fourth level leaf selected menu items.
getFourthLevelLeafSelectedTextClass VerticalMenuControl.getFourthLevelLeafSelectedTextClass( ) Returns the list of CSS classes applied to the texts of fourth level leaf selected menu items.
setFourthLevelLeafSelectedTextClass VerticalMenuControl.setFourthLevelLeafSelectedTextClass( fourthLevelLeafSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of fourth level leaf selected menu items.
getFourthLevelLeafSelectedTextStyle VerticalMenuControl.getFourthLevelLeafSelectedTextStyle( ) Returns the inline CSS style applied to the texts of fourth level leaf selected menu items.
setFourthLevelLeafSelectedTextStyle VerticalMenuControl.setFourthLevelLeafSelectedTextStyle( fourthLevelLeafSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of fourth level leaf selected menu items.
getFourthLevelLeafStyle VerticalMenuControl.getFourthLevelLeafStyle( ) Returns the inline CSS style applied to fourth level leaf unselected menu items.
setFourthLevelLeafStyle VerticalMenuControl.setFourthLevelLeafStyle( fourthLevelLeafStyle ) Sets the inline CSS style to be applied to fourth level leaf unselected menu items.
getFourthLevelLeafTextClass VerticalMenuControl.getFourthLevelLeafTextClass( ) Returns the list of CSS classes applied to the texts of fourth level leaf unselected menu items.
setFourthLevelLeafTextClass VerticalMenuControl.setFourthLevelLeafTextClass( fourthLevelLeafTextClass ) Sets one or more CSS classes to be applied to the texts of fourth level leaf unselected menu items.
getFourthLevelLeafTextStyle VerticalMenuControl.getFourthLevelLeafTextStyle( ) Returns the inline CSS style applied to fourth level leaf selected menu items.
setFourthLevelLeafTextStyle VerticalMenuControl.setFourthLevelLeafTextStyle( fourthLevelLeafTextStyle ) Sets the inline CSS style to be applied to fourth level leaf selected menu items.
getFourthLevelSelectedClass VerticalMenuControl.getFourthLevelSelectedClass( ) Returns the list of CSS classes applied to fourth level non-leaf selected menu items.
setFourthLevelSelectedClass VerticalMenuControl.setFourthLevelSelectedClass( fourthLevelSelectedClass ) Sets one or more CSS classes to be applied to fourth level non-leaf selected menu items.
getFourthLevelSelectedStyle VerticalMenuControl.getFourthLevelSelectedStyle( ) Returns the inline CSS style applied to fourth level non-leaf selected menu items.
setFourthLevelSelectedStyle VerticalMenuControl.setFourthLevelSelectedStyle( fourthLevelSelectedStyle ) Sets the inline CSS style to be applied to fourth level non-leaf selected menu items.
getFourthLevelSelectedTextClass VerticalMenuControl.getFourthLevelSelectedTextClass( ) Returns the list of CSS classes applied to the texts of fourth level non-leaf selected menu items.
setFourthLevelSelectedTextClass VerticalMenuControl.setFourthLevelSelectedTextClass( fourthLevelSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of fourth level non-leaf selected menu items.
getFourthLevelSelectedTextStyle VerticalMenuControl.getFourthLevelSelectedTextStyle( ) Returns the inline CSS style applied to fourth level non-leaf selected menu items.
setFourthLevelSelectedTextStyle VerticalMenuControl.setFourthLevelSelectedTextStyle( fourthLevelSelectedTextStyle ) Sets the inline CSS style to be applied to fourth level non-leaf selected menu items.
getFourthLevelStyle VerticalMenuControl.getFourthLevelStyle( ) Returns the inline CSS style applied to fourth level non-leaf unselected menu items.
setFourthLevelStyle VerticalMenuControl.setFourthLevelStyle( fourthLevelStyle ) Sets the inline CSS style to be applied to fourth level non-leaf unselected menu items.
getFourthLevelTextClass VerticalMenuControl.getFourthLevelTextClass( ) Returns the list of CSS classes applied to the texts of fourth level non-leaf unselected menu items.
setFourthLevelTextClass VerticalMenuControl.setFourthLevelTextClass( fourthLevelTextClass ) Sets one or more CSS classes to be applied to the texts of fourth level non-leaf unselected menu items.
getFourthLevelTextStyle VerticalMenuControl.getFourthLevelTextStyle( ) Returns the inline CSS style applied to the texts of fourth level non-leaf unselected menu items.
setFourthLevelTextStyle VerticalMenuControl.setFourthLevelTextStyle( fourthLevelTextStyle ) Sets the inline CSS style to be applied to the texts of fourth level non-leaf unselected menu items.
getHoverStyle VerticalMenuControl.getHoverStyle( ) Returns the inline CSS style applied to drop-down non-leaf unselected menu items when the mouse is hovered over the item.
setHoverStyle VerticalMenuControl.setHoverStyle( hoverStyle ) Sets the inline CSS style to be applied to drop-down non-leaf unselected menu items when the mouse is hovered over the item.
getHoverTextStyle VerticalMenuControl.getHoverTextStyle( ) Returns the inline CSS style applied to the texts of drop-down non-leaf unselected menu items when the mouse is hovered over the item.
setHoverTextStyle VerticalMenuControl.setHoverTextStyle( hoverTextStyle ) Sets the inline CSS style to be applied to the texts of drop-down non-leaf selected menu items when the mouse is hovered over the item.
getItemClass VerticalMenuControl.getItemClass( ) Returns the list of CSS classes applied to drop-down non-leaf unselected menu items.
setItemClass VerticalMenuControl.setItemClass( itemClass ) Sets one or more CSS classes to be applied to drop-down non-leaf unselected menu items.
getItemStyle VerticalMenuControl.getItemStyle( ) Returns the inline CSS style applied to drop-down non-leaf unselected menu items.
setItemStyle VerticalMenuControl.setItemStyle( itemStyle ) Sets the inline CSS style to be applied to drop-down non-leaf unselected menu items.
getLeafClass VerticalMenuControl.getLeafClass( ) Returns the list of CSS classes applied to drop-down leaf unselected menu items.
setLeafClass VerticalMenuControl.setLeafClass( leafClass ) Sets one or more CSS classes to be applied to drop-down leaf unselected menu items.
getLeafHoverStyle VerticalMenuControl.getLeafHoverStyle( ) Returns the inline CSS style applied to drop-down leaf unselected menu items when the mouse is hovered over the item.
setLeafHoverStyle VerticalMenuControl.setLeafHoverStyle( leafHoverStyle ) Sets the inline CSS style to be applied to drop-down leaf unselected menu items when the mouse is hovered over the item.
getLeafHoverTextStyle VerticalMenuControl.getLeafHoverTextStyle( ) Returns the inline CSS style applied to the texts of drop-down leaf unselected menu items when the mouse is hovered over the item.
setLeafHoverTextStyle VerticalMenuControl.setLeafHoverTextStyle( leafHoverTextStyle ) Sets the inline CSS style to be applied to the texts of drop-down leaf selected menu items when the mouse is hovered over the item.
getLeafSelectedClass VerticalMenuControl.getLeafSelectedClass( ) Returns the list of CSS classes applied to drop-down leaf selected menu items.
setLeafSelectedClass VerticalMenuControl.setLeafSelectedClass( leafSelectedClass ) Sets one or more CSS classes to be applied to drop-down leaf selected menu items.
getLeafSelectedStyle VerticalMenuControl.getLeafSelectedStyle( ) Returns the inline CSS style applied to drop-down leaf selected menu items.
setLeafSelectedStyle VerticalMenuControl.setLeafSelectedStyle( leafSelectedStyle ) Sets the inline CSS style to be applied to drop-down leaf selected menu items.
getLeafSelectedTextClass VerticalMenuControl.getLeafSelectedTextClass( ) Returns the list of CSS classes applied to the texts of drop-down leaf selected menu items.
setLeafSelectedTextClass VerticalMenuControl.setLeafSelectedTextClass( leafSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of drop-down leaf selected menu items.
getLeafSelectedTextStyle VerticalMenuControl.getLeafSelectedTextStyle( ) Returns the inline CSS style applied to the texts of drop-down leaf selected menu items.
setLeafSelectedTextStyle VerticalMenuControl.setLeafSelectedTextStyle( leafSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of drop-down leaf selected menu items.
getLeafStyle VerticalMenuControl.getLeafStyle( ) Returns the inline CSS style applied to drop-down leaf unselected menu items.
setLeafStyle VerticalMenuControl.setLeafStyle( leafStyle ) Sets the inline CSS style to be applied to drop-down leaf unselected menu items.
getLeafTextClass VerticalMenuControl.getLeafTextClass( ) Returns the list of CSS classes applied to the texts of drop-down leaf unselected menu items.
setLeafTextClass VerticalMenuControl.setLeafTextClass( leafTextClass ) Sets one or more CSS classes to be applied to the texts of drop-down leaf unselected menu items.
getLeafTextStyle VerticalMenuControl.getLeafTextStyle( ) Returns the inline CSS style applied to the texts of drop-down leaf unselected menu items.
setLeafTextStyle VerticalMenuControl.setLeafTextStyle( leafTextStyle ) Sets the inline CSS style to be applied to the texts of drop-down leaf unselected menu items.
isMarkParentsAsSelected VerticalMenuControl.isMarkParentsAsSelected( ) Indicates whether or not all parent menu items are also marked as selected when a lower level menu item is selected.
setMarkParentsAsSelected VerticalMenuControl.setMarkParentsAsSelected( markParentsAsSelected ) Sets whether or not all parent menu items are also marked as selected when a lower level menu item is selected.
getName VerticalMenuControl.getName( ) The item name that uniquely identifies the shared menu and allows other Menu Controls to share the same menu state.
getSecondLevelClass VerticalMenuControl.getSecondLevelClass( ) Returns the list of CSS classes applied to second level non-leaf unselected menu items.
setSecondLevelClass VerticalMenuControl.setSecondLevelClass( secondLevelClass ) Sets one or more CSS classes to be applied to second level non-leaf unselected menu items.
getSecondLevelHoverStyle VerticalMenuControl.getSecondLevelHoverStyle( ) Returns the inline CSS style applied to second level non-leaf unselected menu items when the mouse is hovered over the item.
setSecondLevelHoverStyle VerticalMenuControl.setSecondLevelHoverStyle( secondLevelHoverStyle ) Sets the inline CSS style to be applied to second level non-leaf unselected menu items when the mouse is hovered over the item.
getSecondLevelHoverTextStyle VerticalMenuControl.getSecondLevelHoverTextStyle( ) Returns the inline CSS style applied to the texts of second level non-leaf unselected menu items when the mouse is hovered over the item.
setSecondLevelHoverTextStyle VerticalMenuControl.setSecondLevelHoverTextStyle( secondLevelHoverTextStyle ) Sets the inline CSS style to be applied to the texts of second level non-leaf selected menu items when the mouse is hovered over the item.
getSecondLevelLeafClass VerticalMenuControl.getSecondLevelLeafClass( ) Returns the list of CSS classes applied to second level leaf unselected menu items.
setSecondLevelLeafClass VerticalMenuControl.setSecondLevelLeafClass( secondLevelLeafClass ) Sets one or more CSS classes to be applied to second level leaf unselected menu items.
getSecondLevelLeafHoverStyle VerticalMenuControl.getSecondLevelLeafHoverStyle( ) Returns the inline CSS style applied to second level leaf unselected menu items when the mouse is hovered over the item.
setSecondLevelLeafHoverStyle VerticalMenuControl.setSecondLevelLeafHoverStyle( secondLevelLeafHoverStyle ) Sets the inline CSS style to be applied to second level leaf unselected menu items when the mouse is hovered over the item.
getSecondLevelLeafHoverTextStyle VerticalMenuControl.getSecondLevelLeafHoverTextStyle( ) Returns the inline CSS style applied to the texts of second level leaf unselected menu items when the mouse is hovered over the item.
setSecondLevelLeafHoverTextStyle VerticalMenuControl.setSecondLevelLeafHoverTextStyle( secondLevelLeafHoverTextStyle ) Sets the inline CSS style to be applied to the texts of second level leaf selected menu items when the mouse is hovered over the item.
getSecondLevelLeafSelectedClass VerticalMenuControl.getSecondLevelLeafSelectedClass( ) Returns the inline CSS style applied to second level leaf selected menu items.
setSecondLevelLeafSelectedClass VerticalMenuControl.setSecondLevelLeafSelectedClass( secondLevelLeafSelectedClass ) Sets the inline CSS style to be applied to second level leaf selected menu items.
getSecondLevelLeafSelectedStyle VerticalMenuControl.getSecondLevelLeafSelectedStyle( ) Returns the inline CSS style applied to second level leaf selected menu items.
setSecondLevelLeafSelectedStyle VerticalMenuControl.setSecondLevelLeafSelectedStyle( secondLevelLeafSelectedStyle ) Sets the inline CSS style to be applied to second level leaf selected menu items.
getSecondLevelLeafSelectedTextClass VerticalMenuControl.getSecondLevelLeafSelectedTextClass( ) Returns the list of CSS classes applied to the texts of second level leaf selected menu items.
setSecondLevelLeafSelectedTextClass VerticalMenuControl.setSecondLevelLeafSelectedTextClass( secondLevelLeafSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of second level leaf selected menu items.
getSecondLevelLeafSelectedTextStyle VerticalMenuControl.getSecondLevelLeafSelectedTextStyle( ) Returns the inline CSS style applied to the texts of second level leaf selected menu items.
setSecondLevelLeafSelectedTextStyle VerticalMenuControl.setSecondLevelLeafSelectedTextStyle( secondLevelLeafSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of second level leaf selected menu items.
getSecondLevelLeafStyle VerticalMenuControl.getSecondLevelLeafStyle( ) Returns the inline CSS style applied to second level leaf unselected menu items.
setSecondLevelLeafStyle VerticalMenuControl.setSecondLevelLeafStyle( secondLevelLeafStyle ) Sets the inline CSS style to be applied to second level leaf unselected menu items.
getSecondLevelLeafTextClass VerticalMenuControl.getSecondLevelLeafTextClass( ) Returns the list of CSS classes applied to the texts of second level leaf unselected menu items.
setSecondLevelLeafTextClass VerticalMenuControl.setSecondLevelLeafTextClass( secondLevelLeafTextClass ) Sets one or more CSS classes to be applied to the texts of second level leaf unselected menu items.
getSecondLevelLeafTextStyle VerticalMenuControl.getSecondLevelLeafTextStyle( ) Returns the inline CSS style applied to second level leaf selected menu items.
setSecondLevelLeafTextStyle VerticalMenuControl.setSecondLevelLeafTextStyle( secondLevelLeafTextStyle ) Sets the inline CSS style to be applied to second level leaf selected menu items.
getSecondLevelSelectedClass VerticalMenuControl.getSecondLevelSelectedClass( ) Returns the list of CSS classes applied to second level non-leaf selected menu items.
setSecondLevelSelectedClass VerticalMenuControl.setSecondLevelSelectedClass( secondLevelSelectedClass ) Sets one or more CSS classes to be applied to second level non-leaf selected menu items.
getSecondLevelSelectedStyle VerticalMenuControl.getSecondLevelSelectedStyle( ) Returns the inline CSS style applied to second level non-leaf selected menu items.
setSecondLevelSelectedStyle VerticalMenuControl.setSecondLevelSelectedStyle( secondLevelSelectedStyle ) Sets the inline CSS style to be applied to second level non-leaf selected menu items.
getSecondLevelSelectedTextClass VerticalMenuControl.getSecondLevelSelectedTextClass( ) Returns the list of CSS classes applied to the texts of second level non-leaf selected menu items.
setSecondLevelSelectedTextClass VerticalMenuControl.setSecondLevelSelectedTextClass( secondLevelSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of second level non-leaf selected menu items.
getSecondLevelSelectedTextStyle VerticalMenuControl.getSecondLevelSelectedTextStyle( ) Returns the inline CSS style applied to the texts of second level non-leaf selected menu items.
setSecondLevelSelectedTextStyle VerticalMenuControl.setSecondLevelSelectedTextStyle( secondLevelSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of second level non-leaf selected menu items.
getSecondLevelStyle VerticalMenuControl.getSecondLevelStyle( ) Returns the inline CSS style applied to second level non-leaf unselected menu items.
setSecondLevelStyle VerticalMenuControl.setSecondLevelStyle( secondLevelStyle ) Sets the inline CSS style to be applied to second level non-leaf unselected menu items.
getSecondLevelTextClass VerticalMenuControl.getSecondLevelTextClass( ) Returns the list of CSS classes applied to the texts of second level non-leaf unselected menu items.
setSecondLevelTextClass VerticalMenuControl.setSecondLevelTextClass( secondLevelTextClass ) Sets one or more CSS classes to be applied to the texts of second level non-leaf unselected menu items.
getSecondLevelTextStyle VerticalMenuControl.getSecondLevelTextStyle( ) Returns the inline CSS style applied to the texts of second level non-leaf unselected menu items.
setSecondLevelTextStyle VerticalMenuControl.setSecondLevelTextStyle( secondLevelTextStyle ) Sets the inline CSS style to be applied to the texts of second level non-leaf unselected menu items.
getSelected VerticalMenuControl.getSelected( ) The item name of the currently selected menu item or null if no menu item is selected.
setSelected VerticalMenuControl.setSelected( menuItemName ) Selects the menu item identified by menuItemName.
getSelectedClass VerticalMenuControl.getSelectedClass( ) Returns the list of CSS classes applied to drop-down non-leaf selected menu items.
setSelectedClass VerticalMenuControl.setSelectedClass( selectedClass ) Sets one or more CSS classes to be applied to drop-down non-leaf selected menu items.
getSelectedStyle VerticalMenuControl.getSelectedStyle( ) Returns the inline CSS style applied to drop-down non-leaf selected menu items.
setSelectedStyle VerticalMenuControl.setSelectedStyle( selectedStyle ) Sets the inline CSS style to be applied to drop-down non-leaf selected menu items.
getSelectedTextClass VerticalMenuControl.getSelectedTextClass( ) Returns the list of CSS classes applied to the texts of drop-down non-leaf selected menu items.
setSelectedTextClass VerticalMenuControl.setSelectedTextClass( selectedTextClass ) Sets one or more CSS classes to be applied to the texts of drop-down non-leaf selected menu items.
getSelectedTextStyle VerticalMenuControl.getSelectedTextStyle( ) Returns the inline CSS style applied to the texts of drop-down non-leaf selected menu items.
setSelectedTextStyle VerticalMenuControl.setSelectedTextStyle( selectedTextStyle ) Sets the inline CSS style to be applied to the texts of drop-down non-leaf selected menu items.
isShareable VerticalMenuControl.isShareable( ) Indicates whether the menu state can be shared with menu controls on other pages or forms.
isSkipValidation VerticalMenuControl.isSkipValidation( ) Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped when a menu item is selected.
setSkipValidation VerticalMenuControl.setSkipValidation( skipValidation ) Specifies whether or not validation of controls higher on the page is skipped when a menu item is selected.
getTextClass VerticalMenuControl.getTextClass( ) Returns the list of CSS classes applied to the texts of drop-down non-leaf unselected menu items.
setTextClass VerticalMenuControl.setTextClass( textClass ) Sets one or more CSS classes to be applied to the texts of drop-down non-leaf unselected menu items.
getTextStyle VerticalMenuControl.getTextStyle( ) Returns the inline CSS style applied to the texts of drop-down non-leaf unselected menu items.
setTextStyle VerticalMenuControl.setTextStyle( textStyle ) Sets the inline CSS style to be applied to the texts of drop-down non-leaf unselected menu items.
getThirdLevelClass VerticalMenuControl.getThirdLevelClass( ) Returns the list of CSS classes applied to third level non-leaf unselected menu items.
setThirdLevelClass VerticalMenuControl.setThirdLevelClass( thirdLevelClass ) Sets one or more CSS classes to be applied to third level non-leaf unselected menu items.
getThirdLevelHoverStyle VerticalMenuControl.getThirdLevelHoverStyle( ) Returns the inline CSS style applied to third level non-leaf unselected menu items when the mouse is hovered over the item.
setThirdLevelHoverStyle VerticalMenuControl.setThirdLevelHoverStyle( thirdLevelHoverStyle ) Sets the inline CSS style to be applied to third level non-leaf unselected menu items when the mouse is hovered over the item.
getThirdLevelHoverTextStyle VerticalMenuControl.getThirdLevelHoverTextStyle( ) Returns the inline CSS style applied to the texts of third level non-leaf unselected menu items when the mouse is hovered over the item.
setThirdLevelHoverTextStyle VerticalMenuControl.setThirdLevelHoverTextStyle( thirdLevelHoverTextStyle ) Sets the inline CSS style to be applied to the texts of third level non-leaf selected menu items when the mouse is hovered over the item.
getThirdLevelLeafClass VerticalMenuControl.getThirdLevelLeafClass( ) Returns the list of CSS classes applied to third level leaf unselected menu items.
setThirdLevelLeafClass VerticalMenuControl.setThirdLevelLeafClass( thirdLevelLeafClass ) Sets one or more CSS classes to be applied to third level leaf unselected menu items.
getThirdLevelLeafHoverStyle VerticalMenuControl.getThirdLevelLeafHoverStyle( ) Returns the inline CSS style applied to third level leaf unselected menu items when the mouse is hovered over the item.
setThirdLevelLeafHoverStyle VerticalMenuControl.setThirdLevelLeafHoverStyle( thirdLevelLeafHoverStyle ) Sets the inline CSS style to be applied to third level leaf unselected menu items when the mouse is hovered over the item.
getThirdLevelLeafHoverTextStyle VerticalMenuControl.getThirdLevelLeafHoverTextStyle( ) Returns the inline CSS style applied to the texts of third level leaf unselected menu items when the mouse is hovered over the item.
setThirdLevelLeafHoverTextStyle VerticalMenuControl.setThirdLevelLeafHoverTextStyle( thirdLevelLeafHoverTextStyle ) Sets the inline CSS style to be applied to the texts of third level leaf selected menu items when the mouse is hovered over the item.
getThirdLevelLeafSelectedClass VerticalMenuControl.getThirdLevelLeafSelectedClass( ) Returns the inline CSS style applied to third level leaf selected menu items.
setThirdLevelLeafSelectedClass VerticalMenuControl.setThirdLevelLeafSelectedClass( thirdLevelLeafSelectedClass ) Sets the inline CSS style to be applied to third level leaf selected menu items.
getThirdLevelLeafSelectedStyle VerticalMenuControl.getThirdLevelLeafSelectedStyle( ) Returns the inline CSS style applied to third level leaf selected menu items.
setThirdLevelLeafSelectedStyle VerticalMenuControl.setThirdLevelLeafSelectedStyle( thirdLevelLeafSelectedStyle ) Sets the inline CSS style to be applied to third level leaf selected menu items.
getThirdLevelLeafSelectedTextClass VerticalMenuControl.getThirdLevelLeafSelectedTextClass( ) Returns the list of CSS classes applied to the texts of third level leaf selected menu items.
setThirdLevelLeafSelectedTextClass VerticalMenuControl.setThirdLevelLeafSelectedTextClass( thirdLevelLeafSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of third level leaf selected menu items.
getThirdLevelLeafSelectedTextStyle VerticalMenuControl.getThirdLevelLeafSelectedTextStyle( ) Returns the inline CSS style applied to the texts of third level leaf selected menu items.
setThirdLevelLeafSelectedTextStyle VerticalMenuControl.setThirdLevelLeafSelectedTextStyle( thirdLevelLeafSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of third level leaf selected menu items.
getThirdLevelLeafStyle VerticalMenuControl.getThirdLevelLeafStyle( ) Returns the inline CSS style applied to third level leaf unselected menu items.
setThirdLevelLeafStyle VerticalMenuControl.setThirdLevelLeafStyle( thirdLevelLeafStyle ) Sets the inline CSS style to be applied to third level leaf unselected menu items.
getThirdLevelLeafTextClass VerticalMenuControl.getThirdLevelLeafTextClass( ) Returns the list of CSS classes applied to the texts of third level leaf unselected menu items.
setThirdLevelLeafTextClass VerticalMenuControl.setThirdLevelLeafTextClass( thirdLevelLeafTextClass ) Sets one or more CSS classes to be applied to the texts of third level leaf unselected menu items.
getThirdLevelLeafTextStyle VerticalMenuControl.getThirdLevelLeafTextStyle( ) Returns the inline CSS style applied to third level leaf selected menu items.
setThirdLevelLeafTextStyle VerticalMenuControl.setThirdLevelLeafTextStyle( thirdLevelLeafTextStyle ) Sets the inline CSS style to be applied to third level leaf selected menu items.
getThirdLevelSelectedClass VerticalMenuControl.getThirdLevelSelectedClass( ) Returns the list of CSS classes applied to third level non-leaf selected menu items.
setThirdLevelSelectedClass VerticalMenuControl.setThirdLevelSelectedClass( thirdLevelSelectedClass ) Sets one or more CSS classes to be applied to third level non-leaf selected menu items.
getThirdLevelSelectedStyle VerticalMenuControl.getThirdLevelSelectedStyle( ) Returns the inline CSS style applied to third level non-leaf selected menu items.
setThirdLevelSelectedStyle VerticalMenuControl.setThirdLevelSelectedStyle( thirdLevelSelectedStyle ) Sets the inline CSS style to be applied to third level non-leaf selected menu items.
getThirdLevelSelectedTextClass VerticalMenuControl.getThirdLevelSelectedTextClass( ) Returns the list of CSS classes applied to the texts of third level non-leaf selected menu items.
setThirdLevelSelectedTextClass VerticalMenuControl.setThirdLevelSelectedTextClass( thirdLevelSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of third level non-leaf selected menu items.
getThirdLevelSelectedTextStyle VerticalMenuControl.getThirdLevelSelectedTextStyle( ) Returns the inline CSS style applied to third level non-leaf selected menu items.
setThirdLevelSelectedTextStyle VerticalMenuControl.setThirdLevelSelectedTextStyle( thirdLevelSelectedTextStyle ) Sets the inline CSS style to be applied to third level non-leaf selected menu items.
getThirdLevelStyle VerticalMenuControl.getThirdLevelStyle( ) Returns the inline CSS style applied to third level non-leaf unselected menu items.
setThirdLevelStyle VerticalMenuControl.setThirdLevelStyle( thirdLevelStyle ) Sets the inline CSS style to be applied to third level non-leaf unselected menu items.
getThirdLevelTextClass VerticalMenuControl.getThirdLevelTextClass( ) Returns the list of CSS classes applied to the texts of third level non-leaf unselected menu items.
setThirdLevelTextClass VerticalMenuControl.setThirdLevelTextClass( thirdLevelTextClass ) Sets one or more CSS classes to be applied to the texts of third level non-leaf unselected menu items.
getThirdLevelTextStyle VerticalMenuControl.getThirdLevelTextStyle( ) Returns the inline CSS style applied to the texts of third level non-leaf unselected menu items.
setThirdLevelTextStyle VerticalMenuControl.setThirdLevelTextStyle( thirdLevelTextStyle ) Sets the inline CSS style to be applied to the texts of third level non-leaf unselected menu items.
getTopLevelClass VerticalMenuControl.getTopLevelClass( ) Returns the list of CSS classes applied to top level non-leaf unselected menu items.
setTopLevelClass VerticalMenuControl.setTopLevelClass( topLevelClass ) Sets one or more CSS classes to be applied to top level non-leaf unselected menu items.
getTopLevelHoverStyle VerticalMenuControl.getTopLevelHoverStyle( ) Returns the inline CSS style applied to top level non-leaf unselected menu items when the mouse is hovered over the item.
setTopLevelHoverStyle VerticalMenuControl.setTopLevelHoverStyle( topLevelHoverStyle ) Sets the inline CSS style to be applied to top level non-leaf unselected menu items when the mouse is hovered over the item.
getTopLevelHoverTextStyle VerticalMenuControl.getTopLevelHoverTextStyle( ) Returns the inline CSS style applied to the texts of top level non-leaf unselected menu items when the mouse is hovered over the item.
setTopLevelHoverTextStyle VerticalMenuControl.setTopLevelHoverTextStyle( topLevelHoverTextStyle ) Sets the inline CSS style to be applied to the texts of top level non-leaf selected menu items when the mouse is hovered over the item.
getTopLevelLeafClass VerticalMenuControl.getTopLevelLeafClass( ) Returns the list of CSS classes applied to top level leaf unselected menu items.
setTopLevelLeafClass VerticalMenuControl.setTopLevelLeafClass( topLevelLeafClass ) Sets one or more CSS classes to be applied to top level leaf unselected menu items.
getTopLevelLeafHoverStyle VerticalMenuControl.getTopLevelLeafHoverStyle( ) Returns the inline CSS style applied to top level leaf unselected menu items when the mouse is hovered over the item.
setTopLevelLeafHoverStyle VerticalMenuControl.setTopLevelLeafHoverStyle( topLevelLeafHoverStyle ) Sets the inline CSS style to be applied to top level leaf unselected menu items when the mouse is hovered over the item.
getTopLevelLeafHoverTextStyle VerticalMenuControl.getTopLevelLeafHoverTextStyle( ) Returns the inline CSS style applied to the texts of top level leaf unselected menu items when the mouse is hovered over the item.
setTopLevelLeafHoverTextStyle VerticalMenuControl.setTopLevelLeafHoverTextStyle( topLevelLeafHoverTextStyle ) Sets the inline CSS style to be applied to the texts of top level leaf selected menu items when the mouse is hovered over the item.
getTopLevelLeafSelectedClass VerticalMenuControl.getTopLevelLeafSelectedClass( ) Returns the list of CSS classes applied to top level leaf selected menu items.
setTopLevelLeafSelectedClass VerticalMenuControl.setTopLevelLeafSelectedClass( topLevelLeafSelectedClass ) Sets one or more CSS classes to be applied to top level leaf selected menu items.
getTopLevelLeafSelectedStyle VerticalMenuControl.getTopLevelLeafSelectedStyle( ) Returns the inline CSS style applied to top level leaf selected menu items.
setTopLevelLeafSelectedStyle VerticalMenuControl.setTopLevelLeafSelectedStyle( topLevelLeafSelectedStyle ) Sets the inline CSS style to be applied to top level leaf selected menu items.
getTopLevelLeafSelectedTextClass VerticalMenuControl.getTopLevelLeafSelectedTextClass( ) Returns the list of CSS classes applied to the texts of top level leaf selected menu items.
setTopLevelLeafSelectedTextClass VerticalMenuControl.setTopLevelLeafSelectedTextClass( topLevelLeafSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of top level leaf selected menu items.
getTopLevelLeafSelectedTextStyle VerticalMenuControl.getTopLevelLeafSelectedTextStyle( ) Returns the inline CSS style applied to the texts of top level leaf selected menu items.
setTopLevelLeafSelectedTextStyle VerticalMenuControl.setTopLevelLeafSelectedTextStyle( topLevelLeafSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of top level leaf selected menu items.
getTopLevelLeafStyle VerticalMenuControl.getTopLevelLeafStyle( ) Returns the inline CSS style applied to top level leaf unselected menu items.
setTopLevelLeafStyle VerticalMenuControl.setTopLevelLeafStyle( topLevelLeafStyle ) Sets the inline CSS style to be applied to top level leaf unselected menu items.
getTopLevelLeafTextClass VerticalMenuControl.getTopLevelLeafTextClass( ) Returns the list of CSS classes applied to the texts of top level leaf unselected menu items.
setTopLevelLeafTextClass VerticalMenuControl.setTopLevelLeafTextClass( topLevelLeafTextClass ) Sets one or more CSS classes to be applied to the texts of top level leaf unselected menu items.
getTopLevelLeafTextStyle VerticalMenuControl.getTopLevelLeafTextStyle( ) Returns the inline CSS style applied to the texts of top level leaf unselected menu items.
setTopLevelLeafTextStyle VerticalMenuControl.setTopLevelLeafTextStyle( topLevelLeafTextStyle ) Sets the inline CSS style to be applied to the texts of top level leaf unselected menu items.
getTopLevelSelectedClass VerticalMenuControl.getTopLevelSelectedClass( ) Returns the list of CSS classes applied to top level non-leaf selected menu items.
setTopLevelSelectedClass VerticalMenuControl.setTopLevelSelectedClass( topLevelSelectedClass ) Sets one or more CSS classes to be applied to top level non-leaf selected menu items.
getTopLevelSelectedStyle VerticalMenuControl.getTopLevelSelectedStyle( ) Returns the inline CSS style applied to top level non-leaf selected menu items.
setTopLevelSelectedStyle VerticalMenuControl.setTopLevelSelectedStyle( topLevelSelectedStyle ) Sets the inline CSS style to be applied to top level non-leaf selected menu items.
getTopLevelSelectedTextClass VerticalMenuControl.getTopLevelSelectedTextClass( ) Returns the list of CSS classes applied to the texts of top level non-leaf selected menu items.
setTopLevelSelectedTextClass VerticalMenuControl.setTopLevelSelectedTextClass( topLevelSelectedTextClass ) Sets one or more CSS classes to be applied to the texts of top level non-leaf selected menu items.
getTopLevelSelectedTextStyle VerticalMenuControl.getTopLevelSelectedTextStyle( ) Returns the inline CSS style applied to the texts of top level non-leaf selected menu items.
setTopLevelSelectedTextStyle VerticalMenuControl.setTopLevelSelectedTextStyle( topLevelSelectedTextStyle ) Sets the inline CSS style to be applied to the texts of top level non-leaf selected menu items.
getTopLevelStyle VerticalMenuControl.getTopLevelStyle( ) Returns the inline CSS style applied to top level non-leaf unselected menu items.
setTopLevelStyle VerticalMenuControl.setTopLevelStyle( topLevelStyle ) Sets the inline CSS style to be applied to top level non-leaf unselected menu items.
getTopLevelTextClass VerticalMenuControl.getTopLevelTextClass( ) Returns the list of CSS classes applied to the texts of top level non-leaf unselected menu items.
setTopLevelTextClass VerticalMenuControl.setTopLevelTextClass( topLevelTextClass ) Sets one or more CSS classes to be applied to the texts of top level non-leaf unselected menu items.
getTopLevelTextStyle VerticalMenuControl.getTopLevelTextStyle( ) Returns the inline CSS style applied to the texts of top level non-leaf unselected menu items.
setTopLevelTextStyle VerticalMenuControl.setTopLevelTextStyle( topLevelTextStyle ) Sets the inline CSS style to be applied to the texts of top level non-leaf unselected menu items.
getWidth VerticalMenuControl.getWidth( ) Menu width.
setWidth VerticalMenuControl.setWidth( width ) Sets the menu width.

AriaControlProperties Functions

addAriaCustomAttribute VerticalMenuControl.addAriaCustomAttribute( name , value ) Add an ARIA custom attribute with a specified name and value.
getAriaCustomAttributes VerticalMenuControl.getAriaCustomAttributes( ) Returns a comma separated list of the ARIA custom attributes for the control.
setAriaCustomAttributes VerticalMenuControl.setAriaCustomAttributes( ariaCustomAttributes ) Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value.
getAriaDescribedBy VerticalMenuControl.getAriaDescribedBy( ) Returns the ARIA described-by element ID for the control.
getAriaLabelledBy VerticalMenuControl.getAriaLabelledBy( ) Returns the ARIA labelled-by element ID for the control.
getAriaLabelText VerticalMenuControl.getAriaLabelText( ) Returns the com.ebasetech.xi.api.Text object for the ARIA label text.
getAriaRole VerticalMenuControl.getAriaRole( ) Returns the ARIA role for the control.
setAriaRole VerticalMenuControl.setAriaRole( role ) Sets the ARIA role for the control.
removeAriaCustomAttribute VerticalMenuControl.removeAriaCustomAttribute( name ) Remove an ARIA custom attribute specified by name.

BackgroundStyleProperties Functions

getBackgroundColor VerticalMenuControl.getBackgroundColor( ) Background color.
setBackgroundColor VerticalMenuControl.setBackgroundColor( backgroundColor ) Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used.
getBackgroundImage VerticalMenuControl.getBackgroundImage( ) URL of the background image.
setBackgroundImage VerticalMenuControl.setBackgroundImage( backgroundImage ) Sets the URL of the background image.
getBackgroundImagePosition VerticalMenuControl.getBackgroundImagePosition( ) Background image position.
setBackgroundImagePosition VerticalMenuControl.setBackgroundImagePosition( backgroundImagePosition ) Sets the background image position.
getBackgroundImageRepeat VerticalMenuControl.getBackgroundImageRepeat( ) Background image repeat property.
setBackgroundImageRepeat VerticalMenuControl.setBackgroundImageRepeat( backgroundImageRepeat ) Sets the background image repeat property.

BorderStyleProperties Functions

getBorderColor VerticalMenuControl.getBorderColor( ) Border color applied to all borders.
setBorderColor VerticalMenuControl.setBorderColor( borderColor ) Sets border color.
getBorderRadius VerticalMenuControl.getBorderRadius( ) Border radius.
setBorderRadius VerticalMenuControl.setBorderRadius( borderRadius ) Sets border radius.
getBorderStyle VerticalMenuControl.getBorderStyle( ) Border style applied to all borders.
setBorderStyle VerticalMenuControl.setBorderStyle( borderStyle ) Sets border style.
getBorderWidth VerticalMenuControl.getBorderWidth( ) Border width applied to all four borders.
setBorderWidth VerticalMenuControl.setBorderWidth( borderWidth ) Sets the border width applied to all four borders.
getBottomBorderWidth VerticalMenuControl.getBottomBorderWidth( ) Bottom border width, overriding property borderWidth.
setBottomBorderWidth VerticalMenuControl.setBottomBorderWidth( bottomBorderWidth ) Sets the bottom border width, overriding property borderWidth.
getLeftBorderWidth VerticalMenuControl.getLeftBorderWidth( ) Left border width, overriding property borderWidth.
setLeftBorderWidth VerticalMenuControl.setLeftBorderWidth( leftBorderWidth ) Sets the left border width, overriding property borderWidth.
getRightBorderWidth VerticalMenuControl.getRightBorderWidth( ) Right border width, overriding property borderWidth.
setRightBorderWidth VerticalMenuControl.setRightBorderWidth( rightBorderWidth ) Sets the right border width, overriding property borderWidth.
getTopBorderWidth VerticalMenuControl.getTopBorderWidth( ) Top border width, overriding property borderWidth.
setTopBorderWidth VerticalMenuControl.setTopBorderWidth( topBorderWidth ) Sets the top border width, overriding property borderWidth.

ContainerControl Functions

getChildControls VerticalMenuControl.getChildControls( ) Returns an array of controls that are immediate children of this control.

MarginStyleProperties Functions

getAllMargin VerticalMenuControl.getAllMargin( ) Single MarginStyleProperties size value used for top, bottom, left and right margin.
setAllMargin VerticalMenuControl.setAllMargin( allMargin ) Sets the MarginStyleProperties size value used for top, bottom, left and right margin.
getBottomMargin VerticalMenuControl.getBottomMargin( ) Bottom MarginStyleProperties size value.
setBottomMargin VerticalMenuControl.setBottomMargin( bottomMargin ) Sets the bottom MarginStyleProperties size value.
getLeftMargin VerticalMenuControl.getLeftMargin( ) Left MarginStyleProperties size value.
setLeftMargin VerticalMenuControl.setLeftMargin( leftMargin ) Sets the left MarginStyleProperties size value.
getRightMargin VerticalMenuControl.getRightMargin( ) Right MarginStyleProperties size value.
setRightMargin VerticalMenuControl.setRightMargin( rightMargin ) Sets the right MarginStyleProperties size value.
getTopMargin VerticalMenuControl.getTopMargin( ) Top MarginStyleProperties size value.
setTopMargin VerticalMenuControl.setTopMargin( topMargin ) Sets the top MarginStyleProperties size value.

MessageProperties Functions

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

PaddingStyleProperties Functions

getAllPadding VerticalMenuControl.getAllPadding( ) Single PaddingStyleProperties size value used for top, bottom, left and right padding.
setAllPadding VerticalMenuControl.setAllPadding( allPadding ) Sets the PaddingStyleProperties size value used for top, bottom, left and right padding.
getBottomPadding VerticalMenuControl.getBottomPadding( ) Bottom PaddingStyleProperties size value.
setBottomPadding VerticalMenuControl.setBottomPadding( bottomPadding ) Sets the bottom PaddingStyleProperties size value.
getLeftPadding VerticalMenuControl.getLeftPadding( ) Left PaddingStyleProperties size value.
setLeftPadding VerticalMenuControl.setLeftPadding( leftPadding ) Sets the left PaddingStyleProperties size value.
getRightPadding VerticalMenuControl.getRightPadding( ) Right PaddingStyleProperties size value.
setRightPadding VerticalMenuControl.setRightPadding( rightPadding ) Sets the right PaddingStyleProperties size value.
getTopPadding VerticalMenuControl.getTopPadding( ) Top PaddingStyleProperties size value.
setTopPadding VerticalMenuControl.setTopPadding( topPadding ) Sets the top PaddingStyleProperties size value.

Control Functions

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

MessageContainer Functions

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

Element Functions

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