Package org.zkoss.stateless.sul

Interface IColumns

All Superinterfaces:
IChildable<IColumns,IColumn<IAnyGroup>>, IComponent<IColumns>, IGridComposite<IColumns>, IHeadersElement<IColumns>, IHtmlBasedComponent<IColumns>, IMeshComposite<IColumns>, IXulElement<IColumns>
public interface IColumns extends IHeadersElement<IColumns>, IChildable<IColumns,IColumn<IAnyGroup>>, IGridComposite<IColumns>
Immutable Columns component

Defines the columns of a grid. Each child of a columns element should be a IColumn element.

Author:
katherine
See Also:
  • Columns

  • Field Details

    • DEFAULT

      static final IColumns DEFAULT
      Constant for default attributes of this immutable component.

  • Method Details

    • getWidgetClass

      default String getWidgetClass()
      Returns the client widget class.

      Default: "zul.grid.Columns"

      Specified by:
      getWidgetClass in interface IComponent<IColumns>

    • getWidth

      @Derived @Nullable default String getWidth()
      Description copied from interface: IHtmlBasedComponent
      Returns the width of the component. If not specified, null is assumed.

      Default: null

      Specified by:
      getWidth in interface IHtmlBasedComponent<IColumns>

    • withWidth

      default IColumns withWidth(@Nullable String width)
      To control the size of Foot related components, please refer to IGrid and IColumn instead.
      Specified by:
      withWidth in interface IHtmlBasedComponent<IColumns>
      Parameters:
      width - The width of the component.

      Default: null

      Returns:
      A modified copy of the this object

    • getHflex

      @Derived @Nullable default String getHflex()
      Description copied from interface: IHtmlBasedComponent
      Return horizontal flex hint of this component.

      Default: null

      Specified by:
      getHflex in interface IHtmlBasedComponent<IColumns>

    • withHflex

      default IColumns withHflex(@Nullable String hflex)
      To control the size of Foot related components, please refer to IGrid and IColumn instead.
      Specified by:
      withHflex in interface IHtmlBasedComponent<IColumns>
      Parameters:
      hflex - The horizontal flex hint.

      Default: null

      Returns:
      A modified copy of the this object

    • isColumnshide

      default boolean isColumnshide()
      Returns whether to enable hiding of columns with the header context menu.

      Default: true.

    • withColumnshide

      IColumns withColumnshide(boolean columnshide)
      Returns a copy of this immutable component with the specified columnshide.

      Sets whether to enable hiding of columns with the header context menu.

      Parameters:
      columnshide - Whether to enable hiding of columns with the header context menu.

      Default: true.

      Returns:
      A modified copy of the this object

    • isColumnsgroup

      default boolean isColumnsgroup()
      Returns whether to enable grouping of columns with the header context menu.

      Default: true.

    • withColumnsgroup

      IColumns withColumnsgroup(boolean columnsgroup)
      Returns a copy of this immutable component with the specified columnsgroup.

      Sets whether to enable grouping of columns with the header context menu.

      Parameters:
      columnsgroup - Whether to enable grouping of columns with the header context menu.

      Default: true.

      Returns:
      A modified copy of the this object

    • getMenupopup

      default String getMenupopup()
      Returns the ID of the Menupopup (IMenupopup) that should appear when the user clicks on the element.

      Default: "none" (a default menupopup).

    • withMenupopup

      IColumns withMenupopup(String menupopup)
      Returns a copy of this immutable component with the specified menupopup.

      Sets the ID of the menupopup (IMenupopup) that should appear when the user clicks on the element of each column.

      Parameters:
      menupopup - The ID of the menupopup (IMenupopup) that should appear when the user clicks on the element of each column.

      Default: "none".

      Returns:
      A modified copy of the this object

    • of

      static IColumns of(Iterable<? extends IColumn<IAnyGroup>> children)
      Returns the instance with the given IColumn children.
      Parameters:
      children - The children of IColumn

    • of

      static IColumns of(IColumn<IAnyGroup>... children)
      Returns the instance with the given IColumn children.
      Parameters:
      children - The children of IColumn

    • ofId

      static IColumns ofId(String id)
      Returns the instance with the given id.
      Parameters:
      id - The id to identify this component

    • renderProperties

      default void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
      Internal use
      Specified by:
      renderProperties in interface IComponent<IColumns>
      Specified by:
      renderProperties in interface IHeadersElement<IColumns>
      Specified by:
      renderProperties in interface IHtmlBasedComponent<IColumns>
      Specified by:
      renderProperties in interface IXulElement<IColumns>
      Parameters:
      renderer -
      Throws:
      IOException