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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CustomGuiIcon.Builder
A new builder for a custom GUI icon.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CustomGuiIcon.Builder
builder()
Creates a new builder for a custom GUI icon.String
getId()
String
getStyle()
String
getStyleClass()
EIconType
getType()
String
getValue()
boolean
isFaIcon()
boolean
isFcIcon()
boolean
isMaterialIcon()
boolean
isUiIcon()
-
-
-
Method Detail
-
getId
public String getId()
-
isFcIcon
public boolean isFcIcon()
- Specified by:
isFcIcon
in interfaceIGuiIcon
- Returns:
- Whether the
IGuiIcon.getType()
refers to an icon from the formcycle icon font.
-
isFaIcon
public boolean isFaIcon()
- Specified by:
isFaIcon
in interfaceIGuiIcon
- Returns:
- Whether the
IGuiIcon.getType()
refers to an icon from the Font Awesome icon font.
-
isUiIcon
public boolean isUiIcon()
- Specified by:
isUiIcon
in interfaceIGuiIcon
- Returns:
- Whether the
IGuiIcon.getType()
refers to an icon from the UI (primefaces) icon font.
-
isMaterialIcon
public boolean isMaterialIcon()
- Specified by:
isMaterialIcon
in interfaceIGuiIcon
- Returns:
- Whether the
IGuiIcon.getType()
refers to an icon from the material icons font.
-
getType
public EIconType getType()
-
getStyleClass
public String getStyleClass()
- Specified by:
getStyleClass
in interfaceIGuiIcon
- Returns:
- The CSS class(es) that need to be set on an HTML element to create this icon.
-
getStyle
public String getStyle()
-
getValue
public String getValue()
-
builder
public static CustomGuiIcon.Builder builder()
Creates a new builder for a custom GUI icon.- Returns:
- A new builder for a custom GUI icon.
-
-