Interface ILineitem<I extends IAnyGroup>

    • Field Detail

      • DEFAULT

        static final ILineitem<IAnyGroup> DEFAULT
        Constant for default attributes of this immutable component.
    • Method Detail

      • getWidgetClass

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

        Default: "zkmax.layout.Lineitem"

        Specified by:
        getWidgetClass in interface IComponent<I extends IAnyGroup>
      • getPointStyle

        @Nullable
        java.lang.String getPointStyle()
        Returns the CSS style for the point.

        Default: null

      • withPointStyle

        ILineitem<I> withPointStyle​(@Nullable
                                    java.lang.String pointStyle)
        Returns a copy of this immutable component with the specified pointStyle.

        Sets the pointStyle.

        Parameters:
        pointStyle - Sets the pointStyle.

        Default: null.

        Returns:
        A modified copy of the this object
      • getPointIconSclass

        @Nullable
        java.lang.String getPointIconSclass()
        Returns the iconSclass name of this point.
      • withPointIconSclass

        ILineitem<I> withPointIconSclass​(@Nullable
                                         java.lang.String pointIconSclass)
        Returns a copy of this immutable component with the specified pointIconSclass.

        Sets the pointIconSclass name of the point.

        Parameters:
        pointIconSclass - Sets the pointStyle.

        Default: null.

        Returns:
        A modified copy of the this object
      • getFrontSpace

        @Nullable
        java.lang.String getFrontSpace()
        Returns the spacing with the previous lineitem.
      • withFrontSpace

        ILineitem<I> withFrontSpace​(@Nullable
                                    java.lang.String frontSpace)
        Returns a copy of this immutable component with the specified frontSpace.

        Sets the spacing with the previous lineitem.

        Parameters:
        frontSpace - the spacing with the previous lineitem. (such as "5px" or "5em"). If null or empty (""), the default spacing is used (i.e., controlled by CSS alone).

        Default: null.

        Returns:
        A modified copy of the this object
      • getBackSpace

        @Nullable
        java.lang.String getBackSpace()
        Returns the spacing with the next lineitem.
      • withBackSpace

        ILineitem<I> withBackSpace​(@Nullable
                                   java.lang.String backSpace)
        Returns a copy of this immutable component with the specified backSpace.

        Sets the spacing with the next lineitem.

        Parameters:
        backSpace - the spacing with the next lineitem. (such as "5px" or "5em"). If null or empty (""), the default spacing is used (i.e., controlled by CSS alone).

        Default: null.

        Returns:
        A modified copy of the this object
      • isPointVisible

        default boolean isPointVisible()
        Returns whether the point is visible.

        Default: true.

      • withPointVisible

        ILineitem<I> withPointVisible​(boolean pointVisible)
        Returns a copy of this immutable component with the specified pointVisible.

        Sets whether the point is visible.

        Parameters:
        pointVisible - Whether the point is visible.

        Default: true.

        Returns:
        A modified copy of the this object
      • isOpposite

        default boolean isOpposite()
        Returns whether the first child is displayed in the first area(left/top).

        Default: false.

      • withOpposite

        ILineitem<I> withOpposite​(boolean opposite)
        Returns a copy of this immutable component with the specified opposite.

        Sets whether the first child is displayed in the first area(left/top).

        Parameters:
        opposite - Whether the first child is displayed in the first area(left/top).

        Default: true.

        Returns:
        A modified copy of the this object
      • getPointImageSrc

        @Nullable
        java.lang.String getPointImageSrc()
        Returns the source URI of the point image.

        Default: null.

      • withPointImageSrc

        ILineitem<I> withPointImageSrc​(@Nullable
                                       java.lang.String pointImageSrc)
        Returns a copy of this immutable component with the specified pointImageSrc.

        Sets the source URI of the point image.

        Note: the withPointImageContent(org.zkoss.image.Image) is higher priority if both methods are specified.

        Parameters:
        pointImageSrc - The source URI of the point image.

        Default: null.

        Returns:
        A modified copy of the this object
      • withPointImageContent

        ILineitem<I> withPointImageContent​(@Nullable
                                           Image pointImageContent)
        Returns a copy of this immutable component with the specified pointImageContent.

        Sets the content directly.

        Default: null.

        Calling this method implies withPointImageSrc is useless. In other words, The withPointImageContent(org.zkoss.image.Image) priority is higher than calling the withPointImageSrc(String), if any.

        Parameters:
        pointImageContent - The image to display.
        Returns:
        A modified copy of this object
        See Also:
        withPointImageSrc(String)
      • of

        static <I extends IAnyGroupILineitem<I> of​(java.lang.Iterable<? extends I> children)
        Returns the instance with the given any group children (only up to two children).
        Parameters:
        children - The children belong to any group
        See Also:
        IAnyGroup
      • of

        static <I extends IAnyGroupILineitem<I> of​(I... children)
        Returns the instance with the given any group children (only up to two children).
        Parameters:
        children - The children belong to any group
        See Also:
        IAnyGroup
      • ofPointIconSclass

        static <I extends IAnyGroupILineitem<I> ofPointIconSclass​(java.lang.String pointIconSclass)
        Returns the instance with the given pointIconSclass.
        Parameters:
        pointIconSclass - The sclass name of the point icon.
      • ofPointImageSrc

        static <I extends IAnyGroupILineitem<I> ofPointImageSrc​(java.lang.String src)
        Returns the instance with the given pointImageSrc.
        Parameters:
        src - The source URI of the point background image.
      • ofId

        static <I extends IAnyGroupILineitem<I> ofId​(java.lang.String id)
        Returns the instance with the given id.
        Parameters:
        id - The id to identify this component