Interface IColumn<I extends IAnyGroup>

    • Field Detail

      • DEFAULT

        static final IColumn<IAnyGroup> DEFAULT
        Constant for default attributes of this immutable component.
    • Method Detail

      • getWidgetClass

        default java.lang.String getWidgetClass()
        Returns the client widget class.

        Default: "zul.grid.Column"

        Specified by:
        getWidgetClass in interface IComponent<I extends IAnyGroup>
        Returns:
      • getSortDirection

        default java.lang.String getSortDirection()
        Returns the sort direction.

        Default: "natural".

      • withSortDirection

        IColumn<I> withSortDirection​(java.lang.String sortDirection)
        Returns a copy of this immutable component with the specified sortDirection.

        Sets the sort direction. This does not sort the data, it only serves as an indicator as to how the grid is sorted. (unless the grid has IGrid.isAutosort() attribute for model case)

        Parameters:
        sortDirection - One of "ascending", "descending" and "natural"

        Default: "natural".

        Returns:
        A modified copy of the this object
      • withSortDirection

        default IColumn<I> withSortDirection​(IColumn.SortDirection sortDirection)
        Returns a copy of this immutable component with the specified sortDirection.

        Sets the sort direction. This does not sort the data, it only serves as an indicator as to how the grid is sorted. (unless the grid has IGrid.isAutosort() attribute for model case)

        Parameters:
        sortDirection - One of IColumn.SortDirection

        Default: IColumn.SortDirection.NATURAL.

        Returns:
        A modified copy of the this object
      • getSortAscending

        @Nullable
        java.util.Comparator<?> getSortAscending()
        Returns the ascending sorter, or null if not available.

        Default: null

      • withSortAscending

        IColumn<I> withSortAscending​(@Nullable
                                     java.util.Comparator<?> sortAscending)
        Returns a copy of this immutable component with the specified sortAscending.

        Sets the ascending sorter, or null for no sorter for the ascending order.

        Parameters:
        sortAscending - The comparator used to sort the ascending order.

        Default: null.

        Returns:
        A modified copy of the this object
      • getSortDescending

        @Nullable
        java.util.Comparator<?> getSortDescending()
        Returns the descending sorter, or null if not available.

        Default: null

      • withSortDescending

        IColumn<I> withSortDescending​(@Nullable
                                      java.util.Comparator<?> sortDescending)
        Returns a copy of this immutable component with the specified sortDescending.

        Sets the descending sorter, or null for no sorter for the descending order.

        Parameters:
        sortDescending - The comparator used to sort the descending order.

        Default: null.

        Returns:
        A modified copy of the this object
      • withSortAscending

        default IColumn<I> withSortAscending​(java.lang.String sortAscending)
                                      throws java.lang.ClassNotFoundException,
                                             java.lang.InstantiationException,
                                             java.lang.IllegalAccessException
        Returns a copy of this immutable component with the specified sortAscending class name.

        Sets the ascending sorter with the class name, or null for no sorter for the ascending order.

        Parameters:
        sortAscending - The comparator used to sort the ascending order.

        Default: null.

        Returns:
        A modified copy of the this object
        Throws:
        java.lang.ClassNotFoundException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
      • withSortDescending

        default IColumn<I> withSortDescending​(java.lang.String sortDescending)
                                       throws java.lang.ClassNotFoundException,
                                              java.lang.InstantiationException,
                                              java.lang.IllegalAccessException
        Returns a copy of this immutable component with the specified sortDescending class name.

        Sets the descending sorter with the class name, or null for no sorter for the descending order.

        Parameters:
        sortDescending - The comparator used to sort the descending order.

        Default: null.

        Returns:
        A modified copy of the this object
        Throws:
        java.lang.ClassNotFoundException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
      • of

        static <I extends IAnyGroupIColumn<I> of​(java.lang.String label)
        Returns the instance with the given label.
        Parameters:
        label - The label belongs to this column.
      • of

        static <I extends IAnyGroupIColumn<I> of​(java.lang.String label,
                                                   java.lang.String image)
        Returns the instance with the given label and image.
        Parameters:
        label - The label that the column holds.
        image - The image that the column holds.
      • ofImage

        static <I extends IAnyGroupIColumn<I> ofImage​(java.lang.String image)
        Returns the instance with the given image.
        Parameters:
        image - The image that the column holds.
      • of

        static <I extends IAnyGroupIColumn<I> of​(java.lang.Iterable<? extends I> children)
        Returns the instance with the given any group children.
        Parameters:
        children - The children belong to any group
        See Also:
        IAnyGroup
      • of

        static <I extends IAnyGroupIColumn<I> of​(I... children)
        Returns the instance with the given any group children.
        Parameters:
        children - The children belong to any group
        See Also:
        IAnyGroup
      • ofId

        static <I extends IAnyGroupIColumn<I> ofId​(java.lang.String id)
        Returns the instance with the given id.
        Parameters:
        id - The id to identify this component