com.ebasetech.xi.api.controls
Interface FieldLayout

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, Layout

public interface FieldLayout
extends Layout, BorderStyleProperties, BackgroundStyleProperties

The Field Grid Layout provides specific functionality to display Field Controls in a grid structure where the label, editor and help portions of each Field Control are displayed in three separate table columns and are therefore vertically aligned. All other controls are displayed in their own table row with the three table columns merged.

Further documentation.

Since:

V4.4

See Also:

LayoutControl.getLayout()

Method Summary

java.lang.String	getCellPadding() Space between adjacent table cells.
java.lang.String	getCellSpacing() Space between adjacent table cells.
BackgroundStyleProperties	getEditorBackground() Background properties for editor table cells - used when displaying Field Controls.
java.lang.String	getEditorCellClass() Returns the list of CSS classes configured for editor table cells when displaying a Field Control.
java.lang.String	getEditorCellStyle() Returns the inline CSS style to be applied to editor table cells when displaying a Field Control.
java.lang.String	getEditorHAlign() Horizontal alignment of editor table cells - this is used when displaying Field Controls.
PaddingStyleProperties	getEditorPadding() Padding properties for editor table cells - used when displaying Field Controls.
java.lang.String	getEditorVAlign() Vertical alignment of editor table cells - this is used when displaying Field Controls.
java.lang.String	getEditorWidth() Width of editor table cells - this is used when displaying Field Controls.
java.lang.String	getFullWidthHAlign() Horizontal alignment of table cells when displaying controls other than a Field Control.
PaddingStyleProperties	getFullWidthPadding() Padding properties when displaying controls other than a Field Control.
java.lang.String	getFullWidthVAlign() Vertical alignment of table cells when displaying controls other than a Field Control.
java.lang.String	getHelpCellClass() Returns the list of CSS classes configured for help table cells when displaying a Field Control.
java.lang.String	getHelpCellStyle() Returns the inline CSS style to be applied to help table cells when displaying a Field Control.
BackgroundStyleProperties	getInfoBackground() Background properties for help table cells - used when displaying Field Controls.
java.lang.String	getInfoHAlign() Horizontal alignment of help table cells - this is used when displaying Field Controls.
PaddingStyleProperties	getInfoPadding() Padding properties for help table cells - used when displaying Field Controls.
java.lang.String	getInfoVAlign() Vertical alignment of help table cells - this is used when displaying Field Controls.
java.lang.String	getInfoWidth() Width of help table cells - this is used when displaying Field Controls.
BackgroundStyleProperties	getLabelBackground() Background properties for label table cells - used when displaying Field Controls.
java.lang.String	getLabelCellClass() Returns the list of CSS classes configured for label table cells when displaying a Field Control, or applied to the table cells containing other control types.
java.lang.String	getLabelCellStyle() Returns the inline CSS style to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types.
java.lang.String	getLabelHAlign() Horizontal alignment of label table cells - this is used when displaying Field Controls.
PaddingStyleProperties	getLabelPadding() Padding properties for label table cells - used when displaying Field Controls.
java.lang.String	getLabelVAlign() Vertical alignment of label table cells - this is used when displaying Field Controls.
java.lang.String	getLabelWidth() Width of label table cells - this is used when displaying Field Controls.
java.lang.String	getTableClass() Returns the list of CSS classes configured for the HTML table used to provide the layout.
java.lang.String	getTableStyle() Returns the inline CSS style configured for the HTML table used to provide the layout.
java.lang.String	getVAlign() Vertical alignment for all child content - all child controls are aligned as a single block.
void	setCellPadding(java.lang.String cellPadding) Space between adjacent table cells.
void	setCellSpacing(java.lang.String cellSpacing) Space between adjacent table cells.
void	setEditorCellClass(java.lang.String editorCellClass) Sets one or more CSS classes to be applied to editor table cells when displaying a Field Control.
void	setEditorCellStyle(java.lang.String editorCellStyle) Sets the inline CSS style to be applied to editor table cells when displaying a Field Control.
void	setEditorHAlign(java.lang.String editorHAlign) Sets horizontal alignment of editor table cells - this is used when displaying Field Controls.
void	setEditorVAlign(java.lang.String editorVAlign) Sets vertical alignment of editor table cells - this is used when displaying Field Controls.
void	setEditorWidth(java.lang.String editorWidth) Sets the width of editor table cells - this is used when displaying Field Controls.
void	setFullWidthHAlign(java.lang.String fullWidthHAlign) Sets horizontal alignment of table cells when displaying controls other than a Field Control.
void	setFullWidthVAlign(java.lang.String fullWidthVAlign) Sets vertical alignment of table cells when displaying controls other than a Field Control.
void	setHelpCellClass(java.lang.String helpCellClass) Sets one or more CSS classes to be applied to editor table cells when displaying a Field Control.
void	setHelpCellStyle(java.lang.String helpCellStyle) Sets the inline CSS style to be applied to help table cells when displaying a Field Control.
void	setInfoHAlign(java.lang.String infoHAlign) Sets horizontal alignment of help table cells - this is used when displaying Field Controls.
void	setInfoVAlign(java.lang.String infoVAlign) Sets vertical alignment of help table cells - this is used when displaying Field Controls.
void	setInfoWidth(java.lang.String infoWidth) Sets the width of help table cells - this is used when displaying Field Controls.
void	setLabelCellClass(java.lang.String labelCellClass) Sets one or more CSS classes to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types.
void	setLabelCellStyle(java.lang.String labelCellStyle) Sets the inline CSS style to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types.
void	setLabelHAlign(java.lang.String labelHAlign) Sets horizontal alignment of label table cells - this is used when displaying Field Controls.
void	setLabelVAlign(java.lang.String labelVAlign) Sets vertical alignment of label table cells - this is used when displaying Field Controls.
void	setLabelWidth(java.lang.String labelWidth) Sets the width of label table cells - this is used when displaying Field Controls.
void	setTableClass(java.lang.String tableClass) Sets one or more CSS classes to be applied to the HTML table used to provide the layout.
void	setTableStyle(java.lang.String tableStyle) Sets the inline CSS style to be applied to the HTML table used to provide the layout.
void	setVAlign(java.lang.String vAlign) Sets the Vertical alignment for all child content where all child controls are aligned as a single block, e.g.

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

getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat

Method Detail

getVAlign

java.lang.String getVAlign()

Vertical alignment for all child content - all child controls are aligned as a single block. See setVAlign(String) for details of supported values when setting this property.

Since:

V4.4

setVAlign

void setVAlign(java.lang.String vAlign)

Sets the Vertical alignment for all child content where all child controls are aligned as a single block, e.g. setting this property to center will place all controls as a block in the center of the container's vertical space. This property is only effective when the container is tall enough to accommodate vertical repositioning of its children e.g. the height has been set explicitly using the container's height property.

Supported values:

Value	Constant
Center	ControlConstants.VERTICAL_ALIGNMENT_CENTER
Top	ControlConstants.VERTICAL_ALIGNMENT_TOP
Bottom	ControlConstants.VERTICAL_ALIGNMENT_BOTTOM
Fill	ControlConstants.VERTICAL_ALIGNMENT_FILL

Setting a value of null removes any existing value for the property.

Example:

 controls.PANEL1.layout.setVAlign(ControlConstants.VERTICAL_ALIGNMENT_CENTER);
 

Since:

V4.4

getCellSpacing

java.lang.String getCellSpacing()

Space between adjacent table cells. This sets the cellspacing property on the HTML table implementing the layout and results in both horizontal and vertical spacing. See setCellSpacing(String) for details of supported values when setting this property.

Since:

V4.4

setCellSpacing

void setCellSpacing(java.lang.String cellSpacing)

Space between adjacent table cells. This sets the cellspacing property on the HTML table implementing the layout and results in both horizontal and vertical spacing. Any value supported by the CSS width property can be used e.g. 5px.

Since:

V4.4

getCellPadding

java.lang.String getCellPadding()

Space between adjacent table cells. This sets the cellpadding property on the HTML table implementing the layout and results in both horizontal and vertical spacing. See setCellPadding(String) for details of supported values when setting this property.

Since:

V4.4

setCellPadding

void setCellPadding(java.lang.String cellPadding)

Space between adjacent table cells. This sets the cellpadding property on the HTML table implementing the layout and results in both horizontal and vertical spacing. Any value supported by the CSS width property can be used e.g. 5px.

Since:

V4.4

getLabelWidth

java.lang.String getLabelWidth()

Width of label table cells - this is used when displaying Field Controls. See setLabelWidth(String) for details of supported values when setting this property.

Since:

V4.4

setLabelWidth

void setLabelWidth(java.lang.String labelWidth)

Sets the width of label table cells - this is used when displaying Field Controls. Any value supported by the CSS width property can be used e.g. 30%.

Since:

V4.4

getEditorWidth

java.lang.String getEditorWidth()

Width of editor table cells - this is used when displaying Field Controls. See setEditorWidth(String) for details of supported values when setting this property.

Since:

V4.4

setEditorWidth

void setEditorWidth(java.lang.String editorWidth)

Sets the width of editor table cells - this is used when displaying Field Controls. Any value supported by the CSS width property can be used e.g. 30%.

Since:

V4.4

getInfoWidth

java.lang.String getInfoWidth()

Width of help table cells - this is used when displaying Field Controls. See setInfoWidth(String) for details of supported values when setting this property.

Since:

V4.4

setInfoWidth

void setInfoWidth(java.lang.String infoWidth)

Sets the width of help table cells - this is used when displaying Field Controls. Any value supported by the CSS width property can be used e.g. 30%.

Since:

V4.4

getLabelBackground

BackgroundStyleProperties getLabelBackground()

Background properties for label table cells - used when displaying Field Controls.

Since:

V4.4

getEditorBackground

BackgroundStyleProperties getEditorBackground()

Background properties for editor table cells - used when displaying Field Controls.

Since:

V4.4

getInfoBackground

BackgroundStyleProperties getInfoBackground()

Background properties for help table cells - used when displaying Field Controls.

Since:

V4.4

getLabelHAlign

java.lang.String getLabelHAlign()

Horizontal alignment of label table cells - this is used when displaying Field Controls. See setLabelHAlign(String) for details of supported values when setting this property.

Since:

V4.4

setLabelHAlign

void setLabelHAlign(java.lang.String labelHAlign)

Sets horizontal alignment of label table cells - this is used when displaying Field Controls.

Supported values:

Value	Constant
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT

Since:

V4.4

getEditorHAlign

java.lang.String getEditorHAlign()

Horizontal alignment of editor table cells - this is used when displaying Field Controls. See setEditorHAlign(String) for details of supported values when setting this property.

Since:

V4.4

setEditorHAlign

void setEditorHAlign(java.lang.String editorHAlign)

Sets horizontal alignment of editor table cells - this is used when displaying Field Controls.

Supported values:

Value	Constant
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT

Since:

V4.4

getInfoHAlign

java.lang.String getInfoHAlign()

Horizontal alignment of help table cells - this is used when displaying Field Controls. See setInfoHAlign(String) for details of supported values when setting this property.

Since:

V4.4

setInfoHAlign

void setInfoHAlign(java.lang.String infoHAlign)

Sets horizontal alignment of help table cells - this is used when displaying Field Controls.

Supported values:

Value	Constant
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT

Since:

V4.4

getFullWidthHAlign

java.lang.String getFullWidthHAlign()

Horizontal alignment of table cells when displaying controls other than a Field Control. See setFullWidthHAlign(String) for details of supported values when setting this property.

Since:

V4.4

setFullWidthHAlign

void setFullWidthHAlign(java.lang.String fullWidthHAlign)

Sets horizontal alignment of table cells when displaying controls other than a Field Control.

Supported values:

Value	Constant
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT

Since:

V4.4

getLabelVAlign

java.lang.String getLabelVAlign()

Vertical alignment of label table cells - this is used when displaying Field Controls. See setLabelVAlign(String) for details of supported values when setting this property.

Since:

V4.4

setLabelVAlign

void setLabelVAlign(java.lang.String labelVAlign)

Sets vertical alignment of label table cells - this is used when displaying Field Controls.

Supported values:

Value	Constant
Center	ControlConstants.VERTICAL_ALIGNMENT_CENTER
Top	ControlConstants.VERTICAL_ALIGNMENT_TOP
Bottom	ControlConstants.VERTICAL_ALIGNMENT_BOTTOM

Since:

V4.4

getEditorVAlign

java.lang.String getEditorVAlign()

Vertical alignment of editor table cells - this is used when displaying Field Controls. See setEditorVAlign(String) for details of supported values when setting this property.

Since:

V4.4

setEditorVAlign

void setEditorVAlign(java.lang.String editorVAlign)

Sets vertical alignment of editor table cells - this is used when displaying Field Controls.

Supported values:

Value	Constant
Center	ControlConstants.VERTICAL_ALIGNMENT_CENTER
Top	ControlConstants.VERTICAL_ALIGNMENT_TOP
Bottom	ControlConstants.VERTICAL_ALIGNMENT_BOTTOM

Since:

V4.4

getInfoVAlign

java.lang.String getInfoVAlign()

Vertical alignment of help table cells - this is used when displaying Field Controls. See setInfoVAlign(String) for details of supported values when setting this property.

Since:

V4.4

setInfoVAlign

void setInfoVAlign(java.lang.String infoVAlign)

Sets vertical alignment of help table cells - this is used when displaying Field Controls.

Supported values:

Value	Constant
Center	ControlConstants.VERTICAL_ALIGNMENT_CENTER
Top	ControlConstants.VERTICAL_ALIGNMENT_TOP
Bottom	ControlConstants.VERTICAL_ALIGNMENT_BOTTOM

Since:

V4.4

getFullWidthVAlign

java.lang.String getFullWidthVAlign()

Vertical alignment of table cells when displaying controls other than a Field Control. See setFullWidthVAlign(String) for details of supported values when setting this property.

Since:

V4.4

setFullWidthVAlign

void setFullWidthVAlign(java.lang.String fullWidthVAlign)

Sets vertical alignment of table cells when displaying controls other than a Field Control.

Supported values:

Value	Constant
Center	ControlConstants.VERTICAL_ALIGNMENT_CENTER
Top	ControlConstants.VERTICAL_ALIGNMENT_TOP
Bottom	ControlConstants.VERTICAL_ALIGNMENT_BOTTOM

Since:

V4.4

getLabelPadding

PaddingStyleProperties getLabelPadding()

Padding properties for label table cells - used when displaying Field Controls.

Since:

V4.4

getEditorPadding

PaddingStyleProperties getEditorPadding()

Padding properties for editor table cells - used when displaying Field Controls.

Since:

V4.4

getInfoPadding

PaddingStyleProperties getInfoPadding()

Padding properties for help table cells - used when displaying Field Controls.

Since:

V4.4

getFullWidthPadding

PaddingStyleProperties getFullWidthPadding()

Padding properties when displaying controls other than a Field Control.

Since:

V4.4

getTableClass

java.lang.String getTableClass()

Returns the list of CSS classes configured for the HTML table used to provide the layout.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

See Also:

setTableClass(String)

setTableClass

void setTableClass(java.lang.String tableClass)

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

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

getTableStyle

java.lang.String getTableStyle()

Returns the inline CSS style configured for the HTML table used to provide the layout.

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

Further documentation.

Since:

V4.4

See Also:

setTableStyle(String)

setTableStyle

void setTableStyle(java.lang.String tableStyle)

Sets the inline CSS style to be applied to the HTML table used to provide the layout. Style is entered as for the HTML style parameter.

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

Further documentation.

Since:

V4.4

getLabelCellClass

java.lang.String getLabelCellClass()

Returns the list of CSS classes configured for label table cells when displaying a Field Control, or applied to the table cells containing other control types. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

See Also:

setLabelCellClass(String)

setLabelCellClass

void setLabelCellClass(java.lang.String labelCellClass)

Sets one or more CSS classes to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

getLabelCellStyle

java.lang.String getLabelCellStyle()

Returns the inline CSS style to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types.

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

Further documentation.

Since:

V4.4

See Also:

setLabelCellStyle(String)

setLabelCellStyle

void setLabelCellStyle(java.lang.String labelCellStyle)

Sets the inline CSS style to be applied to label table cells when displaying a Field Control, or applied to the table cells containing other control types. Style is entered as for the HTML style parameter.

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

Further documentation.

Since:

V4.4

getEditorCellClass

java.lang.String getEditorCellClass()

Returns the list of CSS classes configured for editor table cells when displaying a Field Control. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

See Also:

setEditorCellClass(String)

setEditorCellClass

void setEditorCellClass(java.lang.String editorCellClass)

Sets one or more CSS classes to be applied to editor table cells when displaying a Field Control. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

getEditorCellStyle

java.lang.String getEditorCellStyle()

Returns the inline CSS style to be applied to editor table cells when displaying a Field Control.

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

Further documentation.

Since:

V4.4

See Also:

setEditorCellStyle(String)

setEditorCellStyle

void setEditorCellStyle(java.lang.String editorCellStyle)

Sets the inline CSS style to be applied to editor table cells when displaying a Field Control. Style is entered as for the HTML style parameter.

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

Further documentation.

Since:

V4.4

getHelpCellClass

java.lang.String getHelpCellClass()

Returns the list of CSS classes configured for help table cells when displaying a Field Control. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

See Also:

setHelpCellClass(String)

setHelpCellClass

void setHelpCellClass(java.lang.String helpCellClass)

Sets one or more CSS classes to be applied to editor table cells when displaying a Field Control. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the layout properties Styling Assistant.

Further documentation.

Since:

V4.4

getHelpCellStyle

java.lang.String getHelpCellStyle()

Returns the inline CSS style to be applied to help table cells when displaying a Field Control.

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

Further documentation.

Since:

V4.4

See Also:

setEditorCellStyle(String)

setHelpCellStyle

void setHelpCellStyle(java.lang.String helpCellStyle)

Sets the inline CSS style to be applied to help table cells when displaying a Field Control. Style is entered as for the HTML style parameter.

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

Further documentation.

Since:

V4.4