Package javax.faces.component.html

Class HtmlForm

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIForm

javax.faces.component.html.HtmlForm

All Implemented Interfaces:

java.util.EventListener, ClientBehaviorHolder, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class HtmlForm
extends UIForm
implements ClientBehaviorHolder

Represents an HTML form element. Child input components will be submitted unless they have been disabled.

By default, the rendererType property must be set to "javax.faces.Form". This value can be changed by calling the setRendererType() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HtmlForm.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMPONENT_TYPE	The standard component type for this component.

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from class javax.faces.component.UIForm

COMPONENT_FAMILY

Constructor Summary

Constructors

Constructor	Description
HtmlForm()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccept()	Return the value of the accept property.
java.lang.String	getAcceptcharset()	Return the value of the acceptcharset property.
java.lang.String	getDefaultEventName()	This is a default implementation of ClientBehaviorHolder.getDefaultEventName().
java.lang.String	getDir()	Return the value of the dir property.
java.lang.String	getEnctype()	Return the value of the enctype property.
java.util.Collection<java.lang.String>	getEventNames()	This is a default implementation of ClientBehaviorHolder.getEventNames().
java.lang.String	getLang()	Return the value of the lang property.
java.lang.String	getOnclick()	Return the value of the onclick property.
java.lang.String	getOndblclick()	Return the value of the ondblclick property.
java.lang.String	getOnkeydown()	Return the value of the onkeydown property.
java.lang.String	getOnkeypress()	Return the value of the onkeypress property.
java.lang.String	getOnkeyup()	Return the value of the onkeyup property.
java.lang.String	getOnmousedown()	Return the value of the onmousedown property.
java.lang.String	getOnmousemove()	Return the value of the onmousemove property.
java.lang.String	getOnmouseout()	Return the value of the onmouseout property.
java.lang.String	getOnmouseover()	Return the value of the onmouseover property.
java.lang.String	getOnmouseup()	Return the value of the onmouseup property.
java.lang.String	getOnreset()	Return the value of the onreset property.
java.lang.String	getOnsubmit()	Return the value of the onsubmit property.
java.lang.String	getRole()	Return the value of the role property.
java.lang.String	getStyle()	Return the value of the style property.
java.lang.String	getStyleClass()	Return the value of the styleClass property.
java.lang.String	getTarget()	Return the value of the target property.
java.lang.String	getTitle()	Return the value of the title property.
void	setAccept(java.lang.String accept)	Set the value of the accept property.
void	setAcceptcharset(java.lang.String acceptcharset)	Set the value of the acceptcharset property.
void	setDir(java.lang.String dir)	Set the value of the dir property.
void	setEnctype(java.lang.String enctype)	Set the value of the enctype property.
void	setLang(java.lang.String lang)	Set the value of the lang property.
void	setOnclick(java.lang.String onclick)	Set the value of the onclick property.
void	setOndblclick(java.lang.String ondblclick)	Set the value of the ondblclick property.
void	setOnkeydown(java.lang.String onkeydown)	Set the value of the onkeydown property.
void	setOnkeypress(java.lang.String onkeypress)	Set the value of the onkeypress property.
void	setOnkeyup(java.lang.String onkeyup)	Set the value of the onkeyup property.
void	setOnmousedown(java.lang.String onmousedown)	Set the value of the onmousedown property.
void	setOnmousemove(java.lang.String onmousemove)	Set the value of the onmousemove property.
void	setOnmouseout(java.lang.String onmouseout)	Set the value of the onmouseout property.
void	setOnmouseover(java.lang.String onmouseover)	Set the value of the onmouseover property.
void	setOnmouseup(java.lang.String onmouseup)	Set the value of the onmouseup property.
void	setOnreset(java.lang.String onreset)	Set the value of the onreset property.
void	setOnsubmit(java.lang.String onsubmit)	Set the value of the onsubmit property.
void	setRole(java.lang.String role)	Set the value of the role property.
void	setStyle(java.lang.String style)	Set the value of the style property.
void	setStyleClass(java.lang.String styleClass)	Set the value of the styleClass property.
void	setTarget(java.lang.String target)	Set the value of the target property.
void	setTitle(java.lang.String title)	Set the value of the title property.

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from class java.lang.Object

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIForm

createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted, visitTree

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

Constructor Detail

HtmlForm

public HtmlForm()

Method Detail

getAccept

public java.lang.String getAccept()

Return the value of the accept property.

Returns:

the property value

Contents: List of content types that a server processing this form will handle correctly

setAccept

public void setAccept(java.lang.String accept)

Set the value of the accept property.

Parameters:

accept - the new property value

getAcceptcharset

public java.lang.String getAcceptcharset()

Return the value of the acceptcharset property.

Returns:

the property value

Contents: List of character encodings for input data that are accepted by the server processing this form.

setAcceptcharset

public void setAcceptcharset(java.lang.String acceptcharset)

Set the value of the acceptcharset property.

Parameters:

acceptcharset - the new property value

getDir

public java.lang.String getDir()

Return the value of the dir property.

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.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

Parameters:

dir - the new property value

getEnctype

public java.lang.String getEnctype()

Return the value of the enctype property.

Returns:

the property value

Contents: Content type used to submit the form to the server. If not specified, the default value is "application/x-www-form-urlencoded".

setEnctype

public void setEnctype(java.lang.String enctype)

Set the value of the enctype property.

Parameters:

enctype - the new property value

getLang

public java.lang.String getLang()

Return the value of the lang property.

Returns:

the property value

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

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

Parameters:

lang - the new property value

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property.

Returns:

the property value

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

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

Parameters:

onclick - the new property value

getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property.

Returns:

the property value

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

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.

Parameters:

ondblclick - the new property value

getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property.

Returns:

the property value

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

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.

Parameters:

onkeydown - the new property value

getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property.

Returns:

the property value

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

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.

Parameters:

onkeypress - the new property value

getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property.

Returns:

the property value

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

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.

Parameters:

onkeyup - the new property value

getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property.

Returns:

the property value

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

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.

Parameters:

onmousedown - the new property value

getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property.

Returns:

the property value

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

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.

Parameters:

onmousemove - the new property value

getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property.

Returns:

the property value

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

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.

Parameters:

onmouseout - the new property value

getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property.

Returns:

the property value

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

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.

Parameters:

onmouseover - the new property value

getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property.

Returns:

the property value

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

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.

Parameters:

onmouseup - the new property value

getOnreset

public java.lang.String getOnreset()

Return the value of the onreset property.

Returns:

the property value

Contents: Javascript code executed when this form is reset.

setOnreset

public void setOnreset(java.lang.String onreset)

Set the value of the onreset property.

Parameters:

onreset - the new property value

getOnsubmit

public java.lang.String getOnsubmit()

Return the value of the onsubmit property.

Returns:

the property value

Contents: Javascript code executed when this form is submitted.

setOnsubmit

public void setOnsubmit(java.lang.String onsubmit)

Set the value of the onsubmit property.

Parameters:

onsubmit - the new property value

getRole

public java.lang.String getRole()

Return the value of the role property.

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.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

Parameters:

role - the new property value

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Returns:

the property value

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

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Parameters:

style - the new property value

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

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.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Parameters:

styleClass - the new property value

getTarget

public java.lang.String getTarget()

Return the value of the target property.

Returns:

the property value

Contents: Name of a frame where the response retrieved after this form submit is to be displayed.

setTarget

public void setTarget(java.lang.String target)

Set the value of the target property.

Parameters:

target - the new property value

getTitle

public java.lang.String getTitle()

Return the value of the title property.

Returns:

the property value

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

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

Parameters:

title - the new property value

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Description copied from class: UIComponentBase

This is a default implementation of ClientBehaviorHolder.getEventNames(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports.

Specified by:

getEventNames in interface ClientBehaviorHolder

Overrides:

getEventNames in class UIComponentBase

Returns:

the collection of event names.

getDefaultEventName

public java.lang.String getDefaultEventName()

Description copied from class: UIComponentBase

This is a default implementation of ClientBehaviorHolder.getDefaultEventName(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must provide an implementation of ClientBehaviorHolder.getEventNames().

Specified by:

getDefaultEventName in interface ClientBehaviorHolder

Overrides:

getDefaultEventName in class UIComponentBase

Returns:

the default event name.