Package org.opencms.gwt.client.ui

Enum FontOpenCms

java.lang.Object

java.lang.Enum<FontOpenCms>

org.opencms.gwt.client.ui.FontOpenCms

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FontOpenCms>

public enum FontOpenCms
extends java.lang.Enum<FontOpenCms>

OpenCms font icons.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FontOpenCms.IconHTML	Font icon widget.

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPS	The apps icon.
BRACKETS	The brackets icon.
CIRCLE	The circle icon.
CIRCLE_CANCEL	The circle cancel icon.
CIRCLE_CHECK	The circle check icon.
CIRCLE_HELP	The circle help icon.
CIRCLE_INFO	The circle info icon.
CIRCLE_INV	The circle invert icon.
CIRCLE_INV_CANCEL	The circle invert cancel icon.
CIRCLE_INV_CHECK	The circle invert check icon.
CIRCLE_INV_MINUS	The circle invert minus icon.
CIRCLE_INV_PAUSE	The circle invert pause icon.
CIRCLE_INV_PLAY	The circle invert play icon.
CIRCLE_INV_PLUS	The circle invert plus icon.
CIRCLE_MINUS	The circle minus icon.
CIRCLE_PAUSE	The circle pause icon.
CIRCLE_PLAY	The circle play icon.
CIRCLE_PLUS	The circle plus icon.
CLIPBOARD	The clipboard icon.
CONTEXT_MENU	The context menu icon.
CONTEXT_MENU_DOTS	The context menu dots icon.
COPY_LOCALE	The copy locale icon.
EDIT_POINT	The bulls eye edit icon.
EDIT_POINT_DISABLED	The disabled bulls eye edit icon.
ERROR	The error icon.
EXIT	The exit icon.
FILTER	The filter icon.
GALLERY	The gallery icon.
HELP	The help icon.
HELP_DISABLED	The disabled help icon.
HIDE	The hide icon.
HIGHLIGHT	The highlight icon.
INFO	The info icon.
INVISIBLE_CHARS	The invisible chars icon.
PEN	The pen/edit icon.
PUBLISH	The publish icon.
REDO	The redo icon.
REMOVE_LOCALE	The remove locale icon.
SAVE	The save icon.
SAVE_EXIT	The save and exit icon.
SEARCH	The search icon.
SEARCH_REPLACE	The search replace icon.
SETTINGS	The settings icon.
SHOW	The show icon.
SITEMAP	The sitemap icon.
UNDO	The undo icon.
UPLOAD	The upload icon.
WAND	The wand icon.
WARNING	The warning icon.
WRAP_LINES	The wrap lines icon.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FONT_ICON_CLASS	The font icon CSS class.

Method Summary

Modifier and Type	Method	Description
int	getCodePoint()	Gets the code point.
java.lang.String	getCodePointEntity()	Formats the code point as an HTML entity.
java.lang.String	getFontFamily()	Returns the font family.
java.lang.String	getHtml(int size)	Returns the icon HTML.
java.lang.String	getHtml(int size, java.lang.String color)	Returns the icon HTML.
com.google.gwt.user.client.ui.HTML	getWidget(int size)	Returns the icon widget.
com.google.gwt.user.client.ui.HTML	getWidget(int size, java.lang.String color)	Returns the icon widget.
static FontOpenCms	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static FontOpenCms[]	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

APPS

public static final FontOpenCms APPS

The apps icon.

BRACKETS

public static final FontOpenCms BRACKETS

The brackets icon.

CIRCLE

public static final FontOpenCms CIRCLE

The circle icon.

CIRCLE_CANCEL

public static final FontOpenCms CIRCLE_CANCEL

The circle cancel icon.

CIRCLE_CHECK

public static final FontOpenCms CIRCLE_CHECK

The circle check icon.

CIRCLE_INFO

public static final FontOpenCms CIRCLE_INFO

The circle info icon.

CIRCLE_INV

public static final FontOpenCms CIRCLE_INV

The circle invert icon.

CIRCLE_INV_CANCEL

public static final FontOpenCms CIRCLE_INV_CANCEL

The circle invert cancel icon.

CIRCLE_INV_CHECK

public static final FontOpenCms CIRCLE_INV_CHECK

The circle invert check icon.

CIRCLE_INV_MINUS

public static final FontOpenCms CIRCLE_INV_MINUS

The circle invert minus icon.

CIRCLE_INV_PAUSE

public static final FontOpenCms CIRCLE_INV_PAUSE

The circle invert pause icon.

CIRCLE_INV_PLAY

public static final FontOpenCms CIRCLE_INV_PLAY

The circle invert play icon.

CIRCLE_INV_PLUS

public static final FontOpenCms CIRCLE_INV_PLUS

The circle invert plus icon.

CIRCLE_MINUS

public static final FontOpenCms CIRCLE_MINUS

The circle minus icon.

CIRCLE_PAUSE

public static final FontOpenCms CIRCLE_PAUSE

The circle pause icon.

CIRCLE_PLAY

public static final FontOpenCms CIRCLE_PLAY

The circle play icon.

CIRCLE_PLUS

public static final FontOpenCms CIRCLE_PLUS

The circle plus icon.

CIRCLE_HELP

public static final FontOpenCms CIRCLE_HELP

The circle help icon.

CLIPBOARD

public static final FontOpenCms CLIPBOARD

The clipboard icon.

CONTEXT_MENU

public static final FontOpenCms CONTEXT_MENU

The context menu icon.

CONTEXT_MENU_DOTS

public static final FontOpenCms CONTEXT_MENU_DOTS

The context menu dots icon.

COPY_LOCALE

public static final FontOpenCms COPY_LOCALE

The copy locale icon.

EDIT_POINT

public static final FontOpenCms EDIT_POINT

The bulls eye edit icon.

EDIT_POINT_DISABLED

public static final FontOpenCms EDIT_POINT_DISABLED

The disabled bulls eye edit icon.

ERROR

public static final FontOpenCms ERROR

The error icon.

EXIT

public static final FontOpenCms EXIT

The exit icon.

FILTER

public static final FontOpenCms FILTER

The filter icon.

GALLERY

public static final FontOpenCms GALLERY

The gallery icon.

HELP

public static final FontOpenCms HELP

The help icon.

HELP_DISABLED

public static final FontOpenCms HELP_DISABLED

The disabled help icon.

HIDE

public static final FontOpenCms HIDE

The hide icon.

HIGHLIGHT

public static final FontOpenCms HIGHLIGHT

The highlight icon.

INFO

public static final FontOpenCms INFO

The info icon.

INVISIBLE_CHARS

public static final FontOpenCms INVISIBLE_CHARS

The invisible chars icon.

PEN

public static final FontOpenCms PEN

The pen/edit icon.

PUBLISH

public static final FontOpenCms PUBLISH

The publish icon.

REDO

public static final FontOpenCms REDO

The redo icon.

REMOVE_LOCALE

public static final FontOpenCms REMOVE_LOCALE

The remove locale icon.

SAVE

public static final FontOpenCms SAVE

The save icon.

SAVE_EXIT

public static final FontOpenCms SAVE_EXIT

The save and exit icon.

SEARCH

public static final FontOpenCms SEARCH

The search icon.

SEARCH_REPLACE

public static final FontOpenCms SEARCH_REPLACE

The search replace icon.

SETTINGS

public static final FontOpenCms SETTINGS

The settings icon.

SHOW

public static final FontOpenCms SHOW

The show icon.

SITEMAP

public static final FontOpenCms SITEMAP

The sitemap icon.

UNDO

public static final FontOpenCms UNDO

The undo icon.

UPLOAD

public static final FontOpenCms UPLOAD

The upload icon.

WAND

public static final FontOpenCms WAND

The wand icon.

WARNING

public static final FontOpenCms WARNING

The warning icon.

WRAP_LINES

public static final FontOpenCms WRAP_LINES

The wrap lines icon.

Field Detail

FONT_ICON_CLASS

public static final java.lang.String FONT_ICON_CLASS

The font icon CSS class.

See Also:

Constant Field Values

Method Detail

values

public static FontOpenCms[] 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 (FontOpenCms c : FontOpenCms.values())
    System.out.println(c);

Returns:

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

valueOf

public static FontOpenCms valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getCodePoint

public int getCodePoint()

Gets the code point.

Returns:

the code point

getCodePointEntity

public java.lang.String getCodePointEntity()

Formats the code point as an HTML entity.

Returns:

the code point as an HTML entity

getFontFamily

public java.lang.String getFontFamily()

Returns the font family.

Returns:

the font family

getHtml

public java.lang.String getHtml(int size)

Returns the icon HTML.

Parameters:

size - the icon size

Returns:

the icon HTML

getHtml

public java.lang.String getHtml(int size,
                                java.lang.String color)

Returns the icon HTML.

Parameters:

size - the icon size

color - the icon color

Returns:

the icon HTML

getWidget

public com.google.gwt.user.client.ui.HTML getWidget(int size)

Returns the icon widget.

Parameters:

size - the icon size

Returns:

the icon widget

getWidget

public com.google.gwt.user.client.ui.HTML getWidget(int size,
                                                    java.lang.String color)

Returns the icon widget.

Parameters:

size - the icon size

color - the icon color

Returns:

the icon widget