com.ebasetech.xi.api.controls
Interface PanelControl

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, ContainerControl, Control, Element, EventOwner, LayoutControl, MarginStyleProperties, MessageContainer, MessageProperties, PaddingStyleProperties, java.io.Serializable, TextStyleProperties, WebFormEventOwner

public interface PanelControl
extends LayoutControl, BackgroundStyleProperties, BorderStyleProperties, PaddingStyleProperties, MarginStyleProperties, TextStyleProperties

Panel Control

Further documentation.

Method Summary

java.lang.String	getHeight() Panel height.
java.lang.String	getWidth() Panel width.
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.
void	setWidth(java.lang.String width) Sets the panel width.

Methods inherited from interface com.ebasetech.xi.api.controls.LayoutControl

getLayout, getLayoutType

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

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

getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize

Method Detail

getWidth

java.lang.String getWidth()

Panel width. See setWidth(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 to null removes any existing value.

Examples:

 controls.PANEL1.height = "50px";
 controls.PANEL1.setHeight("100px");
 

Since:

V4.4