Package com.ebasetech.xi.api.controls

Interface ColumnLayout

All Superinterfaces:
Layout
public interface ColumnLayout
extends Layout
A Column Layout displays child controls in a grid formation where each child control is placed in the next available table cell e.g. if the Column Layout has two columns, the first control is displayed in row 1 column 1, the second in row 1 column 2, the third in row2 column1, the fourth in row2 column2 etc. The number of columns can be configured.

Further documentation.

Since:
V4.4
See Also:
LayoutControl.getLayout()

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getCellHAlign()
    Horizontal alignment for each control within its containing table cell.
    PaddingStyleProperties getCellPadding()
    Padding properties for each table cell.
    java.lang.String getCellVAlign()
    Vertical alignment for each control within its containing table cell.
    int getColumns()
    Number of columns in each row of the layout.
    java.lang.String getHAlign()
    Horizontal alignment for all child controls of the container as a whole e.g.
    java.lang.String getLayoutClass()
    Returns the list of CSS classes applied to each table cell within the layout.
    java.lang.String getLayoutStyle()
    Returns the inline CSS style applied to each table cell within the layout.
    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 controls of the container as a whole e.g.
    void setCellHAlign​(java.lang.String cellHAlign)
    Sets the horizontal alignment for each control within its containing table cell.
    void setCellVAlign​(java.lang.String cellVAlign)
    Sets the vertical alignment for each control within its containing table cell.
    void setColumns​(int columns)
    Set the number of columns in each row of the layout.
    void setHAlign​(java.lang.String hAlign)
    Sets the horizontal alignment for all child controls of the container as a whole e.g.
    void setLayoutClass​(java.lang.String layoutClass)
    Sets one or more CSS classes to be applied to each table cell within the layout.
    void setLayoutStyle​(java.lang.String layoutStyle)
    Sets the inline CSS style to be applied to each table cell within the layout.
    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 controls of the container as a whole e.g.

  • Method Details

    • getHAlign

      java.lang.String getHAlign()
      Horizontal alignment for all child controls of the container as a whole e.g. setting this property to Center will place all controls in the center of the container's horizontal space. See setHAlign(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4
      See Also:
      getCellHAlign()

    • setHAlign

      void setHAlign​(java.lang.String hAlign)
      Sets the horizontal alignment for all child controls of the container as a whole e.g. setting this property to Center will place all controls in the center of the container's horizontal space. Use the setCellHAlign(String) method to align each control within its containing table cell.

      Supported values:

      ValueConstant
      CenterControlConstants.HORIZONTAL_ALIGNMENT_CENTER
      LeftControlConstants.HORIZONTAL_ALIGNMENT_LEFT
      RightControlConstants.HORIZONTAL_ALIGNMENT_RIGHT
      FillControlConstants.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
      See Also:
      setCellHAlign(String)

    • getCellHAlign

      java.lang.String getCellHAlign()
      Horizontal alignment for each 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 control within its containing table cell.

      Supported values:

      ValueConstant
      CenterControlConstants.HORIZONTAL_ALIGNMENT_CENTER
      LeftControlConstants.HORIZONTAL_ALIGNMENT_LEFT
      RightControlConstants.HORIZONTAL_ALIGNMENT_RIGHT
      FillControlConstants.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

    • getVAlign

      java.lang.String getVAlign()
      Vertical alignment for all child controls of the container as a whole e.g. setting this property to Center will place all controls in the center of the container's vertical space. See setVAlign(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4
      See Also:
      getCellVAlign()

    • setVAlign

      void setVAlign​(java.lang.String vAlign)
      Sets the vertical alignment for all child controls of the container as a whole e.g. setting this property to Center will place all controls in the center of the container's vertical space. Use the setCellVAlign(String) method to align each control within its containing table cell.

      Supported values:

      ValueConstant
      CenterControlConstants.VERTICAL_ALIGNMENT_CENTER
      TopControlConstants.VERTICAL_ALIGNMENT_TOP
      BottomControlConstants.VERTICAL_ALIGNMENT_BOTTOM
      FillControlConstants.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_CENTER);
      Since:
      V4.4
      See Also:
      setCellVAlign(String)

    • getCellVAlign

      java.lang.String getCellVAlign()
      Vertical alignment for each 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 control within its containing table cell.

      Supported values:

      ValueConstant
      CenterControlConstants.VERTICAL_ALIGNMENT_CENTER
      TopControlConstants.VERTICAL_ALIGNMENT_TOP
      BottomControlConstants.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_CENTER);
      Since:
      V4.4

    • getCellPadding

      PaddingStyleProperties getCellPadding()
      Padding properties for each table cell.
      Since:
      V4.4

    • getColumns

      int getColumns()
      Number of columns in each row of the layout.

      Further documentation.

      Since:
      V4.4

    • setColumns

      void setColumns​(int columns)
      Set the number of columns in each row of the layout.

      Further documentation.

      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.

      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.

      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.

      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.

      Since:
      V4.4

    • getLayoutClass

      java.lang.String getLayoutClass()
      Returns the list of CSS classes applied to each table cell within the layout.

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

      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 table cell within 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.

      Since:
      V4.4

    • getLayoutStyle

      java.lang.String getLayoutStyle()
      Returns the inline CSS style applied to each table cell within the layout.

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

      Since:
      V4.4
      See Also:
      setLayoutStyle(String)

    • setLayoutStyle

      void setLayoutStyle​(java.lang.String layoutStyle)
      Sets the inline CSS style to be applied to each table cell within 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.

      Since:
      V4.4