Package com.ebasetech.xi.api.controls

Interface VerticalBoxLayout

All Superinterfaces:
Layout
public interface VerticalBoxLayout
extends Layout
The VerticalBoxLayout interface represents a layout where child controls are laid out vertically. Layouts are applied to container controls.

Further documentation.

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

  • Method Summary

    Modifier and Type Method 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()
    Vertical 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)
    Vertical 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 Details

    • 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:

      ValueConstant
      ControlConstants.HORIZONTAL_ALIGNMENT_NONE
      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

    • 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:

      ValueConstant
      ControlConstants.VERTICAL_ALIGNMENT_NONE
      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_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.

      Supported values:

      ValueConstant
      ControlConstants.HORIZONTAL_ALIGNMENT_NONE
      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

    • 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. This property is only applicable when the block vertical alignment property (vAlign) is set to Fill.

      Supported values:

      ValueConstant
      ControlConstants.VERTICAL_ALIGNMENT_NONE
      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_BOTTOM);
      Since:
      V4.4

    • getSpacerSize

      java.lang.String getSpacerSize()
      Vertical 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)
      Vertical 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