org.hippoecm.frontend.skin

Enum Icon

java.lang.Object

java.lang.Enum<Icon>

org.hippoecm.frontend.skin.Icon

All Implemented Interfaces:

Serializable, Comparable<Icon>

public enum Icon
extends Enum<Icon>

References to icons.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARROW_DOWN
ARROW_FAT_DOWN_CIRCLE
ARROW_RIGHT_SQUARE
ARROW_UP
BELL
BULLET
BULLHORN
CALENDAR_DAY
CALENDAR_MONTH
CARET_DOWN
CARET_DOWN_CIRCLE
CARET_RIGHT
CARET_UP_CIRCLE
CHECK_CIRCLE
CHECK_CIRCLE_CLOCK
CHECK_SQUARE
CHEVRON_DOWN
CHEVRON_DOWN_CIRCLE
CHEVRON_LEFT
CHEVRON_LEFT_CIRCLE
CHEVRON_RIGHT
CHEVRON_RIGHT_CIRCLE
CHEVRON_UP
CHEVRON_UP_CIRCLE
CODE
COMPONENT
COMPRESS
CROP
EMPTY
EXCLAMATION
EXCLAMATION_CIRCLE
EXCLAMATION_TRIANGLE
EXPAND
FILE
FILE_COMPOUND
FILE_IMAGE
FILE_NEWS
FILE_PENCIL
FILE_TEXT
FILES
FLASK
FLOPPY
FOLDER
FOLDER_OPEN
FONT
FORWARD
GEAR
GLOBE
GLOBE_ABSTRACT
INFO
INFO_CIRCLE
LINK
LIST_UL
LOCKED
MIMETYPE_AUDIO
MIMETYPE_BINARY
MIMETYPE_DOC
MIMETYPE_DOCX
MIMETYPE_FLASH
MIMETYPE_IMAGE
MIMETYPE_ODP
MIMETYPE_ODS
MIMETYPE_ODT
MIMETYPE_PDF
MIMETYPE_PPT
MIMETYPE_PPTX
MIMETYPE_RTF
MIMETYPE_SXC
MIMETYPE_SXI
MIMETYPE_SXW
MIMETYPE_TEXT
MIMETYPE_VIDEO
MIMETYPE_XLS
MIMETYPE_XLSX
MIMETYPE_ZIP
MINUS_CIRCLE
MINUS_CIRCLE_CLOCK
MOVE_INTO
PENCIL_SQUARE
PIE_CHART
PLUS
PLUS_SQUARE
REFRESH
RESTORE
SEARCH
SORT
STEP_BACKWARD
STEP_FORWARD
THUMBNAILS
TIMES
TIMES_CIRCLE
TRANSLATE
TYPE
UNLINK
UNLOCKED
USER_CIRCLE

Method Summary

Modifier and Type	Method and Description
static String	getIconSprite()
String	getSpriteReference(IconSize size, String... cssClasses) Returns an inline svg representation of this icon that refers to the icon in the sprite.
static Icon	valueOf(String name) Returns the enum constant of this type with the specified name.
static Icon[]	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

ARROW_DOWN

public static final Icon ARROW_DOWN

ARROW_FAT_DOWN_CIRCLE

public static final Icon ARROW_FAT_DOWN_CIRCLE

ARROW_UP

public static final Icon ARROW_UP

ARROW_RIGHT_SQUARE

public static final Icon ARROW_RIGHT_SQUARE

BELL

public static final Icon BELL

BULLET

public static final Icon BULLET

BULLHORN

public static final Icon BULLHORN

CALENDAR_DAY

public static final Icon CALENDAR_DAY

CALENDAR_MONTH

public static final Icon CALENDAR_MONTH

CARET_DOWN

public static final Icon CARET_DOWN

CARET_DOWN_CIRCLE

public static final Icon CARET_DOWN_CIRCLE

CARET_RIGHT

public static final Icon CARET_RIGHT

CARET_UP_CIRCLE

public static final Icon CARET_UP_CIRCLE

CHECK_CIRCLE

public static final Icon CHECK_CIRCLE

CHECK_CIRCLE_CLOCK

public static final Icon CHECK_CIRCLE_CLOCK

CHECK_SQUARE

public static final Icon CHECK_SQUARE

CHEVRON_DOWN_CIRCLE

public static final Icon CHEVRON_DOWN_CIRCLE

CHEVRON_DOWN

public static final Icon CHEVRON_DOWN

CHEVRON_LEFT_CIRCLE

public static final Icon CHEVRON_LEFT_CIRCLE

CHEVRON_LEFT

public static final Icon CHEVRON_LEFT

CHEVRON_RIGHT_CIRCLE

public static final Icon CHEVRON_RIGHT_CIRCLE

CHEVRON_RIGHT

public static final Icon CHEVRON_RIGHT

CHEVRON_UP_CIRCLE

public static final Icon CHEVRON_UP_CIRCLE

CHEVRON_UP

public static final Icon CHEVRON_UP

CODE

public static final Icon CODE

COMPONENT

public static final Icon COMPONENT

COMPRESS

public static final Icon COMPRESS

CROP

public static final Icon CROP

EMPTY

public static final Icon EMPTY

EXCLAMATION_CIRCLE

public static final Icon EXCLAMATION_CIRCLE

EXCLAMATION

public static final Icon EXCLAMATION

EXCLAMATION_TRIANGLE

public static final Icon EXCLAMATION_TRIANGLE

EXPAND

public static final Icon EXPAND

FILE_COMPOUND

public static final Icon FILE_COMPOUND

FILE_IMAGE

public static final Icon FILE_IMAGE

FILE

public static final Icon FILE

FILE_NEWS

public static final Icon FILE_NEWS

FILE_PENCIL

public static final Icon FILE_PENCIL

FILE_TEXT

public static final Icon FILE_TEXT

FILES

public static final Icon FILES

FLASK

public static final Icon FLASK

FLOPPY

public static final Icon FLOPPY

FOLDER

public static final Icon FOLDER

FOLDER_OPEN

public static final Icon FOLDER_OPEN

FONT

public static final Icon FONT

FORWARD

public static final Icon FORWARD

GEAR

public static final Icon GEAR

GLOBE_ABSTRACT

public static final Icon GLOBE_ABSTRACT

GLOBE

public static final Icon GLOBE

INFO_CIRCLE

public static final Icon INFO_CIRCLE

INFO

public static final Icon INFO

LINK

public static final Icon LINK

LIST_UL

public static final Icon LIST_UL

LOCKED

public static final Icon LOCKED

MIMETYPE_AUDIO

public static final Icon MIMETYPE_AUDIO

MIMETYPE_BINARY

public static final Icon MIMETYPE_BINARY

MIMETYPE_DOC

public static final Icon MIMETYPE_DOC

MIMETYPE_DOCX

public static final Icon MIMETYPE_DOCX

MIMETYPE_FLASH

public static final Icon MIMETYPE_FLASH

MIMETYPE_IMAGE

public static final Icon MIMETYPE_IMAGE

MIMETYPE_ODP

public static final Icon MIMETYPE_ODP

MIMETYPE_ODS

public static final Icon MIMETYPE_ODS

MIMETYPE_ODT

public static final Icon MIMETYPE_ODT

MIMETYPE_PDF

public static final Icon MIMETYPE_PDF

MIMETYPE_PPT

public static final Icon MIMETYPE_PPT

MIMETYPE_PPTX

public static final Icon MIMETYPE_PPTX

MIMETYPE_RTF

public static final Icon MIMETYPE_RTF

MIMETYPE_SXC

public static final Icon MIMETYPE_SXC

MIMETYPE_SXI

public static final Icon MIMETYPE_SXI

MIMETYPE_SXW

public static final Icon MIMETYPE_SXW

MIMETYPE_TEXT

public static final Icon MIMETYPE_TEXT

MIMETYPE_VIDEO

public static final Icon MIMETYPE_VIDEO

MIMETYPE_XLS

public static final Icon MIMETYPE_XLS

MIMETYPE_XLSX

public static final Icon MIMETYPE_XLSX

MIMETYPE_ZIP

public static final Icon MIMETYPE_ZIP

MINUS_CIRCLE

public static final Icon MINUS_CIRCLE

MINUS_CIRCLE_CLOCK

public static final Icon MINUS_CIRCLE_CLOCK

MOVE_INTO

public static final Icon MOVE_INTO

PENCIL_SQUARE

public static final Icon PENCIL_SQUARE

PIE_CHART

public static final Icon PIE_CHART

PLUS

public static final Icon PLUS

PLUS_SQUARE

public static final Icon PLUS_SQUARE

REFRESH

public static final Icon REFRESH

RESTORE

public static final Icon RESTORE

SEARCH

public static final Icon SEARCH

SORT

public static final Icon SORT

STEP_BACKWARD

public static final Icon STEP_BACKWARD

STEP_FORWARD

public static final Icon STEP_FORWARD

THUMBNAILS

public static final Icon THUMBNAILS

TIMES

public static final Icon TIMES

TIMES_CIRCLE

public static final Icon TIMES_CIRCLE

TRANSLATE

public static final Icon TRANSLATE

TYPE

public static final Icon TYPE

UNLINK

public static final Icon UNLINK

UNLOCKED

public static final Icon UNLOCKED

USER_CIRCLE

public static final Icon USER_CIRCLE

Method Detail

values

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

Returns:

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

valueOf

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

getIconSprite

public static String getIconSprite()

getSpriteReference

public String getSpriteReference(IconSize size,
                                 String... cssClasses)

Returns an inline svg representation of this icon that refers to the icon in the sprite. It is of the form

Parameters:

size - the size of the icon.

cssClasses - additional CSS classes to set on the SVG element.

See Also:

getSpriteId(IconSize), getCssClasses(IconSize)