Package de.xima.fc.mdl.ui

Class CustomGuiIcon

java.lang.Object
de.xima.fc.mdl.ui.CustomGuiIcon
All Implemented Interfaces:
IGuiIcon, Serializable
@Immutable public final class CustomGuiIcon extends Object implements IGuiIcon
A custom GUI icon with a freely configurable style, style class, and value.
Since:
8.0.1
Author:
XIMA MEDIA GmbH
See Also:

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface IGuiIcon
      Returns:
      The ID of this icon, eg. ico-fc-lock-alert.

    • isFcIcon

      public boolean isFcIcon()
      Specified by:
      isFcIcon in interface IGuiIcon
      Returns:
      Whether the IGuiIcon.getType() refers to an icon from the formcycle icon font.

    • isFaIcon

      public boolean isFaIcon()
      Specified by:
      isFaIcon in interface IGuiIcon
      Returns:
      Whether the IGuiIcon.getType() refers to an icon from the Font Awesome icon font.

    • isUiIcon

      public boolean isUiIcon()
      Specified by:
      isUiIcon in interface IGuiIcon
      Returns:
      Whether the IGuiIcon.getType() refers to an icon from the UI (primefaces) icon font.

    • isMaterialIcon

      public boolean isMaterialIcon()
      Specified by:
      isMaterialIcon in interface IGuiIcon
      Returns:
      Whether the IGuiIcon.getType() refers to an icon from the material icons font.

    • getType

      public EIconType getType()
      Specified by:
      getType in interface IGuiIcon
      Returns:
      The type of icon font of this icon.

    • getStyleClass

      public String getStyleClass()
      Specified by:
      getStyleClass in interface IGuiIcon
      Returns:
      The CSS class(es) that need to be set on an HTML element to create this icon.

    • getStyle

      public String getStyle()
      Specified by:
      getStyle in interface IGuiIcon
      Returns:
      The inline style that need to be set on an HTML element to create this icon. Can be used to include custom base64 inline icons.

    • getValue

      public String getValue()
      Specified by:
      getValue in interface IGuiIcon
      Returns:
      The textValue that needs to be set on an HTML element to create this icon.

    • builder

      public static CustomGuiIcon.Builder builder()
      Creates a new builder for a custom GUI icon.
      Returns:
      A new builder for a custom GUI icon.