Package org.zkoss.zul

Class Group

  • All Implemented Interfaces:, java.lang.Cloneable, Component, Scope, ComponentCtrl

    public class Group
    extends Row
    Adds the ability for single level grouping to the Grid.

    Available in ZK PE and EE.


    1. onOpen is sent when this listgroup is opened or closed by user.

    Default getZclass(): z-group.

    Note: All the child of this component are automatically applied the group-cell CSS, if you don't want this CSS, you can invoke the HtmlBasedComponent.setSclass(String) after the child added.

    See Also:
    Serialized Form
    • Constructor Detail

      • Group

        public Group()
      • Group

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

        public Group​(java.lang.String label,
                     T value)
    • Method Detail

      • getItems

        public java.util.List<Row> getItems()
        Returns a list of all Row are grouped by this group.
      • getItemCount

        public int getItemCount()
        Returns the number of items.
      • getGroup

        public Group getGroup()
        Description copied from class: Row
        Returns the group that this row belongs to, or null.
        getGroup in class Row
      • getVisibleItemCount

        public int getVisibleItemCount()
        Returns the number of visible descendant Row.
      • getGroupfootIndex

        public int getGroupfootIndex()
        Returns the index of Groupfoot

        -1: no Groupfoot

      • getGroupfoot

        public Groupfoot getGroupfoot()
        Returns the Groupfoot, if any. Otherwise, null is returned.
      • isOpen

        public boolean isOpen()
        Returns whether this container is open.

        Default: true.

      • setOpen

        public void setOpen​(boolean open)
        Sets whether this container is open.

        Note: if you use a model as the data to render, don't use setOpen(). It'll tangle the lifecycle with model You should control the model directly. For example, you can use setClose() of GroupsModelArray

      • getImgTag

        public java.lang.String getImgTag()
        Returns the HTML IMG tag for the image part, or null if no image is assigned.

        Used only for component template, not for application developers.

      • getLabel

        public java.lang.String getLabel()
        Returns the value of the Label it contains, or null if no such cell.
      • setLabel

        public void setLabel​(java.lang.String label)
        Sets the value of the Label it contains.

        If it is not created, we automatically create it.

      • 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
        clone in class Row
        the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.