Package org.opencms.ui

Enum FontOpenCms

java.lang.Object

java.lang.Enum<FontOpenCms>

org.opencms.ui.FontOpenCms

All Implemented Interfaces:

com.vaadin.server.FontIcon, com.vaadin.server.Resource, Serializable, Comparable<FontOpenCms>, java.lang.constant.Constable

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

The available OpenCms workplace icons.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD_SMALL	The add icon.
APPS	The apps icon.
BOOKMARKS	The bookmarks icon.
BRACKETS	The brackets icon.
BROADCAST	The broadcast icon.
CACHE	The cache icon.
CHECK_SMALL	The check 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.
CONTEXT_MENU_SMALL	The context menu icon.
COPY_LOCALE	The copy locale icon.
CROP	The crop icon.
CROP_REMOVE	The crop remove icon.
CUT_SMALL	The cut icon.
DATABASE	The database icon.
DELETE_SMALL	The delete icon.
DOWNLOAD	The download icon.
EDIT_DOWN_SMALL	The edit down icon.
EDIT_POINT	The bulls eye edit icon.
EDIT_POINT_DISABLED	The disabled bulls eye edit icon.
EDIT_POINT_SMALL	The bulls eye edit icon.
EDIT_UP_SMALL	The edit up icon.
ERROR	The error icon.
EXIT	The exit icon.
FAVORITE_SMALL	The favorite icon.
FILE	The file icon.
FILE_INV	The inverse file icon.
FILTER	The filter icon.
FOLDER	The folder icon.
GALLERY	The gallery icon.
GIT	The git icon.
HELP	The help icon.
HELP_DISABLED	The disabled help icon.
HELP_SMALL	The help icon.
HIDE	The hide icon.
HIGHLIGHT	The highlight icon.
HISTORY	The history icon.
IMAGE	The image icon.
INFO	The info icon.
INFO_SMALL	The info icon.
INVISIBLE_CHARS	The invisible chars icon.
LINK	The link icon.
LIST	The list icon.
LOCK_CLOSED	The lock closed icon.
LOCK_OPEN	The lock opened icon.
LOCK_SMALL	The lock icon.
LOG	The log icon.
LOGIN	The log icon.
MODULE	The module icon.
MOVE_SMALL	The move icon.
PEN	The pen/edit icon.
PEN_SMALL	The pen/edit icon.
PREVIEW_SMALL	The preview icon.
PROJECT	The project icon.
PUBLISH	The publish icon.
QUICKLAUNCH_EDITOR	The quick launch editor icon.
REDO	The redo icon.
REMOVE_LOCALE	The remove locale icon.
RESET	The reset icon.
SAVE	The save icon.
SAVE_EXIT	The save and exit icon.
SCHEDULER	The scheduler icon.
SEARCH	The search icon.
SEARCH_REPLACE	The search replace icon.
SEARCH_SMALL	The search icon.
SETTINGS	The settings icon.
SETTINGS_SMALL	The settings icon.
SHOW	The show icon.
SITE	The site icon.
SITEMAP	The sitemap icon.
SITEMAP_SMALL	The sitemap icon.
SPACE	An empty icon.
SPHERE	The sphere icon.
TRASH_SMALL	The trash icon.
TREE_MINUS	'minus' state icon for tree opener.
TREE_PLUS	'plus' state icon for tree opener.
TRIANGLE_DOWN	The triangle down icon.
TRIANGLE_RIGHT	The triangle right icon.
UNDO	The undo icon.
UPLOAD	The upload icon.
UPLOAD_SMALL	The upload icon.
USERS	The users icon.
WAND	The wand icon.
WARNING	The warning icon.
WRAP_LINES	The wrap lines icon.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FONT_FAMILY	The font family.

Method Summary

Modifier and Type	Method	Description
String	getButtonOverlayStyle()	Returns the button overlay style classes for the icon.
int	getCodepoint()
String	getFontFamily()
String	getHtml()
String	getMIMEType()
static FontOpenCms	valueOf(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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADD_SMALL

public static final FontOpenCms ADD_SMALL

The add icon.

APPS

public static final FontOpenCms APPS

The apps icon.

BOOKMARKS

public static final FontOpenCms BOOKMARKS

The bookmarks icon.

BRACKETS

public static final FontOpenCms BRACKETS

The brackets icon.

BROADCAST

public static final FontOpenCms BROADCAST

The broadcast icon.

CACHE

public static final FontOpenCms CACHE

The cache icon.

CHECK_SMALL

public static final FontOpenCms CHECK_SMALL

The check 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.

CONTEXT_MENU_SMALL

public static final FontOpenCms CONTEXT_MENU_SMALL

The context menu icon.

COPY_LOCALE

public static final FontOpenCms COPY_LOCALE

The copy locale icon.

CROP

public static final FontOpenCms CROP

The crop icon.

CROP_REMOVE

public static final FontOpenCms CROP_REMOVE

The crop remove icon.

CUT_SMALL

public static final FontOpenCms CUT_SMALL

The cut icon.

DATABASE

public static final FontOpenCms DATABASE

The database icon.

DELETE_SMALL

public static final FontOpenCms DELETE_SMALL

The delete icon.

DOWNLOAD

public static final FontOpenCms DOWNLOAD

The download icon.

EDIT_DOWN_SMALL

public static final FontOpenCms EDIT_DOWN_SMALL

The edit down 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.

EDIT_POINT_SMALL

public static final FontOpenCms EDIT_POINT_SMALL

The bulls eye edit icon.

EDIT_UP_SMALL

public static final FontOpenCms EDIT_UP_SMALL

The edit up icon.

ERROR

public static final FontOpenCms ERROR

The error icon.

EXIT

public static final FontOpenCms EXIT

The exit icon.

FAVORITE_SMALL

public static final FontOpenCms FAVORITE_SMALL

The favorite icon.

FILE

public static final FontOpenCms FILE

The file icon.

FILE_INV

public static final FontOpenCms FILE_INV

The inverse file icon.

FILTER

public static final FontOpenCms FILTER

The filter icon.

FOLDER

public static final FontOpenCms FOLDER

The folder icon.

GALLERY

public static final FontOpenCms GALLERY

The gallery icon.

GIT

public static final FontOpenCms GIT

The git 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.

HISTORY

public static final FontOpenCms HISTORY

The history icon.

IMAGE

public static final FontOpenCms IMAGE

The image icon.

INFO

public static final FontOpenCms INFO

The info icon.

INFO_SMALL

public static final FontOpenCms INFO_SMALL

The info icon.

INVISIBLE_CHARS

public static final FontOpenCms INVISIBLE_CHARS

The invisible chars icon.

LINK

public static final FontOpenCms LINK

The link icon.

LIST

public static final FontOpenCms LIST

The list icon.

LOCK_CLOSED

public static final FontOpenCms LOCK_CLOSED

The lock closed icon.

LOCK_OPEN

public static final FontOpenCms LOCK_OPEN

The lock opened icon.

LOCK_SMALL

public static final FontOpenCms LOCK_SMALL

The lock icon.

LOG

public static final FontOpenCms LOG

The log icon.

LOGIN

public static final FontOpenCms LOGIN

The log icon.

HELP_SMALL

public static final FontOpenCms HELP_SMALL

The help icon.

MODULE

public static final FontOpenCms MODULE

The module icon.

MOVE_SMALL

public static final FontOpenCms MOVE_SMALL

The move icon.

PEN

public static final FontOpenCms PEN

The pen/edit icon.

PEN_SMALL

public static final FontOpenCms PEN_SMALL

The pen/edit icon.

PREVIEW_SMALL

public static final FontOpenCms PREVIEW_SMALL

The preview icon.

PROJECT

public static final FontOpenCms PROJECT

The project icon.

PUBLISH

public static final FontOpenCms PUBLISH

The publish icon.

QUICKLAUNCH_EDITOR

public static final FontOpenCms QUICKLAUNCH_EDITOR

The quick launch editor icon.

REDO

public static final FontOpenCms REDO

The redo icon.

REMOVE_LOCALE

public static final FontOpenCms REMOVE_LOCALE

The remove locale icon.

RESET

public static final FontOpenCms RESET

The reset icon.

SAVE

public static final FontOpenCms SAVE

The save icon.

SAVE_EXIT

public static final FontOpenCms SAVE_EXIT

The save and exit icon.

SCHEDULER

public static final FontOpenCms SCHEDULER

The scheduler icon.

SEARCH

public static final FontOpenCms SEARCH

The search icon.

SEARCH_REPLACE

public static final FontOpenCms SEARCH_REPLACE

The search replace icon.

SEARCH_SMALL

public static final FontOpenCms SEARCH_SMALL

The search icon.

SETTINGS

public static final FontOpenCms SETTINGS

The settings icon.

SETTINGS_SMALL

public static final FontOpenCms SETTINGS_SMALL

The settings icon.

SHOW

public static final FontOpenCms SHOW

The show icon.

SITE

public static final FontOpenCms SITE

The site icon.

SITEMAP

public static final FontOpenCms SITEMAP

The sitemap icon.

SITEMAP_SMALL

public static final FontOpenCms SITEMAP_SMALL

The sitemap icon.

SPACE

public static final FontOpenCms SPACE

An empty icon.

SPHERE

public static final FontOpenCms SPHERE

The sphere icon.

TRASH_SMALL

public static final FontOpenCms TRASH_SMALL

The trash icon.

TREE_MINUS

public static final FontOpenCms TREE_MINUS

'minus' state icon for tree opener.

TREE_PLUS

public static final FontOpenCms TREE_PLUS

'plus' state icon for tree opener.

TRIANGLE_DOWN

public static final FontOpenCms TRIANGLE_DOWN

The triangle down icon.

TRIANGLE_RIGHT

public static final FontOpenCms TRIANGLE_RIGHT

The triangle right icon.

UNDO

public static final FontOpenCms UNDO

The undo icon.

UPLOAD

public static final FontOpenCms UPLOAD

The upload icon.

UPLOAD_SMALL

public static final FontOpenCms UPLOAD_SMALL

The upload icon.

USERS

public static final FontOpenCms USERS

The users 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 Details

FONT_FAMILY

public static final String FONT_FAMILY

The font family.

See Also:

• Constant Field Values

Method Details

values

public static FontOpenCms[] values()

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

Returns:

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

valueOf

public static FontOpenCms 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

getButtonOverlayStyle

public String getButtonOverlayStyle()

Returns the button overlay style classes for the icon.

Returns:

the button overlay style

getCodepoint

public int getCodepoint()

Specified by:

getCodepoint in interface com.vaadin.server.FontIcon

See Also:

• FontIcon.getCodepoint()

getFontFamily

public String getFontFamily()

Specified by:

getFontFamily in interface com.vaadin.server.FontIcon

See Also:

• FontIcon.getFontFamily()

getHtml

public String getHtml()

Specified by:

getHtml in interface com.vaadin.server.FontIcon

See Also:

• FontIcon.getHtml()

getMIMEType

public String getMIMEType()

Specified by:

getMIMEType in interface com.vaadin.server.Resource

See Also:

• Resource.getMIMEType()