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
formelement. Child input components will be submitted unless they have been disabled.By default, the
rendererTypeproperty 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 Description protected static classHtmlForm.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCOMPONENT_TYPEThe 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 Description HtmlForm()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAccept()Return the value of theacceptproperty.java.lang.StringgetAcceptcharset()Return the value of theacceptcharsetproperty.java.lang.StringgetDefaultEventName()This is a default implementation ofClientBehaviorHolder.getDefaultEventName().java.lang.StringgetDir()Return the value of thedirproperty.java.lang.StringgetEnctype()Return the value of theenctypeproperty.java.util.Collection<java.lang.String>getEventNames()This is a default implementation ofClientBehaviorHolder.getEventNames().java.lang.StringgetLang()Return the value of thelangproperty.java.lang.StringgetOnclick()Return the value of theonclickproperty.java.lang.StringgetOndblclick()Return the value of theondblclickproperty.java.lang.StringgetOnkeydown()Return the value of theonkeydownproperty.java.lang.StringgetOnkeypress()Return the value of theonkeypressproperty.java.lang.StringgetOnkeyup()Return the value of theonkeyupproperty.java.lang.StringgetOnmousedown()Return the value of theonmousedownproperty.java.lang.StringgetOnmousemove()Return the value of theonmousemoveproperty.java.lang.StringgetOnmouseout()Return the value of theonmouseoutproperty.java.lang.StringgetOnmouseover()Return the value of theonmouseoverproperty.java.lang.StringgetOnmouseup()Return the value of theonmouseupproperty.java.lang.StringgetOnreset()Return the value of theonresetproperty.java.lang.StringgetOnsubmit()Return the value of theonsubmitproperty.java.lang.StringgetRole()Return the value of theroleproperty.java.lang.StringgetStyle()Return the value of thestyleproperty.java.lang.StringgetStyleClass()Return the value of thestyleClassproperty.java.lang.StringgetTarget()Return the value of thetargetproperty.java.lang.StringgetTitle()Return the value of thetitleproperty.voidsetAccept(java.lang.String accept)Set the value of theacceptproperty.voidsetAcceptcharset(java.lang.String acceptcharset)Set the value of theacceptcharsetproperty.voidsetDir(java.lang.String dir)Set the value of thedirproperty.voidsetEnctype(java.lang.String enctype)Set the value of theenctypeproperty.voidsetLang(java.lang.String lang)Set the value of thelangproperty.voidsetOnclick(java.lang.String onclick)Set the value of theonclickproperty.voidsetOndblclick(java.lang.String ondblclick)Set the value of theondblclickproperty.voidsetOnkeydown(java.lang.String onkeydown)Set the value of theonkeydownproperty.voidsetOnkeypress(java.lang.String onkeypress)Set the value of theonkeypressproperty.voidsetOnkeyup(java.lang.String onkeyup)Set the value of theonkeyupproperty.voidsetOnmousedown(java.lang.String onmousedown)Set the value of theonmousedownproperty.voidsetOnmousemove(java.lang.String onmousemove)Set the value of theonmousemoveproperty.voidsetOnmouseout(java.lang.String onmouseout)Set the value of theonmouseoutproperty.voidsetOnmouseover(java.lang.String onmouseover)Set the value of theonmouseoverproperty.voidsetOnmouseup(java.lang.String onmouseup)Set the value of theonmouseupproperty.voidsetOnreset(java.lang.String onreset)Set the value of theonresetproperty.voidsetOnsubmit(java.lang.String onsubmit)Set the value of theonsubmitproperty.voidsetRole(java.lang.String role)Set the value of theroleproperty.voidsetStyle(java.lang.String style)Set the value of thestyleproperty.voidsetStyleClass(java.lang.String styleClass)Set the value of thestyleClassproperty.voidsetTarget(java.lang.String target)Set the value of thetargetproperty.voidsetTitle(java.lang.String title)Set the value of thetitleproperty.-
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 java.lang.String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAccept
public java.lang.String getAccept()
Return the value of the
acceptproperty.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
acceptproperty.
-
getAcceptcharset
public java.lang.String 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
public void setAcceptcharset(java.lang.String acceptcharset)
Set the value of the
acceptcharsetproperty.
-
getDir
public java.lang.String 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
public void setDir(java.lang.String dir)
Set the value of the
dirproperty.
-
getEnctype
public java.lang.String 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
public void setEnctype(java.lang.String enctype)
Set the value of the
enctypeproperty.
-
getLang
public java.lang.String getLang()
Return the value of the
langproperty.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
langproperty.
-
getOnclick
public java.lang.String getOnclick()
Return the value of the
onclickproperty.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
onclickproperty.
-
getOndblclick
public java.lang.String getOndblclick()
Return the value of the
ondblclickproperty.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
ondblclickproperty.
-
getOnkeydown
public java.lang.String getOnkeydown()
Return the value of the
onkeydownproperty.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
onkeydownproperty.
-
getOnkeypress
public java.lang.String getOnkeypress()
Return the value of the
onkeypressproperty.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
onkeypressproperty.
-
getOnkeyup
public java.lang.String getOnkeyup()
Return the value of the
onkeyupproperty.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
onkeyupproperty.
-
getOnmousedown
public java.lang.String getOnmousedown()
Return the value of the
onmousedownproperty.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
onmousedownproperty.
-
getOnmousemove
public java.lang.String getOnmousemove()
Return the value of the
onmousemoveproperty.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
onmousemoveproperty.
-
getOnmouseout
public java.lang.String getOnmouseout()
Return the value of the
onmouseoutproperty.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
onmouseoutproperty.
-
getOnmouseover
public java.lang.String getOnmouseover()
Return the value of the
onmouseoverproperty.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
onmouseoverproperty.
-
getOnmouseup
public java.lang.String getOnmouseup()
Return the value of the
onmouseupproperty.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
onmouseupproperty.
-
getOnreset
public java.lang.String getOnreset()
Return the value of the
onresetproperty.Contents: Javascript code executed when this form is reset.
-
setOnreset
public void setOnreset(java.lang.String onreset)
Set the value of the
onresetproperty.
-
getOnsubmit
public java.lang.String getOnsubmit()
Return the value of the
onsubmitproperty.Contents: Javascript code executed when this form is submitted.
-
setOnsubmit
public void setOnsubmit(java.lang.String onsubmit)
Set the value of the
onsubmitproperty.
-
getRole
public java.lang.String 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
public void setRole(java.lang.String role)
Set the value of the
roleproperty.
-
getStyle
public java.lang.String getStyle()
Return the value of the
styleproperty.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
styleproperty.
-
getStyleClass
public java.lang.String 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
public void setStyleClass(java.lang.String styleClass)
Set the value of the
styleClassproperty.
-
getTarget
public java.lang.String 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
public void setTarget(java.lang.String target)
Set the value of the
targetproperty.
-
getTitle
public java.lang.String getTitle()
Return the value of the
titleproperty.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
public void setTitle(java.lang.String title)
Set the value of the
titleproperty.
-
getEventNames
public java.util.Collection<java.lang.String> 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
public java.lang.String 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
-
-