com.ebasetech.xi.api.controls

Interface GroupAndPagePanelProperties

All Superinterfaces:

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

All Known Subinterfaces:

GroupPanelControl, PagePanelControl

public interface GroupAndPagePanelProperties
extends LayoutControl, BackgroundStyleProperties, MarginStyleProperties, BorderStyleProperties

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentClass() Returns the list of CSS classes applied to the content area containing child controls.
java.lang.String	getContentHeight() Height of the content area.
PaddingStyleProperties	getContentPadding() Content padding properties - the space between the content and its border.
java.lang.String	getContentStyle() Returns the inline CSS style applied to the content area containing child controls.
TextStyleProperties	getContentText() Content text properties.
java.lang.String	getHeaderClass() Returns the list of CSS classes applied to the header text.
GroupAndPageTextProperties	getHeaderProperties() Header text properties.
java.lang.String	getHeaderStyle() Returns the inline CSS style applied to the header text.
java.lang.String	getInfoClass() Returns the list of CSS classes applied to the information text.
GroupAndPageTextProperties	getInfoProperties() Information text properties.
java.lang.String	getInfoStyle() Returns the inline CSS style applied to the information text.
java.lang.String	getTrailerClass() Returns the list of CSS classes applied to the trailer text.
GroupAndPageTextProperties	getTrailerProperties() Trailer text properties.
java.lang.String	getTrailerStyle() Returns the inline CSS style applied to the trailer text.
java.lang.String	getWidth() Control width.
void	setContentClass(java.lang.String contentClass) Sets the inline CSS style to be applied to the content area containing child controls.
void	setContentHeight(java.lang.String contentHeight) Sets the height of the content area.
void	setContentStyle(java.lang.String contentStyle) Sets the inline CSS style to be applied to the content area containing child controls.
void	setHeaderClass(java.lang.String headerClass) Sets one or more CSS classes to be applied to the header text.
void	setHeaderStyle(java.lang.String headerStyle) Sets the inline CSS style to be applied to the header text.
void	setInfoClass(java.lang.String infoClass) Sets one or more CSS classes to be applied to the information text.
void	setInfoStyle(java.lang.String infoStyle) Sets the inline CSS style to be applied to the information text.
void	setTrailerClass(java.lang.String trailerClass) Sets one or more CSS classes to be applied to the trailer text.
void	setTrailerStyle(java.lang.String trailerStyle) Sets the inline CSS style to be applied to the trailer text.
void	setWidth(java.lang.String width) Sets the width of the Control.

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

addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, 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, 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, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages

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

getErrorMessageStyle, getInfoMessageStyle, 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.MarginStyleProperties

getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin

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

getHeaderClass

java.lang.String getHeaderClass()

Returns the list of CSS classes applied to the header text.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setHeaderClass(String)

setHeaderClass

void setHeaderClass(java.lang.String headerClass)

Sets one or more CSS classes to be applied to the header text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getHeaderStyle

java.lang.String getHeaderStyle()

Returns the inline CSS style applied to the header text.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setHeaderStyle(String)

setHeaderStyle

void setHeaderStyle(java.lang.String headerStyle)

Sets the inline CSS style to be applied to the header text. Style is entered as for the HTML style parameter.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getInfoClass

java.lang.String getInfoClass()

Returns the list of CSS classes applied to the information text.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setInfoClass(String)

setInfoClass

void setInfoClass(java.lang.String infoClass)

Sets one or more CSS classes to be applied to the information text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getInfoStyle

java.lang.String getInfoStyle()

Returns the inline CSS style applied to the information text.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setInfoStyle(String)

setInfoStyle

void setInfoStyle(java.lang.String infoStyle)

Sets the inline CSS style to be applied to the information text. Style is entered as for the HTML style parameter.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getTrailerClass

java.lang.String getTrailerClass()

Returns the list of CSS classes applied to the trailer text.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setTrailerClass(String)

setTrailerClass

void setTrailerClass(java.lang.String trailerClass)

Sets one or more CSS classes to be applied to the trailer text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getTrailerStyle

java.lang.String getTrailerStyle()

Returns the inline CSS style applied to the trailer text.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setTrailerStyle(String)

setTrailerStyle

void setTrailerStyle(java.lang.String trailerStyle)

Sets the inline CSS style to be applied to the trailer text. Style is entered as for the HTML style parameter.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getContentClass

java.lang.String getContentClass()

Returns the list of CSS classes applied to the content area containing child controls.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setContentClass(String)

setContentClass

void setContentClass(java.lang.String contentClass)

Sets the inline CSS style to be applied to the content area containing child controls. Style is entered as for the HTML style parameter.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getContentStyle

java.lang.String getContentStyle()

Returns the inline CSS style applied to the content area containing child controls.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

See Also:

setContentStyle(String)

setContentStyle

void setContentStyle(java.lang.String contentStyle)

Sets the inline CSS style to be applied to the content area containing child controls. Style is entered as for the HTML style parameter.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

Since:

V4.4

getWidth

java.lang.String getWidth()

Control 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 width of the Control.

Supported values:

Value	Description
A specific value	As per the CSS width property e.g. 300px
Child	The minimum value: this results in the control being just as wide as it needs to be to accommodate its children.

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

Warning: when a specific value is set, any padding, border or margins will be in addition to the specified value and can cause the control to "break out" of its parent space.

Examples:

 controls.GROUPPANEL1.width = "300px";
 controls.GROUPPANEL1.width = "50%";
 controls.GROUPPANEL1.setWidth("Child");
 

Since:

V4.4

getHeaderProperties

GroupAndPageTextProperties getHeaderProperties()

Header text properties.

Since:

V4.4

getInfoProperties

GroupAndPageTextProperties getInfoProperties()

Information text properties.

Since:

V4.4

getTrailerProperties

GroupAndPageTextProperties getTrailerProperties()

Trailer text properties.

Since:

V4.4

getContentPadding

PaddingStyleProperties getContentPadding()

Content padding properties - the space between the content and its border.

Since:

V4.4

getContentText

TextStyleProperties getContentText()

Content text properties.

Since:

V4.4

getContentHeight

java.lang.String getContentHeight()

Height of the content area. 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:

setContentHeight(String)

setContentHeight

void setContentHeight(java.lang.String contentHeight)

Sets the height of the content area. As per the CSS height property.

Since:

V4.4