de.xima.fc.beans.interfaces

Interface IGuiIcon

All Superinterfaces:

Serializable

All Known Implementing Classes:

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 Summary

Modifier and Type	Method and Description
String	getId()
String	getStyleClass()
EIconType	getType()
String	getValue()
default boolean	isEmpty()
boolean	isFaIcon()
boolean	isFcIcon()
boolean	isMaterialIcon()
boolean	isUiIcon()

Method Detail

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.

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