Package com.ebasetech.xi.api.controls
Interface BasicBlockControl
- All Superinterfaces:
AriaControlProperties,BackgroundStyleProperties,BorderStyleProperties,ContainerControl,Control,Element,EventOwner,LayoutControl,MarginStyleProperties,MessageContainer,MessageProperties,PaddingStyleProperties,java.io.Serializable,TextStyleProperties,WebFormEventOwner
- All Known Subinterfaces:
ArticleControl,AsideControl,BootstrapContainerControl,FooterControl,HeaderControl,ListControl,ListItemControl,ListPanelControl,MainControl,NavControl,PanelControl,SectionControl
public interface BasicBlockControl extends LayoutControl, BackgroundStyleProperties, BorderStyleProperties, PaddingStyleProperties, MarginStyleProperties, TextStyleProperties, AriaControlProperties
-
Method Summary
Modifier and Type Method Description java.lang.StringgetHeight()Panel height.java.lang.StringgetWidth()Panel width.voidsetHeight(java.lang.String height)Sets the panel height, and is equivalent to the CSS height property and any valid value for this CSS property can be used.voidsetWidth(java.lang.String width)Sets the panel width.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.LayoutControl
getLayout, getLayoutTypeMethods 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.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, setTopPaddingMethods inherited from interface com.ebasetech.xi.api.controls.TextStyleProperties
getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize
-
Method Details
-
getWidth
java.lang.String getWidth()Panel width. SeesetWidth(String)for details of supported values when setting this property.- Since:
- V4.4
-
setWidth
void setWidth(java.lang.String width)Sets the panel width.Supported values:
Value Description A specific value As per the CSS width property e.g. 300px Child The minimum value: this results in the Panel Control being just as wide as it needs to be to accommodate its children. null The maximum value: the width is taken from the parent container control. This width will then include the Panel Control plus any configured padding, border or margins. The width setting will be ignored if the parent container layout specifies a horizontal cell alignment of fill (this applies to Horizontal Box, Vertical Box and Column layouts). This is equivalent to specifying maximum above.
Warning: when a specific value is set, any padding, border or margins will be in addition to the specified value and can cause the Panel Control to "break out" of its parent space. In particular, try and avoid specifying a width of 100%; use maximum (null) instead.
Examples:
controls.PANEL1.width = "300px"; controls.PANEL1.width = "50%"; controls.PANEL1.setWidth("Child"); controls.PANEL1.setWidth(null);- Since:
- V4.4
-
getHeight
java.lang.String getHeight()Panel height. This is equivalent to the CSS height property, and any valid value for this CSS property can be used when setting a value.- Since:
- V4.4
- See Also:
setHeight(String)
-
setHeight
void setHeight(java.lang.String height)Sets the panel height, and is equivalent to the CSS height property and any valid value for this CSS property can be used. Setting this property tonullremoves any existing value.Examples:
controls.PANEL1.height = "50px"; controls.PANEL1.setHeight("100px");- Since:
- V4.4
-