Class HtmlForm
- All Implemented Interfaces:
EventListener
,ClientBehaviorHolder
,NamingContainer
,PartialStateHolder
,StateHolder
,TransientStateHolder
,UniqueIdVendor
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
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 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The standard component type for this component.Fields inherited from class javax.faces.component.UIForm
COMPONENT_FAMILY
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 interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the value of theaccept
property.Return the value of theacceptcharset
property.This is a default implementation ofClientBehaviorHolder.getDefaultEventName()
.getDir()
Return the value of thedir
property.Return the value of theenctype
property.This is a default implementation ofClientBehaviorHolder.getEventNames()
.getLang()
Return the value of thelang
property.Return the value of theonclick
property.Return the value of theondblclick
property.Return the value of theonkeydown
property.Return the value of theonkeypress
property.Return the value of theonkeyup
property.Return the value of theonmousedown
property.Return the value of theonmousemove
property.Return the value of theonmouseout
property.Return the value of theonmouseover
property.Return the value of theonmouseup
property.Return the value of theonreset
property.Return the value of theonsubmit
property.getRole()
Return the value of therole
property.getStyle()
Return the value of thestyle
property.Return the value of thestyleClass
property.Return the value of thetarget
property.getTitle()
Return the value of thetitle
property.void
Set the value of theaccept
property.void
setAcceptcharset
(String acceptcharset) Set the value of theacceptcharset
property.void
Set the value of thedir
property.void
setEnctype
(String enctype) Set the value of theenctype
property.void
Set the value of thelang
property.void
setOnclick
(String onclick) Set the value of theonclick
property.void
setOndblclick
(String ondblclick) Set the value of theondblclick
property.void
setOnkeydown
(String onkeydown) Set the value of theonkeydown
property.void
setOnkeypress
(String onkeypress) Set the value of theonkeypress
property.void
setOnkeyup
(String onkeyup) Set the value of theonkeyup
property.void
setOnmousedown
(String onmousedown) Set the value of theonmousedown
property.void
setOnmousemove
(String onmousemove) Set the value of theonmousemove
property.void
setOnmouseout
(String onmouseout) Set the value of theonmouseout
property.void
setOnmouseover
(String onmouseover) Set the value of theonmouseover
property.void
setOnmouseup
(String onmouseup) Set the value of theonmouseup
property.void
setOnreset
(String onreset) Set the value of theonreset
property.void
setOnsubmit
(String onsubmit) Set the value of theonsubmit
property.void
Set the value of therole
property.void
Set the value of thestyle
property.void
setStyleClass
(String styleClass) Set the value of thestyleClass
property.void
Set the value of thetarget
property.void
Set the value of thetitle
property.Methods inherited from class javax.faces.component.UIForm
createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted, visitTree
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.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
-
Constructor Details
-
HtmlForm
public HtmlForm()
-
-
Method Details
-
getAccept
Return the value of the
accept
property.Contents: List of content types that a server processing this form will handle correctly
-
setAccept
Set the value of the
accept
property. -
getAcceptcharset
Return the value of the
acceptcharset
property.Contents: List of character encodings for input data that are accepted by the server processing this form.
-
setAcceptcharset
Set the value of the
acceptcharset
property. -
getDir
Return the value of the
dir
property.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
Set the value of the
dir
property. -
getEnctype
Return the value of the
enctype
property.Contents: Content type used to submit the form to the server. If not specified, the default value is "application/x-www-form-urlencoded".
-
setEnctype
Set the value of the
enctype
property. -
getLang
Return the value of the
lang
property.Contents: Code describing the language used in the generated markup for this component.
-
setLang
Set the value of the
lang
property. -
getOnclick
Return the value of the
onclick
property.Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
Set the value of the
onclick
property. -
getOndblclick
Return the value of the
ondblclick
property.Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
Set the value of the
ondblclick
property. -
getOnkeydown
Return the value of the
onkeydown
property.Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
Set the value of the
onkeydown
property. -
getOnkeypress
Return the value of the
onkeypress
property.Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
Set the value of the
onkeypress
property. -
getOnkeyup
Return the value of the
onkeyup
property.Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
Set the value of the
onkeyup
property. -
getOnmousedown
Return the value of the
onmousedown
property.Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
Set the value of the
onmousedown
property. -
getOnmousemove
Return the value of the
onmousemove
property.Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
Set the value of the
onmousemove
property. -
getOnmouseout
Return the value of the
onmouseout
property.Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
Set the value of the
onmouseout
property. -
getOnmouseover
Return the value of the
onmouseover
property.Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
Set the value of the
onmouseover
property. -
getOnmouseup
Return the value of the
onmouseup
property.Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
Set the value of the
onmouseup
property. -
getOnreset
Return the value of the
onreset
property.Contents: Javascript code executed when this form is reset.
-
setOnreset
Set the value of the
onreset
property. -
getOnsubmit
Return the value of the
onsubmit
property.Contents: Javascript code executed when this form is submitted.
-
setOnsubmit
Set the value of the
onsubmit
property. -
getRole
Return the value of the
role
property.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
Set the value of the
role
property. -
getStyle
Return the value of the
style
property.Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
Set the value of the
style
property. -
getStyleClass
Return the value of the
styleClass
property.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
Set the value of the
styleClass
property. -
getTarget
Return the value of the
target
property.Contents: Name of a frame where the response retrieved after this form submit is to be displayed.
-
setTarget
Set the value of the
target
property. -
getTitle
Return the value of the
title
property.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
Set the value of the
title
property. -
getEventNames
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must override this method to return a non-EmptyCollection
of the client event names that the component supports.- Specified by:
getEventNames
in interfaceClientBehaviorHolder
- Overrides:
getEventNames
in classUIComponentBase
-
getDefaultEventName
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must provide an implementation ofClientBehaviorHolder.getEventNames()
.- Specified by:
getDefaultEventName
in interfaceClientBehaviorHolder
- Overrides:
getDefaultEventName
in classUIComponentBase
-