Class HtmlEvents

java.lang.Object

jakarta.faces.component.html.HtmlEvents

public final class HtmlEvents
extends Object

Events supported by HTML elements as per current spec. These can be used to supply ClientBehaviorHolder.getEventNames() and ClientBehaviorHolder.getDefaultEventName().

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HtmlEvents.HtmlBodyElementEvent	Events supported by all HTML body elements, in addition to the events supported by all HTML document elements.
static enum	HtmlEvents.HtmlDocumentElementEvent	Events supported by all HTML document elements.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_HTML_EVENT_NAMES_PARAM_NAME	The name of the context-param whose value must represent a space-separated list of additional HTML event names.

Method Summary

Modifier and Type	Method	Description
static Collection<String>	getAdditionalHtmlEventNames(FacesContext context)
static Collection<String>	getFacesActionSourceEventNames(FacesContext context)
static Collection<String>	getFacesEditableValueHolderEventNames(FacesContext context)
static Collection<String>	getHtmlBodyElementEventNames(FacesContext context)
static Collection<String>	getHtmlDocumentElementEventNames(FacesContext context)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ADDITIONAL_HTML_EVENT_NAMES_PARAM_NAME

public static final String ADDITIONAL_HTML_EVENT_NAMES_PARAM_NAME

The name of the context-param whose value must represent a space-separated list of additional HTML event names. All supported HTML event names are defined in the enums HtmlEvents.HtmlDocumentElementEvent and HtmlEvents.HtmlBodyElementEvent. Any HTML event name which you wish to add to these enums can be supplied via this context-param. Duplicates will be automatically filtered, case sensitive.

See Also:

• Constant Field Values

Method Details

getAdditionalHtmlEventNames

public static Collection<String> getAdditionalHtmlEventNames(FacesContext context)

Parameters:

context - The involved faces context.

Returns:

All additional HTML event names specified via ADDITIONAL_HTML_EVENT_NAMES_PARAM_NAME.

getHtmlDocumentElementEventNames

public static Collection<String> getHtmlDocumentElementEventNames(FacesContext context)

Parameters:

context - The involved faces context.

Returns:

All supported event names for HTML document elements, including additional HTML event names.

getHtmlBodyElementEventNames

public static Collection<String> getHtmlBodyElementEventNames(FacesContext context)

Parameters:

context - The involved faces context.

Returns:

All supported event names for HTML body elements, including HTML document element event names.

getFacesActionSourceEventNames

public static Collection<String> getFacesActionSourceEventNames(FacesContext context)

Parameters:

context - The involved faces context.

Returns:

All supported event names for HTML implementations of Faces ActionSource components, including HTML body element event names.

getFacesEditableValueHolderEventNames

public static Collection<String> getFacesEditableValueHolderEventNames(FacesContext context)

Parameters:

context - The involved faces context.

Returns:

All supported event names for HTML implementations of Faces EditableValueHolder components, including HTML body element event names.