info.magnolia.icons

Enum MagnoliaIcons

java.lang.Object

java.lang.Enum<MagnoliaIcons>

info.magnolia.icons.MagnoliaIcons

All Implemented Interfaces:

com.vaadin.server.FontIcon, com.vaadin.server.Resource, Serializable, Comparable<MagnoliaIcons>

public enum MagnoliaIcons
extends Enum<MagnoliaIcons>
implements com.vaadin.server.FontIcon

The Magnolia icon-font is exposed as a FontIcon. With this, our icons can be used as Resources on Vaadin Components.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARROW2_E
ARROW2_N
ARROW2_S
ARROW2_W

Field Summary

Fields

Modifier and Type	Field and Description
static String	FONT_FAMILY

Method Summary

Modifier and Type	Method and Description
int	getCodepoint() Unsupported: we do not rely on code-points for our icons, but only on class names.
String	getFontFamily()
String	getHtml() Magnolia icons do not need a specific font-family, they apply to any class name prefixed with icon-.
String	getMIMEType() Unsupported: FontIcon does not have a MIME type and is not a Resource that can be used in a context where a MIME type would be needed.
static MagnoliaIcons	valueOf(String name) Returns the enum constant of this type with the specified name.
static MagnoliaIcons[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ARROW2_E

public static final MagnoliaIcons ARROW2_E

ARROW2_N

public static final MagnoliaIcons ARROW2_N

ARROW2_S

public static final MagnoliaIcons ARROW2_S

ARROW2_W

public static final MagnoliaIcons ARROW2_W

Field Detail

FONT_FAMILY

public static final String FONT_FAMILY

See Also:

Constant Field Values

Method Detail

values

public static MagnoliaIcons[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MagnoliaIcons c : MagnoliaIcons.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MagnoliaIcons valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFontFamily

public String getFontFamily()

Specified by:

getFontFamily in interface com.vaadin.server.FontIcon

getHtml

public String getHtml()

Magnolia icons do not need a specific font-family, they apply to any class name prefixed with icon-.

Specified by:

getHtml in interface com.vaadin.server.FontIcon

getCodepoint

public int getCodepoint()

Unsupported: we do not rely on code-points for our icons, but only on class names.

Specified by:

getCodepoint in interface com.vaadin.server.FontIcon

getMIMEType

public String getMIMEType()

Unsupported: FontIcon does not have a MIME type and is not a Resource that can be used in a context where a MIME type would be needed.

Specified by:

getMIMEType in interface com.vaadin.server.Resource