Package de.xima.fc.beans.interfaces

Interface IGuiIcon

All Superinterfaces:
Serializable
All Known Implementing Classes:
ClientIconWrapper, CustomGuiIcon, GuiIcon
public interface IGuiIcon extends Serializable
Represents an icon used in the fronted. This class abstracts over the different icons fonts such as font awesome and material icons.
Author:
XIMA MEDIA GmbH

  • Method Details

    • getId

      String getId()
      Returns:
      The ID of this icon, eg. ico-fc-lock-alert.

    • isFcIcon

      boolean isFcIcon()
      Returns:
      Whether the getType() refers to an icon from the formcycle icon font.

    • isFaIcon

      boolean isFaIcon()
      Returns:
      Whether the getType() refers to an icon from the Font Awesome icon font.

    • isUiIcon

      boolean isUiIcon()
      Returns:
      Whether the getType() refers to an icon from the UI (primefaces) icon font.

    • isMaterialIcon

      boolean isMaterialIcon()
      Returns:
      Whether the getType() refers to an icon from the material icons font.

    • getType

      EIconType getType()
      Returns:
      The type of icon font of this icon.

    • getStyle

      default String getStyle()
      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.

    • getStyleClass

      String getStyleClass()
      Returns:
      The CSS class(es) that need to be set on an HTML element to create this icon.

    • getValue

      String getValue()
      Returns:
      The textValue that needs to be set on an HTML element to create this icon.

    • isEmpty

      default boolean isEmpty()
      Returns:
      true if this icon is empty (no icon), false otherwise