Package com.ebasetech.xi.api.controls
Interface HorizontalMenuControl
- All Superinterfaces:
AriaControlProperties,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.
- Since:
- V4.4
-
Method Summary
Modifier and Type Method Description java.lang.StringgetBootstrapAlign()Returns the alignment when a form is running with the bootstrap framework configured.java.lang.StringgetGapBetweenItems()The separation between menu items in the top level menu.MenuLevelPropertiesgetGlobalLevel()Global menu properties - containing properties for the entire menu plus menu item properties that apply to both the top level and drop down levels.MenuLevelPropertiesgetSubMenu()Drop down menu properties - containing properties for just the drop down levels.MenuLevelPropertiesgetTopLevel()Top level menu properties - containing properties for just the top level menu items.voidsetBootstrapAlign(java.lang.String bootstrapAlign)Sets the alignment when a form is running with the bootstrap framework configured.voidsetGapBetweenItems(java.lang.String gapBetweenItems)Sets the separation between menu items in the top level menu.Methods inherited from interface com.ebasetech.xi.api.controls.AriaControlProperties
addAriaCustomAttribute, getAriaCustomAttributes, getAriaDescribedBy, getAriaLabelledBy, getAriaLabelText, getAriaRole, removeAriaCustomAttribute, setAriaCustomAttributes, setAriaRoleMethods inherited from interface com.ebasetech.xi.api.controls.BackgroundStyleProperties
getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeatMethods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties
getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidthMethods inherited from interface com.ebasetech.xi.api.controls.ContainerControl
getChildControlsMethods inherited from interface com.ebasetech.xi.api.controls.Control
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, 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, showMethods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementTypeMethods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties
getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMarginMethods 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, setWidthMethods 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, existWarningMessagesMethods inherited from interface com.ebasetech.xi.api.controls.MessageProperties
getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyleMethods inherited from interface com.ebasetech.xi.api.controls.PaddingStyleProperties
getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding
-
Method Details
-
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.- 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.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.- 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 theglobal level.- Since:
- V4.4
-
getSubMenu
MenuLevelProperties getSubMenu()Drop down menu properties - containing properties for just the drop down levels. These override any properties configured at theglobal level.- Since:
- V4.4
-
getBootstrapAlign
java.lang.String getBootstrapAlign()Returns the alignment when a form is running with the bootstrap framework configured.- Since:
- V5.4
- See Also:
setBootstrapAlign(String)
-
setBootstrapAlign
void setBootstrapAlign(java.lang.String bootstrapAlign)Sets the alignment when a form is running with the bootstrap framework configured. Supported values are "left", "center" and "right".- Since:
- V5.4
- See Also:
getBootstrapAlign()
-