- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIForm
-
- javax.faces.component.html.HtmlForm
-
- All Implemented Interfaces:
- 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 thesetRendererType()
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description protected static class
HtmlForm.PropertyKeys
-
Field Summary
Fields Modifier and Type Field and Description static String
COMPONENT_TYPE
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 Constructor and Description HtmlForm()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description String
getAccept()
Return the value of theaccept
property.String
getAcceptcharset()
Return the value of theacceptcharset
property.String
getDefaultEventName()
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.String
getDir()
Return the value of thedir
property.String
getEnctype()
Return the value of theenctype
property.Collection<String>
getEventNames()
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.String
getLang()
Return the value of thelang
property.String
getOnclick()
Return the value of theonclick
property.String
getOndblclick()
Return the value of theondblclick
property.String
getOnkeydown()
Return the value of theonkeydown
property.String
getOnkeypress()
Return the value of theonkeypress
property.String
getOnkeyup()
Return the value of theonkeyup
property.String
getOnmousedown()
Return the value of theonmousedown
property.String
getOnmousemove()
Return the value of theonmousemove
property.String
getOnmouseout()
Return the value of theonmouseout
property.String
getOnmouseover()
Return the value of theonmouseover
property.String
getOnmouseup()
Return the value of theonmouseup
property.String
getOnreset()
Return the value of theonreset
property.String
getOnsubmit()
Return the value of theonsubmit
property.String
getRole()
Return the value of therole
property.String
getStyle()
Return the value of thestyle
property.String
getStyleClass()
Return the value of thestyleClass
property.String
getTarget()
Return the value of thetarget
property.String
getTitle()
Return the value of thetitle
property.void
setAccept(String accept)
Set the value of theaccept
property.void
setAcceptcharset(String acceptcharset)
Set the value of theacceptcharset
property.void
setDir(String dir)
Set the value of thedir
property.void
setEnctype(String enctype)
Set the value of theenctype
property.void
setLang(String lang)
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
setRole(String role)
Set the value of therole
property.void
setStyle(String style)
Set the value of thestyle
property.void
setStyleClass(String styleClass)
Set the value of thestyleClass
property.void
setTarget(String target)
Set the value of thetarget
property.void
setTitle(String title)
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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAccept
public String getAccept()
Return the value of the
accept
property.Contents: List of content types that a server processing this form will handle correctly
-
setAccept
public void setAccept(String accept)
Set the value of the
accept
property.
-
getAcceptcharset
public String 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
public void setAcceptcharset(String acceptcharset)
Set the value of the
acceptcharset
property.
-
getDir
public String 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
public void setDir(String dir)
Set the value of the
dir
property.
-
getEnctype
public String 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
public void setEnctype(String enctype)
Set the value of the
enctype
property.
-
getLang
public String getLang()
Return the value of the
lang
property.Contents: Code describing the language used in the generated markup for this component.
-
setLang
public void setLang(String lang)
Set the value of the
lang
property.
-
getOnclick
public String getOnclick()
Return the value of the
onclick
property.Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
public void setOnclick(String onclick)
Set the value of the
onclick
property.
-
getOndblclick
public String getOndblclick()
Return the value of the
ondblclick
property.Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
public void setOndblclick(String ondblclick)
Set the value of the
ondblclick
property.
-
getOnkeydown
public String getOnkeydown()
Return the value of the
onkeydown
property.Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
public void setOnkeydown(String onkeydown)
Set the value of the
onkeydown
property.
-
getOnkeypress
public String getOnkeypress()
Return the value of the
onkeypress
property.Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
public void setOnkeypress(String onkeypress)
Set the value of the
onkeypress
property.
-
getOnkeyup
public String getOnkeyup()
Return the value of the
onkeyup
property.Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
public void setOnkeyup(String onkeyup)
Set the value of the
onkeyup
property.
-
getOnmousedown
public String getOnmousedown()
Return the value of the
onmousedown
property.Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
public void setOnmousedown(String onmousedown)
Set the value of the
onmousedown
property.
-
getOnmousemove
public String getOnmousemove()
Return the value of the
onmousemove
property.Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
public void setOnmousemove(String onmousemove)
Set the value of the
onmousemove
property.
-
getOnmouseout
public String getOnmouseout()
Return the value of the
onmouseout
property.Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
public void setOnmouseout(String onmouseout)
Set the value of the
onmouseout
property.
-
getOnmouseover
public String getOnmouseover()
Return the value of the
onmouseover
property.Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
public void setOnmouseover(String onmouseover)
Set the value of the
onmouseover
property.
-
getOnmouseup
public String getOnmouseup()
Return the value of the
onmouseup
property.Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
public void setOnmouseup(String onmouseup)
Set the value of the
onmouseup
property.
-
getOnreset
public String getOnreset()
Return the value of the
onreset
property.Contents: Javascript code executed when this form is reset.
-
setOnreset
public void setOnreset(String onreset)
Set the value of the
onreset
property.
-
getOnsubmit
public String getOnsubmit()
Return the value of the
onsubmit
property.Contents: Javascript code executed when this form is submitted.
-
setOnsubmit
public void setOnsubmit(String onsubmit)
Set the value of the
onsubmit
property.
-
getRole
public String 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
public void setRole(String role)
Set the value of the
role
property.
-
getStyle
public String getStyle()
Return the value of the
style
property.Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
public void setStyle(String style)
Set the value of the
style
property.
-
getStyleClass
public String 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
public void setStyleClass(String styleClass)
Set the value of the
styleClass
property.
-
getTarget
public String 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
public void setTarget(String target)
Set the value of the
target
property.
-
getTitle
public String getTitle()
Return the value of the
title
property.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
public void setTitle(String title)
Set the value of the
title
property.
-
getEventNames
public Collection<String> 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
public String 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
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 15:08:34 Cette version de la page est en cache (à la date du 21/08/2025 15:08:34) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 07/10/2007, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/faces/component/html/htmlform.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.