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 StringThe standard component type for this component.Fields inherited from class javax.faces.component.UIForm
COMPONENT_FAMILYFields 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_KEYFields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the value of theacceptproperty.Return the value of theacceptcharsetproperty.This is a default implementation ofClientBehaviorHolder.getDefaultEventName().getDir()Return the value of thedirproperty.Return the value of theenctypeproperty.This is a default implementation ofClientBehaviorHolder.getEventNames().getLang()Return the value of thelangproperty.Return the value of theonclickproperty.Return the value of theondblclickproperty.Return the value of theonkeydownproperty.Return the value of theonkeypressproperty.Return the value of theonkeyupproperty.Return the value of theonmousedownproperty.Return the value of theonmousemoveproperty.Return the value of theonmouseoutproperty.Return the value of theonmouseoverproperty.Return the value of theonmouseupproperty.Return the value of theonresetproperty.Return the value of theonsubmitproperty.getRole()Return the value of theroleproperty.getStyle()Return the value of thestyleproperty.Return the value of thestyleClassproperty.Return the value of thetargetproperty.getTitle()Return the value of thetitleproperty.voidSet the value of theacceptproperty.voidsetAcceptcharset(String acceptcharset) Set the value of theacceptcharsetproperty.voidSet the value of thedirproperty.voidsetEnctype(String enctype) Set the value of theenctypeproperty.voidSet the value of thelangproperty.voidsetOnclick(String onclick) Set the value of theonclickproperty.voidsetOndblclick(String ondblclick) Set the value of theondblclickproperty.voidsetOnkeydown(String onkeydown) Set the value of theonkeydownproperty.voidsetOnkeypress(String onkeypress) Set the value of theonkeypressproperty.voidsetOnkeyup(String onkeyup) Set the value of theonkeyupproperty.voidsetOnmousedown(String onmousedown) Set the value of theonmousedownproperty.voidsetOnmousemove(String onmousemove) Set the value of theonmousemoveproperty.voidsetOnmouseout(String onmouseout) Set the value of theonmouseoutproperty.voidsetOnmouseover(String onmouseover) Set the value of theonmouseoverproperty.voidsetOnmouseup(String onmouseup) Set the value of theonmouseupproperty.voidsetOnreset(String onreset) Set the value of theonresetproperty.voidsetOnsubmit(String onsubmit) Set the value of theonsubmitproperty.voidSet the value of theroleproperty.voidSet the value of thestyleproperty.voidsetStyleClass(String styleClass) Set the value of thestyleClassproperty.voidSet the value of thetargetproperty.voidSet the value of thetitleproperty.Methods inherited from class javax.faces.component.UIForm
createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted, visitTreeMethods 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, unsubscribeFromEventMethods 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, setValueExpressionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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
acceptproperty.Contents: List of content types that a server processing this form will handle correctly
-
setAccept
Set the value of the
acceptproperty. -
getAcceptcharset
Return the value of the
acceptcharsetproperty.Contents: List of character encodings for input data that are accepted by the server processing this form.
-
setAcceptcharset
Set the value of the
acceptcharsetproperty. -
getDir
Return the value of the
dirproperty.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
dirproperty. -
getEnctype
Return the value of the
enctypeproperty.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
enctypeproperty. -
getLang
Return the value of the
langproperty.Contents: Code describing the language used in the generated markup for this component.
-
setLang
Set the value of the
langproperty. -
getOnclick
Return the value of the
onclickproperty.Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
Set the value of the
onclickproperty. -
getOndblclick
Return the value of the
ondblclickproperty.Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
Set the value of the
ondblclickproperty. -
getOnkeydown
Return the value of the
onkeydownproperty.Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
Set the value of the
onkeydownproperty. -
getOnkeypress
Return the value of the
onkeypressproperty.Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
Set the value of the
onkeypressproperty. -
getOnkeyup
Return the value of the
onkeyupproperty.Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
Set the value of the
onkeyupproperty. -
getOnmousedown
Return the value of the
onmousedownproperty.Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
Set the value of the
onmousedownproperty. -
getOnmousemove
Return the value of the
onmousemoveproperty.Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
Set the value of the
onmousemoveproperty. -
getOnmouseout
Return the value of the
onmouseoutproperty.Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
Set the value of the
onmouseoutproperty. -
getOnmouseover
Return the value of the
onmouseoverproperty.Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
Set the value of the
onmouseoverproperty. -
getOnmouseup
Return the value of the
onmouseupproperty.Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
Set the value of the
onmouseupproperty. -
getOnreset
Return the value of the
onresetproperty.Contents: Javascript code executed when this form is reset.
-
setOnreset
Set the value of the
onresetproperty. -
getOnsubmit
Return the value of the
onsubmitproperty.Contents: Javascript code executed when this form is submitted.
-
setOnsubmit
Set the value of the
onsubmitproperty. -
getRole
Return the value of the
roleproperty.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
roleproperty. -
getStyle
Return the value of the
styleproperty.Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
Set the value of the
styleproperty. -
getStyleClass
Return the value of the
styleClassproperty.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
styleClassproperty. -
getTarget
Return the value of the
targetproperty.Contents: Name of a frame where the response retrieved after this form submit is to be displayed.
-
setTarget
Set the value of the
targetproperty. -
getTitle
Return the value of the
titleproperty.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
Set the value of the
titleproperty. -
getEventNames
Description copied from class:UIComponentBaseThis is a default implementation of
ClientBehaviorHolder.getEventNames().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must override this method to return a non-EmptyCollectionof the client event names that the component supports.- Specified by:
getEventNamesin interfaceClientBehaviorHolder- Overrides:
getEventNamesin classUIComponentBase
-
getDefaultEventName
Description copied from class:UIComponentBaseThis is a default implementation of
ClientBehaviorHolder.getDefaultEventName().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must provide an implementation ofClientBehaviorHolder.getEventNames().- Specified by:
getDefaultEventNamein interfaceClientBehaviorHolder- Overrides:
getDefaultEventNamein classUIComponentBase
-