Interface IComboitem

    • Field Detail

      • DEFAULT

        static final IComboitem DEFAULT
        Constant for default attributes of this immutable component.
    • Method Detail

      • getWidgetClass

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

        Default: "zul.inp.Comboitem"

        Specified by:
        getWidgetClass in interface IComponent<IComboitem>
      • getDescription

        default java.lang.String getDescription()
        Returns the description (never null). The description is used to provide extra information such that users is easy to make a selection.

        Default: "".

      • withDescription

        IComboitem withDescription​(java.lang.String description)
        Returns a copy of this immutable component with the specified description.

        Sets the description.

        Parameters:
        description - The description of the comboitem.

        Default: "".

        Returns:
        A modified copy of the this object
      • getContent

        default java.lang.String getContent()
        Returns the embedded content (i.e., HTML tags) that is shown as part of the description.

        It is useful to show the description in more versatile way.

        Default: ""

        See Also:
        getDescription()
      • withContent

        IComboitem withContent​(java.lang.String content)
        Returns a copy of this immutable component with the specified content.

        Sets the embedded content (i.e., HTML tags) that is shown as part of the description.

        It is useful to show the description in more versatile way.

        Default: "".

        Security Note

        Unlike other methods, the content assigned to this method is generated directly to the browser without escaping. Thus, it is better not to have something input by the user to avoid any XSS attach.

        Note: the content is sanitized by default to avoid XSS attack, and please don't use JavaScript in the content.

        Parameters:
        content - The embedded content of the comboitem to display

        Default: "".

        Returns:
        A modified copy of the this object
      • of

        static IComboitem of​(java.lang.String label)
        Returns the instance with the given label
        Parameters:
        label - The label of the comboitem
      • of

        static IComboitem of​(java.lang.String label,
                             java.lang.String image)
        Returns the instance with the given label and image
        Parameters:
        label - The label of the comboitem
        image - The image of the comboitem
      • ofImage

        static IComboitem ofImage​(java.lang.String image)
        Returns the instance with the given image
        Parameters:
        image - The image of the comboitem
      • ofId

        static IComboitem ofId​(java.lang.String id)
        Returns the instance with the given id.
        Parameters:
        id - The id to identify this component