Modifier and Type	Class and Description
protected static enum	HtmlBody.PropertyKeys The property keys.

Modifier and Type	Field and Description
public static final String	COMPONENT_TYPE Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE. The standard component type for this component.
private static final Collection<String>	EVENT_NAMES

Access	Constructor and Description
public	HtmlBody() Default constructor setting the renderer type.

Method Summary

Modifier and Type	Method and Description
public String	getDefaultEventName() Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName. Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName. Returns the default event name for this `ClientBehaviorHolder` implementation.
public String	Returns: the property value Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case. getDir() Return the value of the `dir` property.
public Collection<String>	getEventNames() Overrides jakarta.faces.component.UIComponentBase.getEventNames. Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames. Returns a non-null, unmodifiable `Collection` containing the names of the logical events supported by the component implementing this interface.
public String	Returns: the property value Contents: Code describing the language used in the generated markup for this component. getLang() Return the value of the `lang` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is clicked over this element. getOnclick() Return the value of the `onclick` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is double clicked over this element. getOndblclick() Return the value of the `ondblclick` property.
public String	Returns: the property value Contents: Javascript code executed when a key is pressed down over this element. getOnkeydown() Return the value of the `onkeydown` property.
public String	Returns: the property value Contents: Javascript code executed when a key is pressed and released over this element. getOnkeypress() Return the value of the `onkeypress` property.
public String	Returns: the property value Contents: Javascript code executed when a key is released over this element. getOnkeyup() Return the value of the `onkeyup` property.
public String	Returns: the property value getOnload() Return the value of the `onload` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is pressed down over this element. getOnmousedown() Return the value of the `onmousedown` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is moved within this element. getOnmousemove() Return the value of the `onmousemove` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is moved away from this element. getOnmouseout() Return the value of the `onmouseout` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is moved onto this element. getOnmouseover() Return the value of the `onmouseover` property.
public String	Returns: the property value Contents: Javascript code executed when a pointer button is released over this element. getOnmouseup() Return the value of the `onmouseup` property.
public String	Returns: the property value getOnunload() Return the value of the `onunload` property.
public String	Returns: the property value Contents: Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute. getRole() Return the value of the `role` property.
public String	Returns: the property value Contents: CSS style(s) to be applied when this component is rendered. getStyle() Return the value of the `style` property.
public String	Returns: the property value Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. getStyleClass() Return the value of the `styleClass` property.
public String	Returns: the property value Contents: Advisory title information about markup elements generated for this component. getTitle() Return the value of the `title` property.
public String	Returns: the property value Contents: An XML Namespace to be passed through to the rendered element getXmlns() Return the value of the `xmlns` property.
public void	setDir(String the new property value dir) Set the value of the `dir` property.
public void	setLang(String the new property value lang) Set the value of the `lang` property.
public void	setOnclick(String the new property value onclick) Set the value of the `onclick` property.
public void	setOndblclick(String the new property value ondblclick) Set the value of the `ondblclick` property.
public void	setOnkeydown(String the new property value onkeydown) Set the value of the `onkeydown` property.
public void	setOnkeypress(String the new property value onkeypress) Set the value of the `onkeypress` property.
public void	setOnkeyup(String the new property value onkeyup) Set the value of the `onkeyup` property.
public void	setOnload(String the new property value onload) Set the value of the `onload` property.
public void	setOnmousedown(String the new property value onmousedown) Set the value of the `onmousedown` property.
public void	setOnmousemove(String the new property value onmousemove) Set the value of the `onmousemove` property.
public void	setOnmouseout(String the new property value onmouseout) Set the value of the `onmouseout` property.
public void	setOnmouseover(String the new property value onmouseover) Set the value of the `onmouseover` property.
public void	setOnmouseup(String the new property value onmouseup) Set the value of the `onmouseup` property.
public void	setOnunload(String the new property value onunload) Set the value of the `onunload` property.
public void	setRole(String the new property value role) Set the value of the `role` property.
public void	setStyle(String the new property value style) Set the value of the `style` property.
public void	setStyleClass(String the new property value styleClass) Set the value of the `styleClass` property.
public void	setTitle(String the new property value title) Set the value of the `title` property.
public void	setXmlns(String the new property value xmlns) Set the value of the `xmlns` property.

Inherited from jakarta.faces.component.UIOutput:: clearInitialState getConverter getFamily getLocalValue getValue markInitialState resetValue restoreState saveState setConverter setValue

Field Detail

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE. The standard component type for this component.

COMPONENT_TYPE

back to summary

public static final String COMPONENT_TYPE

Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE.

The standard component type for this component.

EVENT_NAMES	back to summary
private static final Collection<String> EVENT_NAMES

Constructor Detail

HtmlBody	back to summary
public HtmlBody() Default constructor setting the renderer type.

Method Detail

getDefaultEventName back to summary

getDefaultEventName	back to summary
public String getDefaultEventName() Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName. Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName. Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName. Returns the default event name for this `ClientBehaviorHolder` implementation. This must be one of the event names returned by `getEventNames` or null if the component does not have a default event. Returns:String the default event name. Annotations @Override

public String getDefaultEventName()

Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation. This must be one of the event names returned by getEventNames or null if the component does not have a default event.

Returns:String

the default event name.

Annotations

@Override

getDir back to summary

getDir	back to summary
public String getDir() Return the value of the `dir` property. Returns:String the property value Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

public String getDir()

Return the value of the dir property.

Returns:String

the property value

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

getEventNames back to summary

getEventNames	back to summary
public Collection<String> getEventNames() Overrides jakarta.faces.component.UIComponentBase.getEventNames. Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames. Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames. Returns a non-null, unmodifiable `Collection` containing the names of the logical events supported by the component implementing this interface. Returns:Collection<String> an unmodifiable collection of event names. Annotations @Override

public Collection<String> getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

Returns:Collection<String>

an unmodifiable collection of event names.

Annotations

@Override

getLang back to summary

getLang	back to summary
public String getLang() Return the value of the `lang` property. Returns:String the property value Contents: Code describing the language used in the generated markup for this component.

public String getLang()

Return the value of the lang property.

Returns:String

the property value

Contents: Code describing the language used in the generated markup for this component.

getOnclick back to summary

getOnclick	back to summary
public String getOnclick() Return the value of the `onclick` property. Returns:String the property value Contents: Javascript code executed when a pointer button is clicked over this element.

public String getOnclick()

Return the value of the onclick property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is clicked over this element.

getOndblclick back to summary

getOndblclick	back to summary
public String getOndblclick() Return the value of the `ondblclick` property. Returns:String the property value Contents: Javascript code executed when a pointer button is double clicked over this element.

public String getOndblclick()

Return the value of the ondblclick property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is double clicked over this element.

getOnkeydown back to summary

getOnkeydown	back to summary
public String getOnkeydown() Return the value of the `onkeydown` property. Returns:String the property value Contents: Javascript code executed when a key is pressed down over this element.

public String getOnkeydown()

Return the value of the onkeydown property.

Returns:String

the property value

Contents: Javascript code executed when a key is pressed down over this element.

getOnkeypress back to summary

getOnkeypress	back to summary
public String getOnkeypress() Return the value of the `onkeypress` property. Returns:String the property value Contents: Javascript code executed when a key is pressed and released over this element.

public String getOnkeypress()

Return the value of the onkeypress property.

Returns:String

the property value

Contents: Javascript code executed when a key is pressed and released over this element.

getOnkeyup back to summary

getOnkeyup	back to summary
public String getOnkeyup() Return the value of the `onkeyup` property. Returns:String the property value Contents: Javascript code executed when a key is released over this element.

public String getOnkeyup()

Return the value of the onkeyup property.

Returns:String

the property value

Contents: Javascript code executed when a key is released over this element.

getOnload back to summary

getOnload	back to summary
public String getOnload() Return the value of the `onload` property. Returns:String the property value

public String getOnload()

Return the value of the onload property.

Returns:String: the property value

getOnmousedown back to summary

getOnmousedown	back to summary
public String getOnmousedown() Return the value of the `onmousedown` property. Returns:String the property value Contents: Javascript code executed when a pointer button is pressed down over this element.

public String getOnmousedown()

Return the value of the onmousedown property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is pressed down over this element.

getOnmousemove back to summary

getOnmousemove	back to summary
public String getOnmousemove() Return the value of the `onmousemove` property. Returns:String the property value Contents: Javascript code executed when a pointer button is moved within this element.

public String getOnmousemove()

Return the value of the onmousemove property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is moved within this element.

getOnmouseout back to summary

getOnmouseout	back to summary
public String getOnmouseout() Return the value of the `onmouseout` property. Returns:String the property value Contents: Javascript code executed when a pointer button is moved away from this element.

public String getOnmouseout()

Return the value of the onmouseout property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is moved away from this element.

getOnmouseover back to summary

getOnmouseover	back to summary
public String getOnmouseover() Return the value of the `onmouseover` property. Returns:String the property value Contents: Javascript code executed when a pointer button is moved onto this element.

public String getOnmouseover()

Return the value of the onmouseover property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is moved onto this element.

getOnmouseup back to summary

getOnmouseup	back to summary
public String getOnmouseup() Return the value of the `onmouseup` property. Returns:String the property value Contents: Javascript code executed when a pointer button is released over this element.

public String getOnmouseup()

Return the value of the onmouseup property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is released over this element.

getOnunload back to summary

getOnunload	back to summary
public String getOnunload() Return the value of the `onunload` property. Returns:String the property value

public String getOnunload()

Return the value of the onunload property.

Returns:String: the property value

getRole back to summary

getRole	back to summary
public String getRole() Return the value of the `role` property. Returns:String the property value Contents: Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

public String getRole()

Return the value of the role property.

Returns:String

the property value

Contents:

Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

getStyle back to summary

getStyle	back to summary
public String getStyle() Return the value of the `style` property. Returns:String the property value Contents: CSS style(s) to be applied when this component is rendered.

public String getStyle()

Return the value of the style property.

Returns:String

the property value

Contents: CSS style(s) to be applied when this component is rendered.

getStyleClass back to summary

getStyleClass	back to summary
public String getStyleClass() Return the value of the `styleClass` property. Returns:String the property value Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

public String getStyleClass()

Return the value of the styleClass property.

Returns:String

the property value

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

getTitle back to summary

getTitle	back to summary
public String getTitle() Return the value of the `title` property. Returns:String the property value Contents: Advisory title information about markup elements generated for this component.

public String getTitle()

Return the value of the title property.

Returns:String

the property value

Contents: Advisory title information about markup elements generated for this component.

getXmlns back to summary

getXmlns	back to summary
public String getXmlns() Return the value of the `xmlns` property. Returns:String the property value Contents: An XML Namespace to be passed through to the rendered element

public String getXmlns()

Return the value of the xmlns property.

Returns:String

the property value

Contents:

An XML Namespace to be passed through to the rendered element

setDir back to summary

setDir	back to summary
public void setDir(String dir) Set the value of the `dir` property. Parameters dir:String the new property value

public void setDir(String dir)

Set the value of the dir property.

Parameters

dir:String: the new property value

setLang back to summary

setLang	back to summary
public void setLang(String lang) Set the value of the `lang` property. Parameters lang:String the new property value

public void setLang(String lang)

Set the value of the lang property.

Parameters

lang:String: the new property value

setOnclick back to summary

setOnclick	back to summary
public void setOnclick(String onclick) Set the value of the `onclick` property. Parameters onclick:String the new property value

public void setOnclick(String onclick)

Set the value of the onclick property.

Parameters

onclick:String: the new property value

setOndblclick back to summary

setOndblclick	back to summary
public void setOndblclick(String ondblclick) Set the value of the `ondblclick` property. Parameters ondblclick:String the new property value

public void setOndblclick(String ondblclick)

Set the value of the ondblclick property.

Parameters

ondblclick:String: the new property value

setOnkeydown back to summary

setOnkeydown	back to summary
public void setOnkeydown(String onkeydown) Set the value of the `onkeydown` property. Parameters onkeydown:String the new property value

public void setOnkeydown(String onkeydown)

Set the value of the onkeydown property.

Parameters

onkeydown:String: the new property value

setOnkeypress back to summary

setOnkeypress	back to summary
public void setOnkeypress(String onkeypress) Set the value of the `onkeypress` property. Parameters onkeypress:String the new property value

public void setOnkeypress(String onkeypress)

Set the value of the onkeypress property.

Parameters

onkeypress:String: the new property value

setOnkeyup back to summary

setOnkeyup	back to summary
public void setOnkeyup(String onkeyup) Set the value of the `onkeyup` property. Parameters onkeyup:String the new property value

public void setOnkeyup(String onkeyup)

Set the value of the onkeyup property.

Parameters

onkeyup:String: the new property value

setOnload back to summary

setOnload	back to summary
public void setOnload(String onload) Set the value of the `onload` property. Parameters onload:String the new property value

public void setOnload(String onload)

Set the value of the onload property.

Parameters

onload:String: the new property value

setOnmousedown back to summary

setOnmousedown	back to summary
public void setOnmousedown(String onmousedown) Set the value of the `onmousedown` property. Parameters onmousedown:String the new property value

public void setOnmousedown(String onmousedown)

Set the value of the onmousedown property.

Parameters

onmousedown:String: the new property value

setOnmousemove back to summary

setOnmousemove	back to summary
public void setOnmousemove(String onmousemove) Set the value of the `onmousemove` property. Parameters onmousemove:String the new property value

public void setOnmousemove(String onmousemove)

Set the value of the onmousemove property.

Parameters

onmousemove:String: the new property value

setOnmouseout back to summary

setOnmouseout	back to summary
public void setOnmouseout(String onmouseout) Set the value of the `onmouseout` property. Parameters onmouseout:String the new property value

public void setOnmouseout(String onmouseout)

Set the value of the onmouseout property.

Parameters

onmouseout:String: the new property value

setOnmouseover back to summary

setOnmouseover	back to summary
public void setOnmouseover(String onmouseover) Set the value of the `onmouseover` property. Parameters onmouseover:String the new property value

public void setOnmouseover(String onmouseover)

Set the value of the onmouseover property.

Parameters

onmouseover:String: the new property value

setOnmouseup back to summary

setOnmouseup	back to summary
public void setOnmouseup(String onmouseup) Set the value of the `onmouseup` property. Parameters onmouseup:String the new property value

public void setOnmouseup(String onmouseup)

Set the value of the onmouseup property.

Parameters

onmouseup:String: the new property value

setOnunload back to summary

setOnunload	back to summary
public void setOnunload(String onunload) Set the value of the `onunload` property. Parameters onunload:String the new property value

public void setOnunload(String onunload)

Set the value of the onunload property.

Parameters

onunload:String: the new property value

setRole back to summary

setRole	back to summary
public void setRole(String role) Set the value of the `role` property. Parameters role:String the new property value

public void setRole(String role)

Set the value of the role property.

Parameters

role:String: the new property value

setStyle back to summary

setStyle	back to summary
public void setStyle(String style) Set the value of the `style` property. Parameters style:String the new property value

public void setStyle(String style)

Set the value of the style property.

Parameters

style:String: the new property value

setStyleClass back to summary

setStyleClass	back to summary
public void setStyleClass(String styleClass) Set the value of the `styleClass` property. Parameters styleClass:String the new property value

public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters

styleClass:String: the new property value

setTitle back to summary

setTitle	back to summary
public void setTitle(String title) Set the value of the `title` property. Parameters title:String the new property value

public void setTitle(String title)

Set the value of the title property.

Parameters

title:String: the new property value

setXmlns back to summary

setXmlns	back to summary
public void setXmlns(String xmlns) Set the value of the `xmlns` property. Parameters xmlns:String the new property value

public void setXmlns(String xmlns)

Set the value of the xmlns property.

Parameters

xmlns:String: the new property value

jakarta.faces.component.html back to summary

protected final Enum HtmlBody.PropertyKeys

Class Inheritance

extends Enum<HtmlBody.PropertyKeys>

java.lang.Object
java.lang.Enum
jakarta.faces.component.html.HtmlBody.PropertyKeys

The property keys.

Field Summary

Modifier and Type	Field and Description
public static final HtmlBody.PropertyKeys	dir
public static final HtmlBody.PropertyKeys	lang
public static final HtmlBody.PropertyKeys	onclick
public static final HtmlBody.PropertyKeys	ondblclick
public static final HtmlBody.PropertyKeys	onkeydown
public static final HtmlBody.PropertyKeys	onkeypress
public static final HtmlBody.PropertyKeys	onkeyup
public static final HtmlBody.PropertyKeys	onload
public static final HtmlBody.PropertyKeys	onmousedown
public static final HtmlBody.PropertyKeys	onmousemove
public static final HtmlBody.PropertyKeys	onmouseout
public static final HtmlBody.PropertyKeys	onmouseover
public static final HtmlBody.PropertyKeys	onmouseup
public static final HtmlBody.PropertyKeys	onunload
public static final HtmlBody.PropertyKeys	role
public static final HtmlBody.PropertyKeys	style
public static final HtmlBody.PropertyKeys	styleClass
public static final HtmlBody.PropertyKeys	title
pack-priv String	toString
public static final HtmlBody.PropertyKeys	xmlns

Constructor Summary

Access	Constructor and Description
private	PropertyKeys(String toString)
private	PropertyKeys()

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static HtmlBody.PropertyKeys	valueOf(String name)
public static HtmlBody.PropertyKeys[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

dir	back to summary
public static final HtmlBody.PropertyKeys dir

lang	back to summary
public static final HtmlBody.PropertyKeys lang

onclick	back to summary
public static final HtmlBody.PropertyKeys onclick

ondblclick	back to summary
public static final HtmlBody.PropertyKeys ondblclick

onkeydown	back to summary
public static final HtmlBody.PropertyKeys onkeydown

onkeypress	back to summary
public static final HtmlBody.PropertyKeys onkeypress

onkeyup	back to summary
public static final HtmlBody.PropertyKeys onkeyup

onload	back to summary
public static final HtmlBody.PropertyKeys onload

onmousedown	back to summary
public static final HtmlBody.PropertyKeys onmousedown

onmousemove	back to summary
public static final HtmlBody.PropertyKeys onmousemove

onmouseout	back to summary
public static final HtmlBody.PropertyKeys onmouseout

onmouseover	back to summary
public static final HtmlBody.PropertyKeys onmouseover

onmouseup	back to summary
public static final HtmlBody.PropertyKeys onmouseup

onunload	back to summary
public static final HtmlBody.PropertyKeys onunload

role	back to summary
public static final HtmlBody.PropertyKeys role

style	back to summary
public static final HtmlBody.PropertyKeys style

styleClass	back to summary
public static final HtmlBody.PropertyKeys styleClass

title	back to summary
public static final HtmlBody.PropertyKeys title

toString	back to summary
pack-priv String toString

xmlns	back to summary
public static final HtmlBody.PropertyKeys xmlns

Constructor Detail

PropertyKeys	back to summary
private PropertyKeys(String toString)

PropertyKeys	back to summary
private PropertyKeys()

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static HtmlBody.PropertyKeys valueOf(String name)

values	back to summary
public static HtmlBody.PropertyKeys[] values()

public Class HtmlBody

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Enum HtmlBody.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail