Package org.zkoss.zul

Class Listitem

    • Constructor Detail

      • Listitem

        public Listitem()

      • Listitem

        public Listitem​(java.lang.String label)

      • Listitem

        public Listitem​(java.lang.String label,
                T value)

    • Method Detail

      • getListgroup

        public Listgroup getListgroup()
        Returns the listgroup that this item belongs to, or null.
        Since:
        3.5.0

      • isSelectable

        public boolean isSelectable()
        Returns whether it is selectable.

        Default: true.

        Since:
        8.0.0

      • setSelectable

        public void setSelectable​(boolean selectable)
        Sets whether it is selectable.

        If the listbox is in a checkmark mode, the selectable state will affect the checkable icon to display or not.

        Default: true.

        Parameters:
        selectable -

      • getMaxlength

        public int getMaxlength()
        Returns the maximal length of each item's label. It is a shortcut of getParent().getMaxlength(); Thus, it works only if the listbox's mold is "select".

      • getValue

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

        Default: null.

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

        If you are using listitem with HTML Form (and with the name attribute), it is better to specify a String-typed value.

      • 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.

        If you are using listitem with HTML Form (and with the name attribute), it is better to specify a String-typed value.

      • isDisabled

        public boolean isDisabled()
        Returns whether it is disabled.

        Default: false.

      • setDisabled

        public void setDisabled​(boolean disabled)
        Sets whether it is disabled.

      • isSelected

        public boolean isSelected()
        Returns whether it is selected.

        Default: false.

      • setSelected

        public void setSelected​(boolean selected)
        Sets whether it is selected.

      • getLabel

        public java.lang.String getLabel()
        Returns the label of the Listcell it contains, or null if no such cell.

      • setLabel

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

        If it is not created, we automatically create it.

      • getImage

        public java.lang.String getImage()
        Returns the image of the Listcell it contains.

      • setImage

        public void setImage​(java.lang.String image)
        Sets the image of the Listcell it contains.

        If it is not created, we automatically create it.

      • getIndex

        public int getIndex()
        Returns the index of this item (a.k.a., the order in the listbox).

      • isLoaded

        public boolean isLoaded()
        Returns whether the content of this item is loaded. It is meaningful only if getListbox() is live data, i.e., Listbox.getModel() is not null.
        Since:
        2.4.0

      • setIndex

        protected void setIndex​(int index)

      • setVisible

        public boolean setVisible​(boolean visible)
        Description copied from interface: Component
        Sets whether this component is visible. A component is visible by default. Both visible and invisible components are rendered in a browser's DOM. But an invisible component's DOM elements with CSS display:none. Since a DOM element will inherit its parent's CSS rules, a component is visible only if all of its parents are also visible.
        To remove a component's DOM elements, use Component.detach().
        Specified by:
        setVisible in interface Component
        Overrides:
        setVisible in class AbstractComponent
        Returns:
        the previous visibility

      • getMold

        public java.lang.String getMold()
        Description copied from interface: Component
        Returns the mold used to render this component.

        Default: "default"

        Since 5.0, the default can be overridden by specify a library property. For example, if the component's class name is org.zkoss.zul.Button, then you can override the default mold by specifying the property called "org.zkoss.zul.Button.mold" with the mold you want in zk.xml. For example, 

        <library-property>
        <name>org.zkoss.zul.Button.mold</name>
        <value>trendy</value>
        </library-property>

        Notice that it doesn't affect the deriving classes. If you want to change the deriving class's default mold, you have to specify them explicitly, too.

        Specified by:
        getMold in interface Component
        Overrides:
        getMold in class AbstractComponent
        See Also:
        ComponentDefinition

      • 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()

      • addMoved

        protected void addMoved​(Component oldparent,
                        Page oldpg,
                        Page newpg)
        Description copied from class: AbstractComponent
        Called when this component is moved from the specified parent and/or page to the new page.

        Default: it notifies UiEngine to update the component at the client (usually remove-and-add).

        It is designed to let derived classes overriding this method to disable this update. However, you rarely need to override it. One possible but rare case: the component's visual part at the client updates the visual representation at the client and then notify the component at the server to update its children accordingly. In this case, it is redundant if we ask UI Engine to send the updates to client.

        Overrides:
        addMoved in class AbstractComponent
        Parameters:
        oldparent - the parent before moved. The new parent can be found by calling AbstractComponent.getParent().
        oldpg - the parent before moved.
        newpg - the new page. AbstractComponent.getPage() might return the old page.

      • getPropertyAccess

        public PropertyAccess getPropertyAccess​(java.lang.String prop)
        Description copied from interface: ComponentCtrl
        Returns the corresponding property access object from the given property name, if any.
        Specified by:
        getPropertyAccess in interface ComponentCtrl
        Overrides:
        getPropertyAccess in class XulElement
        Parameters:
        prop - the name of the property
        Returns:
        null it means not to support for the property name.

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