Package com.helger.html

Enum EHTMLRole

java.lang.Object

java.lang.Enum<EHTMLRole>

com.helger.html.EHTMLRole

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EHTMLRole>

public enum EHTMLRole
extends Enum<EHTMLRole>
implements com.helger.commons.id.IHasID<String>

Enumeration with all HTML roles. Source: http://www.w3.org/TR/wai-aria/roles
Note: the deprecated rules are the abstract ones, as they should not be used in HTML generation. They are only present for completeness!

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALERT
ALERTDIALOG
APPLICATION
ARTICLE
BANNER
BUTTON
CHECKBOX
COLUMNHEADER
COMBOBOX
COMMAND	Deprecated.
COMPLEMENTARY
COMPOSITE	Deprecated.
CONTENTINFO
DEFINITION
DIALOG
DIRECTORY
DOCUMENT
FORM
GRID
GRIDCELL
GROUP
HEADING
IMG
INPUT	Deprecated.
LANDMARK	Deprecated.
LINK
LIST
LISTBOX
LISTITEM
LOG
MAIN
MARQUEE
MATH
MENU
MENUBAR
MENUITEM
MENUITEMCHECKBOX
MENUITEMRADIO
NAVIGATION
NOTE
OPTION
PRESENTATION
PROGRESSBAR
RADIO
RADIOGROUP
RANGE	Deprecated.
REGION
ROLETYPE	Deprecated.
ROW
ROWGROUP
ROWHEADER
SCROLLBAR
SEARCH
SECTION	Deprecated.
SECTIONHEAD	Deprecated.
SELECT	Deprecated.
SEPARATOR
SLIDER
SPINBUTTON
STATUS
STRUCTURE	Deprecated.
TAB
TABLIST
TABPANEL
TEXTBOX
TIMER
TOOLBAR
TOOLTIP
TREE
TREEGRID
TREEITEM
WIDGET	Deprecated.
WINDOW	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
static EHTMLRole	getFromIDOrNull(String sID)
String	getID()
EHTMLRoleType	getType()
boolean	isAbstract()
static EHTMLRole	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EHTMLRole[]	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

ALERT

public static final EHTMLRole ALERT

ALERTDIALOG

public static final EHTMLRole ALERTDIALOG

APPLICATION

public static final EHTMLRole APPLICATION

ARTICLE

public static final EHTMLRole ARTICLE

BANNER

public static final EHTMLRole BANNER

BUTTON

public static final EHTMLRole BUTTON

CHECKBOX

public static final EHTMLRole CHECKBOX

COLUMNHEADER

public static final EHTMLRole COLUMNHEADER

COMBOBOX

public static final EHTMLRole COMBOBOX

COMMAND

@Deprecated
public static final EHTMLRole COMMAND

Deprecated.

COMPLEMENTARY

public static final EHTMLRole COMPLEMENTARY

COMPOSITE

@Deprecated
public static final EHTMLRole COMPOSITE

Deprecated.

CONTENTINFO

public static final EHTMLRole CONTENTINFO

DEFINITION

public static final EHTMLRole DEFINITION

DIALOG

public static final EHTMLRole DIALOG

DIRECTORY

public static final EHTMLRole DIRECTORY

DOCUMENT

public static final EHTMLRole DOCUMENT

FORM

public static final EHTMLRole FORM

GRID

public static final EHTMLRole GRID

GRIDCELL

public static final EHTMLRole GRIDCELL

GROUP

public static final EHTMLRole GROUP

HEADING

public static final EHTMLRole HEADING

IMG

public static final EHTMLRole IMG

INPUT

@Deprecated
public static final EHTMLRole INPUT

Deprecated.

LANDMARK

@Deprecated
public static final EHTMLRole LANDMARK

Deprecated.

LINK

public static final EHTMLRole LINK

LIST

public static final EHTMLRole LIST

LISTBOX

public static final EHTMLRole LISTBOX

LISTITEM

public static final EHTMLRole LISTITEM

LOG

public static final EHTMLRole LOG

MAIN

public static final EHTMLRole MAIN

MARQUEE

public static final EHTMLRole MARQUEE

MATH

public static final EHTMLRole MATH

MENU

public static final EHTMLRole MENU

MENUBAR

public static final EHTMLRole MENUBAR

MENUITEM

public static final EHTMLRole MENUITEM

MENUITEMCHECKBOX

public static final EHTMLRole MENUITEMCHECKBOX

MENUITEMRADIO

public static final EHTMLRole MENUITEMRADIO

NAVIGATION

public static final EHTMLRole NAVIGATION

NOTE

public static final EHTMLRole NOTE

OPTION

public static final EHTMLRole OPTION

PRESENTATION

public static final EHTMLRole PRESENTATION

PROGRESSBAR

public static final EHTMLRole PROGRESSBAR

RADIO

public static final EHTMLRole RADIO

RADIOGROUP

public static final EHTMLRole RADIOGROUP

RANGE

@Deprecated
public static final EHTMLRole RANGE

Deprecated.

REGION

public static final EHTMLRole REGION

ROLETYPE

@Deprecated
public static final EHTMLRole ROLETYPE

Deprecated.

ROW

public static final EHTMLRole ROW

ROWGROUP

public static final EHTMLRole ROWGROUP

ROWHEADER

public static final EHTMLRole ROWHEADER

SCROLLBAR

public static final EHTMLRole SCROLLBAR

SEARCH

public static final EHTMLRole SEARCH

SECTION

@Deprecated
public static final EHTMLRole SECTION

Deprecated.

SECTIONHEAD

@Deprecated
public static final EHTMLRole SECTIONHEAD

Deprecated.

SELECT

@Deprecated
public static final EHTMLRole SELECT

Deprecated.

SEPARATOR

public static final EHTMLRole SEPARATOR

SLIDER

public static final EHTMLRole SLIDER

SPINBUTTON

public static final EHTMLRole SPINBUTTON

STATUS

public static final EHTMLRole STATUS

STRUCTURE

@Deprecated
public static final EHTMLRole STRUCTURE

Deprecated.

TAB

public static final EHTMLRole TAB

TABLIST

public static final EHTMLRole TABLIST

TABPANEL

public static final EHTMLRole TABPANEL

TEXTBOX

public static final EHTMLRole TEXTBOX

TIMER

public static final EHTMLRole TIMER

TOOLBAR

public static final EHTMLRole TOOLBAR

TOOLTIP

public static final EHTMLRole TOOLTIP

TREE

public static final EHTMLRole TREE

TREEGRID

public static final EHTMLRole TREEGRID

TREEITEM

public static final EHTMLRole TREEITEM

WIDGET

@Deprecated
public static final EHTMLRole WIDGET

Deprecated.

WINDOW

@Deprecated
public static final EHTMLRole WINDOW

Deprecated.

Method Detail

values

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

Returns:

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

valueOf

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

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getType

@Nonnull
public EHTMLRoleType getType()

isAbstract

public boolean isAbstract()

getDescription

@Nonnull
@Nonempty
public String getDescription()

getFromIDOrNull

@Nullable
public static EHTMLRole getFromIDOrNull(@Nullable
                                        String sID)