com.ebasetech.xi.api.controls

Interface HorizontalBoxLayout

All Superinterfaces:

Layout

public interface HorizontalBoxLayout
extends Layout

The HorizontalBoxLayout interface represents a layout where child controls are laid out horizontally. Layouts are applied to container controls.

Further documentation.

Since:

V4.4

See Also:

LayoutControl.getLayout()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCellHAlign() Horizontal alignment for each child control within its containing table cell.
java.lang.String	getCellVAlign() Vertical alignment for each child control within its containing table cell.
java.lang.String	getHAlign() Horizontal alignment for all child content - all child controls are aligned as a single block.
java.lang.String	getLayoutClass() Returns the list of CSS classes configured for each cell of the HTML table used to provide the layout.
java.lang.String	getLayoutStyle() Returns the inline CSS style configured for each cell of the HTML table used to provide the layout.
java.lang.String	getSpacerSize() Horizontal spacing between adjacent 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	setCellHAlign(java.lang.String cellHAlign) Sets the horizontal alignment for each child control within its containing table cell.
void	setCellVAlign(java.lang.String cellVAlign) Sets the vertical alignment for each child control within its containing table cell.
void	setHAlign(java.lang.String hAlign) Sets the horizontal alignment for all child content where all child controls are aligned as a single block.
void	setLayoutClass(java.lang.String layoutClass) Sets one or more CSS classes to be applied to each cell of the HTML table used to provide the layout.
void	setLayoutStyle(java.lang.String layoutStyle) Sets the inline CSS style to be applied to each cell of the HTML table used to provide the layout.
void	setSpacerSize(java.lang.String spacerSize) Horizontal spacing between adjacent 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.

Method Detail

getSpacerSize

java.lang.String getSpacerSize()

Horizontal spacing between adjacent controls. See setSpacerSize(String) for details of supported values when setting this property.

Since:

V4.4

setSpacerSize

void setSpacerSize(java.lang.String spacerSize)

Horizontal spacing between adjacent controls. Any value supported by the CSS font-size property can be used e.g. 30px.

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

getLayoutClass

java.lang.String getLayoutClass()

Returns the list of CSS classes configured for each cell of 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:

setLayoutClass(String)

setLayoutClass

void setLayoutClass(java.lang.String layoutClass)

Sets one or more CSS classes to be applied to each cell of 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

getLayoutStyle

java.lang.String getLayoutStyle()

Returns the inline CSS style configured for each cell of 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:

setLayoutStyle(String)

setLayoutStyle

void setLayoutStyle(java.lang.String layoutStyle)

Sets the inline CSS style to be applied to each cell of 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

getHAlign

java.lang.String getHAlign()

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

Further documentation.

Since:

V4.4

setHAlign

void setHAlign(java.lang.String hAlign)

Sets the horizontal alignment for all child content where all child controls are aligned as a single block.

Supported values:

Value	Constant
	ControlConstants.HORIZONTAL_ALIGNMENT_NONE
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT
Fill	ControlConstants.HORIZONTAL_ALIGNMENT_FILL

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

Further documentation.

Example:

 controls.PANEL1.layout.setHAlign(ControlConstants.HORIZONTAL_ALIGNMENT_CENTER);
 

Since:

V4.4

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.

Further documentation.

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.

Supported values:

Value	Constant
	ControlConstants.VERTICAL_ALIGNMENT_NONE
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.

Further documentation.

Example:

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

Since:

V4.4

getCellHAlign

java.lang.String getCellHAlign()

Horizontal alignment for each child control within its containing table cell. See setCellHAlign(String) for details of supported values when setting this property.

Further documentation.

Since:

V4.4

setCellHAlign

void setCellHAlign(java.lang.String cellHAlign)

Sets the horizontal alignment for each child control within its containing table cell. This property is only applicable when the block horizontal alignment property (hAlign) is set to Fill.

Supported values:

Value	Constant
	ControlConstants.HORIZONTAL_ALIGNMENT_NONE
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT
Fill	ControlConstants.HORIZONTAL_ALIGNMENT_FILL

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

Further documentation.

Example:

 controls.PANEL1.layout.setCellHAlign(ControlConstants.HORIZONTAL_ALIGNMENT_CENTER);
 

Since:

V4.4

getCellVAlign

java.lang.String getCellVAlign()

Vertical alignment for each child control within its containing table cell. See setCellVAlign(String) for details of supported values when setting this property.

Further documentation.

Since:

V4.4

setCellVAlign

void setCellVAlign(java.lang.String cellVAlign)

Sets the vertical alignment for each child control within its containing table cell.

Supported values:

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

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

Further documentation.

Example:

 controls.PANEL1.layout.setCellVAlign(ControlConstants.VERTICAL_ALIGNMENT_BOTTOM);
 

Since:

V4.4