Package com.ebasetech.xi.api.controls
Interface LayoutControl
- All Superinterfaces:
ContainerControl,Control,Element,EventOwner,MessageContainer,MessageProperties,java.io.Serializable,WebFormEventOwner
- All Known Subinterfaces:
ArticleControl,AsideControl,BasicBlockControl,BootstrapColumnControl,BootstrapContainerControl,FooterControl,GridCellControl,GroupAndPagePanelProperties,GroupPanelControl,HeaderControl,ListControl,ListItemControl,ListPanelControl,MainControl,NavControl,PageControl,PagePanelControl,PanelControl,RepeatingTableControl,RepeatingTableListControl,RepeatingTableListRowControl,RepeatingTableRowControl,SectionControl,TabControl,TitlePanelControl
public interface LayoutControl extends ContainerControl, MessageProperties
The
LayoutControl interface is implemented by all controls that can act as a container i.e. they can contain other controls.
Every container has a layout which defines how the child controls of that container are positioned relative to each other -
simple examples are horizontally and vertically.- Since:
- V4.4
-
Method Summary
Modifier and Type Method Description LayoutgetLayout()Returns theLayoutobject configured for the container control ornullif no layout is configured.java.lang.StringgetLayoutType()Returns a String representing the layout type for the container.Methods 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.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, getWarningMessageStyle
-
Method Details
-
getLayoutType
java.lang.String getLayoutType()Returns a String representing the layout type for the container. This is a read only property and cannot be set. The layout type will be one of:- FLOW
- VERTICAL_BOX
- HORIZONTAL_BOX
- COLUMN
- FIELD
nullif no layout is configured.- Since:
- V4.4
- See Also:
getLayout()
-
getLayout
Layout getLayout()Returns theLayoutobject configured for the container control ornullif no layout is configured. The specific object returned will be an extension ofLayoutand will be one of the following: This is a read only property and cannot be set.- Since:
- V4.4
-