com.ebasetech.xi.api.controls
Interface GridControl

All Superinterfaces:

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

public interface GridControl
extends ContainerControl, BackgroundStyleProperties, BorderStyleProperties, MarginStyleProperties, TextStyleProperties

Grid Control. A Grid Control represents a grid consisting of any number of rows and columns.

Further documentation.

Method Summary

BorderStyleProperties	getCellBorder() Border properties for each cell.
java.lang.String	getColumnWidths() A comma separated list of column width percentages in the form 20%,20%,40%,20%.
java.lang.String	getGridClass() Returns the list of CSS classes applied to the table grid.
java.lang.String	getGridStyle() Returns the inline CSS style applied to the table grid.
java.lang.String	getHeight() Grid Control height.
java.lang.String	getWidth() Grid Control width.
void	setColumnWidths(java.lang.String columnWidths) Sets the widths for the grid columns.
void	setGridClass(java.lang.String gridClass) Sets one or more CSS classes to be applied to the table grid.
void	setGridStyle(java.lang.String gridStyle) Sets the inline CSS style to be applied to the table grid.
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 width of the Grid Control.

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

getGridClass

java.lang.String getGridClass()

Returns the list of CSS classes applied to the table grid. Use the cssClass property in preference to this property to style a grid.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the Grid Control Styling Assistant.

Since:

V4.4

See Also:

Control.getCssClass(), setGridClass(String)

setGridClass

void setGridClass(java.lang.String gridClass)

Sets one or more CSS classes to be applied to the table grid. Multiple classes are specified by using a space between the class names, as per the HTML class parameter. Use the cssClass property in preference to this property to style a grid.

Further documentation.

These classes are configured in the designer using the Advanced Properties button within the Grid Control Styling Assistant.

Since:

V4.4

See Also:

Control.setCssClass(String)

getGridStyle

java.lang.String getGridStyle()

Returns the inline CSS style applied to the table grid. Use the style property in preference to this property to style a grid.

Further documentation.

This inline style is configured in the designer using the Advanced Properties button within the Grid Control Styling Assistant.

Since:

V4.4

See Also:

setGridStyle(String), Control.getStyle()

setGridStyle

void setGridStyle(java.lang.String gridStyle)

Sets the inline CSS style to be applied to the table grid. 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 Grid Control Styling Assistant.

Since:

V4.4

getWidth

java.lang.String getWidth()

Grid 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 Grid 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 Grid 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 Grid Control to "break out" of its parent space.

Examples:

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

Since:

V4.4

getHeight

java.lang.String getHeight()

Grid Control 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.GRIDCONTROL1.height = "50px";
 controls.GRIDCONTROL1.setHeight("100px");
 

Since:

V4.4

getCellBorder

BorderStyleProperties getCellBorder()

Border properties for each cell.

Further documentation.

Since:

V4.4

getColumnWidths

java.lang.String getColumnWidths()

A comma separated list of column width percentages in the form 20%,20%,40%,20%.

Since:

V4.4

setColumnWidths

void setColumnWidths(java.lang.String columnWidths)

Sets the widths for the grid columns. This is specified as a comma separated list of column width percentages in the form 20%,20%,40%,20%, where a width for all columns is required.

Since:

V4.4