Package org.zkoss.zul

Class Listhead

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl
    public class Listhead
extends HeadersElement
    A list headers used to define multi-columns and/or headers.

    Difference from XUL:

    1. There is no listcols in ZUL because it is merged into Listhead. Reason: easier to write Listbox.

    Default getZclass(): z-listhead.(since 5.0.0)

    Author:
    tomyeh
    See Also:
    Serialized Form

    • Constructor Detail

      • Listhead

        public Listhead()

    • Method Detail

      • setColumnshide

        public void setColumnshide​(boolean columnshide)
        Sets whether to enable hiding of listheader with the header context menu.

        Note that it is only applied when getMenupopup() is auto.

        Since:
        6.5.0

      • isColumnshide

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

        Default: true.

        Since:
        6.5.0

      • setColumnsgroup

        public void setColumnsgroup​(boolean columnsgroup)
        Sets whether to enable grouping of listheader with the header context menu.

        Note that it is only applied when getMenupopup() is auto.

        Since:
        6.5.0

      • isColumnsgroup

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

        Default: true.

        Since:
        6.5.0

      • getMenupopup

        public java.lang.String getMenupopup()
        Returns the ID of the Menupopup (Menupopup) that should appear when the user clicks on the element.

        Default: none (a default menupoppup).

        Since:
        6.5.0

      • setMenupopup

        public void setMenupopup​(java.lang.String mpop)
        Sets the ID of the menupopup (Menupopup) that should appear when the user clicks on the element of each column.

        An onOpen event is sent to the popup menu if it is going to appear. Therefore, developers can manipulate it dynamically (perhaps based on OpenEvent.getReference) by listening to the onOpen event.

        Note: To simplify the use, it ignores the ID space when locating the component at the client. In other words, it searches for the first component with the specified ID, no matter it is in the same ID space or not.

        If there are two components with the same ID (of course, in different ID spaces), you can specify the UUID with the following format:
        uuid(comp_uuid)

        Parameters:
        mpop - an ID of the menupopup component, "none", or "auto". "none" is assumed by default, "auto" means the menupopup component is created automatically.
        Since:
        6.5.0
        See Also:
        setMenupopup(String)

      • getValue

        public <T> T getValue()
        Returns the value.

        Default: null.

        Note: the value is application dependent, you can place whatever value you want.

        Since:
        3.6.0

      • setValue

        public <T> void setValue​(T value)
        Sets the value.
        Parameters:
        value - the value.

        Note: the value is application dependent, you can place whatever value you want.

        Since:
        3.6.0

      • setHflex

        public void setHflex​(java.lang.String flex)
        Deprecated.
        as of release 6.0.0. To control the size of Listbox related components, please refer to Listbox and Listheader instead.
        Description copied from class: HtmlBasedComponent
        Sets horizontal flex hint of this component.

        Number flex indicates how this component's container distributes remaining empty space among its children horizontally. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.

        Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.

        Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.

        Overrides:
        setHflex in class HtmlBasedComponent
        Parameters:
        flex - horizontal flex hint of this component.
        See Also:
        HtmlBasedComponent.setVflex(java.lang.String), HtmlBasedComponent.getHflex()