Package org.zkoss.stateless.sul

Interface ILabelImageElement<I extends ILabelImageElement>

All Superinterfaces:
IChildrenOfInputgroup<I>, IComponent<I>, IHtmlBasedComponent<I>, ILabelElement<I>, IXulElement<I>
All Known Subinterfaces:
IA<I>, IAuxheader<I>, IAvatar, IBreadcrumbitem, IButton, IButtonBase<I>, ICaption<I>, ICarouselitem<I>, ICheckbox, ICheckboxBase<I>, IChip, IColumn<I>, ICombobutton, IComboitem, IFileupload, IFisheye, IFooter<I>, IFooterElement<I>, IHeaderElement<I>, IListcell<I>, IListfooter<I>, IListheader<I>, IMenu, IMenuitem, INav, INavitem, IOrgnode<I>, IRadio, ITab, IToolbarbutton, ITreecell<I>, ITreecol<I>, ITreefooter<I>
public interface ILabelImageElement<I extends ILabelImageElement> extends ILabelElement<I>, IChildrenOfInputgroup<I>
Immutable LabelImageElement interface

To turn on the preload image facility for this component, you have to specify withPreloadImage(boolean) to true.

Or configure it from zk.xml by setting library properties. For example, 

  <library-property/>
     <name>org.zkoss.zul.image.preload</name/>
     <value>true</value/>
 </library-property/>
Note: with zk.xml setting, it will affect to all subcomponents, which are extended from ILabelImageElement
Author:
katherine

  • Method Details

    • getIconSclass

      @Nullable default String getIconSclass()
      Returns the icon font CSS class name.

    • withIconSclass

      I withIconSclass(@Nullable String iconSclass)
      Returns a copy of this immutable component with the specified iconSclass.

      Sets the CSS class name for the icon font.

      Parameters:
      iconSclass - A CSS class name for the icon font.
      Returns:
      A modified copy of the this object

    • getIconSclasses

      @Nullable default String[] getIconSclasses()
      Returns the icon font CSS class name String array.

    • withIconSclasses

      I withIconSclasses(@Nullable String[] iconSclasses)
      Returns a copy of this immutable component with the specified iconSclasses String array.

      Sets the CSS class name for the icon font.

      Parameters:
      iconSclasses - A CSS class name for the icon font.
      Returns:
      A modified copy of the this object

    • getIconTooltip

      @Nullable default String getIconTooltip()
      Returns the iconTooltip font.

    • withIconTooltip

      I withIconTooltip(@Nullable String iconTooltip)
      Returns a copy of this immutable component with the specified iconTooltip.

      Sets the iconTooltip.

      Parameters:
      iconTooltip - A content String for iconTooltip font.
      Returns:
      A modified copy of the this object

    • getIconTooltips

      @Nullable default String[] getIconTooltips()
      Returns the iconTooltip font String array.

    • withIconTooltips

      I withIconTooltips(@Nullable String[] iconTooltips)
      Returns a copy of this immutable component with the specified iconTooltips String array.

      Sets the iconTooltip.

      Parameters:
      iconTooltips - A content String array for iconTooltip font.
      Returns:
      A modified copy of the this object

    • getImage

      @Nullable default String getImage()
      Returns the image URI.

      Default: null.

    • withImage

      I withImage(@Nullable String image)
      Returns a copy of this immutable component with the specified image URI.

      Sets the image URI. The image would hide if specify to null

      Returns:
      A modified copy of the this object

    • getHoverImage

      @Nullable default String getHoverImage()
      Returns the URI of the hover image. The hover image is used when the mouse is moving over this component.

      Default: null.

    • withHoverImage

      I withHoverImage(@Nullable String hoverImage)
      Returns a copy of this immutable component with the specified hoverImage URI.

      Sets the image URI. The hover image is used when the mouse is moving over this component.

      Returns:
      A modified copy of the this object

    • isPreloadImage

      default boolean isPreloadImage()
      Returns whether to preload the image.

      Default: false, if the "org.zkoss.zul.image.preload" library property is not set in zk.xml.

    • withPreloadImage

      I withPreloadImage(boolean preloadImage)
      Returns a copy of this immutable component with the specified preloadImage URI.

      Sets to true to enable to preload the image. Note: the priority of this attribute is higher than zk.xml if both preload image are specified.

      Returns:
      A modified copy of the this object