- All Implemented Interfaces:
ClientBehaviorHolder
,NamingContainer
,PartialStateHolder
,StateHolder
,TransientStateHolder
,UniqueIdVendor
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
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 "jakarta.faces.Form
". This value can
be changed by calling the setRendererType()
method.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static enum
Properties used by this component -
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The standard component type for this component.Fields inherited from class jakarta.faces.component.UIForm
COMPONENT_FAMILY
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
Fields inherited from interface jakarta.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
-
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 jakarta.faces.component.UIForm
createUniqueId, getContainerClientId, getFamily, invokeOnComponent, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted, visitTree
Methods inherited from class jakarta.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, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class jakarta.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 jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Field Details
-
COMPONENT_TYPE
-
-
Constructor Details
-
HtmlForm
public HtmlForm()
-
-
Method Details
-
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
Set the value of the
accept
property.- Parameters:
accept
- the new property value
-
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
Set the value of the
acceptcharset
property.- Parameters:
acceptcharset
- the new property value
-
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
Set the value of the
dir
property.- Parameters:
dir
- the new property value
-
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
Set the value of the
enctype
property.- Parameters:
enctype
- the new property value
-
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
Set the value of the
lang
property.- Parameters:
lang
- the new property value
-
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
Set the value of the
onclick
property.- Parameters:
onclick
- the new property value
-
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
Set the value of the
ondblclick
property.- Parameters:
ondblclick
- the new property value
-
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
Set the value of the
onkeydown
property.- Parameters:
onkeydown
- the new property value
-
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
Set the value of the
onkeypress
property.- Parameters:
onkeypress
- the new property value
-
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
Set the value of the
onkeyup
property.- Parameters:
onkeyup
- the new property value
-
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
Set the value of the
onmousedown
property.- Parameters:
onmousedown
- the new property value
-
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
Set the value of the
onmousemove
property.- Parameters:
onmousemove
- the new property value
-
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
Set the value of the
onmouseout
property.- Parameters:
onmouseout
- the new property value
-
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
Set the value of the
onmouseover
property.- Parameters:
onmouseover
- the new property value
-
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
Set the value of the
onmouseup
property.- Parameters:
onmouseup
- the new property value
-
getOnreset
Return the value of the
onreset
property.- Returns:
- the property value
Contents: Javascript code executed when this form is reset.
-
setOnreset
Set the value of the
onreset
property.- Parameters:
onreset
- the new property value
-
getOnsubmit
Return the value of the
onsubmit
property.- Returns:
- the property value
Contents: Javascript code executed when this form is submitted.
-
setOnsubmit
Set the value of the
onsubmit
property.- Parameters:
onsubmit
- the new property value
-
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
Set the value of the
role
property.- Parameters:
role
- the new property value
-
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
Set the value of the
style
property.- Parameters:
style
- the new property value
-
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
Set the value of the
styleClass
property.- Parameters:
styleClass
- the new property value
-
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
Set the value of the
target
property.- Parameters:
target
- the new property value
-
getTitle
Return the value of the
title
property.- Returns:
- the property value
Contents: Advisory title information about markup elements generated for this component.
-
setTitle
Set the value of the
title
property.- Parameters:
title
- the new property value
-
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
- Returns:
- the collection of event names.
-
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
- Returns:
- the default event name.
-