Package de.xima.fc.mdl.ui

Class GuiIcon

java.lang.Object

de.xima.fc.mdl.ui.GuiIcon

All Implemented Interfaces:

IGuiIcon, Serializable

@Immutable
public final class GuiIcon
extends Object
implements IGuiIcon

Default implementation of IGuiIcon for common icon libraries. Supports font awesome, ui-icon, material-icon, and ico-fc (custom formcycle icon library).

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static IGuiIcon	EMPTY

Constructor Summary

Constructors

Constructor	Description
GuiIcon(String id, EIconType type)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCss()	Additional CSS that needs to be added to the page for this icon to work.
String	getId()
String	getStyle()
String	getStyleClass()
EIconType	getType()
String	getValue()
int	hashCode()
boolean	isFaIcon()
boolean	isFcIcon()
boolean	isMaterialIcon()
boolean	isPrimeIcon()
boolean	isUiIcon()
static IGuiIcon	valueOf(String id)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.beans.interfaces.IGuiIcon

isEmpty

Field Detail

EMPTY

public static final IGuiIcon EMPTY

Constructor Detail

GuiIcon

public GuiIcon(String id,
               EIconType type)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getCss

public String getCss()

Description copied from interface: IGuiIcon

Additional CSS that needs to be added to the page for this icon to work.

Specified by:

getCss in interface IGuiIcon

getId

public String getId()

Specified by:

getId in interface IGuiIcon

Returns:

The ID of this icon, eg. ico-fc-lock-alert.

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.

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.

getType

public EIconType getType()

Specified by:

getType in interface IGuiIcon

Returns:

The type of icon font of this icon.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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.

isFcIcon

public boolean isFcIcon()

Specified by:

isFcIcon in interface IGuiIcon

Returns:

Whether the IGuiIcon.getType() refers to an icon from the formcycle icon font.

isMaterialIcon

public boolean isMaterialIcon()

Specified by:

isMaterialIcon in interface IGuiIcon

Returns:

Whether the IGuiIcon.getType() refers to an icon from the material icon font.

isPrimeIcon

public boolean isPrimeIcon()

Specified by:

isPrimeIcon in interface IGuiIcon

Returns:

Whether the IGuiIcon.getType() refers to an icon from the prime icons 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.

valueOf

public static IGuiIcon valueOf(String id)

Parameters:

id - The ID of the icon, e.g. ico-fc-lock-alert, alarm-off, or fa-cog .

Returns:

A #IGuiIcon representing the icon with the given ID.