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

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()

Methods inherited from class java.lang.Object

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

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

isEmpty

Method Detail

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.