com.ebasetech.xi.api.controls
Interface HorizontalMenuControl

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

public interface HorizontalMenuControl
extends MenuControl

A Horizontal Menu Control represents a menu where the top level is shown horizontally and is always visible. If any additional levels are specified, these will drop down dynamically as the user moves the mouse over the menu items.

Further documentation

Since:
V4.4

Method Summary
 java.lang.String getGapBetweenItems()
          The separation between menu items in the top level menu.
 MenuLevelProperties 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.
 MenuLevelProperties getSubMenu()
          Drop down menu properties - containing properties for just the drop down levels.
 MenuLevelProperties getTopLevel()
          Top level menu properties - containing properties for just the top level menu items.
 void setGapBetweenItems(java.lang.String gapBetweenItems)
          Sets the separation between menu items in the top level menu.
 
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
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
 
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

getGapBetweenItems

java.lang.String getGapBetweenItems()
The separation between menu items in the top level menu. Any background specified with the background property will be visible behind the gaps.

Further documentation.

Since:
V4.4
See Also:
setGapBetweenItems(String)

setGapBetweenItems

void setGapBetweenItems(java.lang.String gapBetweenItems)
Sets the separation between menu items in the top level menu. Any background specified with the background property will be visible behind the gaps. Any valid value for the CSS font-size property can be used.

Further documentation.

Examples:

 controls.HORIZONTALMENU1.gapBetweenItems = "30px";
 

Since:
V4.4

getGlobalLevel

MenuLevelProperties 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

getTopLevel

MenuLevelProperties getTopLevel()
Top level menu properties - containing properties for just the top level menu items. These override any properties configured at the global level.

Further documentation.

Since:
V4.4

getSubMenu

MenuLevelProperties getSubMenu()
Drop down menu properties - containing properties for just the drop down levels. These override any properties configured at the global level.

Further documentation.

Since:
V4.4