Package org.zkoss.zul

Class Treecol

    • Constructor Detail

      • Treecol

        public Treecol()
      • Treecol

        public Treecol​(java.lang.String label)
      • Treecol

        public Treecol​(java.lang.String label,
                       java.lang.String src)
      • Treecol

        public Treecol​(java.lang.String label,
                       java.lang.String src,
                       java.lang.String width)
    • Method Detail

      • getTree

        public Tree getTree()
        Returns the tree that it belongs to.
      • getSortDirection

        public java.lang.String getSortDirection()
        Returns the sort direction.
        Since:
        5.0.6

        Default: "natural".

      • setSortDirection

        public void setSortDirection​(java.lang.String sortDir)
                              throws WrongValueException
        Sets the sort direction. This does not sort the data, it only serves as an indicator as to how the tree is sorted. (unless the tree has "autosort" attribute)

        If you use sort(boolean) to sort treechildren (Treeitem), the sort direction is maintained automatically. If you want to sort it in customized way, you have to set the sort direction manually.

        Parameters:
        sortDir - one of "ascending", "descending" and "natural"
        Throws:
        WrongValueException
        Since:
        5.0.6
      • getSortAscending

        public java.util.Comparator<?> getSortAscending()
        Returns the ascending sorter, or null if not available.
        Since:
        5.0.6
      • setSortAscending

        public void setSortAscending​(java.util.Comparator<?> sorter)
        Sets the ascending sorter, or null for no sorter for the ascending order.
        Parameters:
        sorter - the comparator used to sort the ascending order.
        Since:
        5.0.6
      • setSortAscending

        public void setSortAscending​(java.lang.String clsnm)
                              throws java.lang.ClassNotFoundException,
                                     java.lang.InstantiationException,
                                     java.lang.IllegalAccessException
        Sets the ascending sorter with the class name, or null for no sorter for the ascending order.
        Throws:
        java.lang.ClassNotFoundException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        Since:
        5.0.6
      • getSortDescending

        public java.util.Comparator<?> getSortDescending()
        Returns the descending sorter, or null if not available.
        Since:
        5.0.6
      • setSortDescending

        public void setSortDescending​(java.util.Comparator<?> sorter)
        Sets the descending sorter, or null for no sorter for the descending order.
        Parameters:
        sorter - the comparator used to sort the ascending order.
        Since:
        5.0.6
      • setSortDescending

        public void setSortDescending​(java.lang.String clsnm)
                               throws java.lang.ClassNotFoundException,
                                      java.lang.InstantiationException,
                                      java.lang.IllegalAccessException
        Sets the descending sorter with the class name, or null for no sorter for the descending order.
        Throws:
        java.lang.ClassNotFoundException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        Since:
        5.0.6
      • getMaxlength

        public int getMaxlength()
        Returns the maximal length of each item's label.

        Default: 0 (no limit).

      • setMaxlength

        public void setMaxlength​(int maxlength)
        Sets the maximal length of each item's label.

        Default: 0 (no limit).

        Notice that maxlength will be applied to this header and all listcell of the same column.

      • getColumnIndex

        public int getColumnIndex()
        Returns the column index, starting from 0.
      • sort

        public boolean sort​(boolean ascending,
                            boolean force)
        Sorts the treechildren (Treeitem) based on getSortAscending() and getSortDescending().
        Parameters:
        ascending - whether to use getSortAscending(). If the corresponding comparator is not set, it returns false and does nothing.
        force - whether to enforce the sorting no matter what the sort direction (getSortDirection()) is. If false, this method is the same as sort(boolean).
        Returns:
        whether the treechildren are sorted.
        Since:
        5.0.6
      • clone

        public java.lang.Object clone()
        Description copied from interface: Component
        Clones the component. All of its children and descendants are cloned. Also, ID are preserved.
        Specified by:
        clone in interface Component
        Overrides:
        clone in class LabelImageElement
        Returns:
        the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.