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 the setRendererType()
method.
Modifier and Type | Class and Description |
---|---|
protected static class |
HtmlForm.PropertyKeys |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_TYPE
The standard component type for this component.
|
COMPONENT_FAMILY
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
SEPARATOR_CHAR
Constructor and Description |
---|
HtmlForm() |
Modifier and Type | Method and Description |
---|---|
String |
getAccept()
Return the value of the
accept property. |
String |
getAcceptcharset()
Return the value of the
acceptcharset property. |
String |
getDefaultEventName()
This is a default implementation of
|
String |
getDir()
Return the value of the
dir property. |
String |
getEnctype()
Return the value of the
enctype property. |
Collection<String> |
getEventNames()
This is a default implementation of
|
String |
getLang()
Return the value of the
lang property. |
String |
getOnclick()
Return the value of the
onclick property. |
String |
getOndblclick()
Return the value of the
ondblclick property. |
String |
getOnkeydown()
Return the value of the
onkeydown property. |
String |
getOnkeypress()
Return the value of the
onkeypress property. |
String |
getOnkeyup()
Return the value of the
onkeyup property. |
String |
getOnmousedown()
Return the value of the
onmousedown property. |
String |
getOnmousemove()
Return the value of the
onmousemove property. |
String |
getOnmouseout()
Return the value of the
onmouseout property. |
String |
getOnmouseover()
Return the value of the
onmouseover property. |
String |
getOnmouseup()
Return the value of the
onmouseup property. |
String |
getOnreset()
Return the value of the
onreset property. |
String |
getOnsubmit()
Return the value of the
onsubmit property. |
String |
getRole()
Return the value of the
role property. |
String |
getStyle()
Return the value of the
style property. |
String |
getStyleClass()
Return the value of the
styleClass property. |
String |
getTarget()
Return the value of the
target property. |
String |
getTitle()
Return the value of the
title property. |
void |
setAccept(String accept)
Set the value of the
accept property. |
void |
setAcceptcharset(String acceptcharset)
Set the value of the
acceptcharset property. |
void |
setDir(String dir)
Set the value of the
dir property. |
void |
setEnctype(String enctype)
Set the value of the
enctype property. |
void |
setLang(String lang)
Set the value of the
lang property. |
void |
setOnclick(String onclick)
Set the value of the
onclick property. |
void |
setOndblclick(String ondblclick)
Set the value of the
ondblclick property. |
void |
setOnkeydown(String onkeydown)
Set the value of the
onkeydown property. |
void |
setOnkeypress(String onkeypress)
Set the value of the
onkeypress property. |
void |
setOnkeyup(String onkeyup)
Set the value of the
onkeyup property. |
void |
setOnmousedown(String onmousedown)
Set the value of the
onmousedown property. |
void |
setOnmousemove(String onmousemove)
Set the value of the
onmousemove property. |
void |
setOnmouseout(String onmouseout)
Set the value of the
onmouseout property. |
void |
setOnmouseover(String onmouseover)
Set the value of the
onmouseover property. |
void |
setOnmouseup(String onmouseup)
Set the value of the
onmouseup property. |
void |
setOnreset(String onreset)
Set the value of the
onreset property. |
void |
setOnsubmit(String onsubmit)
Set the value of the
onsubmit property. |
void |
setRole(String role)
Set the value of the
role property. |
void |
setStyle(String style)
Set the value of the
style property. |
void |
setStyleClass(String styleClass)
Set the value of the
styleClass property. |
void |
setTarget(String target)
Set the value of the
target property. |
void |
setTitle(String title)
Set the value of the
title property. |
createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted, visitTree
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
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClientBehavior, getClientBehaviors
public static final String COMPONENT_TYPE
The standard component type for this component.
public String getAccept()
Return the value of the accept
property.
Contents: List of content types that a server processing this form will handle correctly
public void setAccept(String accept)
Set the value of the accept
property.
accept
- the new property valuepublic 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.
public void setAcceptcharset(String acceptcharset)
Set the value of the acceptcharset
property.
acceptcharset
- the new property valuepublic 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.
public void setDir(String dir)
Set the value of the dir
property.
dir
- the new property valuepublic 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".
public void setEnctype(String enctype)
Set the value of the enctype
property.
enctype
- the new property valuepublic String getLang()
Return the value of the lang
property.
Contents: Code describing the language used in the generated markup for this component.
public void setLang(String lang)
Set the value of the lang
property.
lang
- the new property valuepublic String getOnclick()
Return the value of the onclick
property.
Contents: Javascript code executed when a pointer button is clicked over this element.
public void setOnclick(String onclick)
Set the value of the onclick
property.
onclick
- the new property valuepublic String getOndblclick()
Return the value of the ondblclick
property.
Contents: Javascript code executed when a pointer button is double clicked over this element.
public void setOndblclick(String ondblclick)
Set the value of the ondblclick
property.
ondblclick
- the new property valuepublic String getOnkeydown()
Return the value of the onkeydown
property.
Contents: Javascript code executed when a key is pressed down over this element.
public void setOnkeydown(String onkeydown)
Set the value of the onkeydown
property.
onkeydown
- the new property valuepublic String getOnkeypress()
Return the value of the onkeypress
property.
Contents: Javascript code executed when a key is pressed and released over this element.
public void setOnkeypress(String onkeypress)
Set the value of the onkeypress
property.
onkeypress
- the new property valuepublic String getOnkeyup()
Return the value of the onkeyup
property.
Contents: Javascript code executed when a key is released over this element.
public void setOnkeyup(String onkeyup)
Set the value of the onkeyup
property.
onkeyup
- the new property valuepublic String getOnmousedown()
Return the value of the onmousedown
property.
Contents: Javascript code executed when a pointer button is pressed down over this element.
public void setOnmousedown(String onmousedown)
Set the value of the onmousedown
property.
onmousedown
- the new property valuepublic String getOnmousemove()
Return the value of the onmousemove
property.
Contents: Javascript code executed when a pointer button is moved within this element.
public void setOnmousemove(String onmousemove)
Set the value of the onmousemove
property.
onmousemove
- the new property valuepublic String getOnmouseout()
Return the value of the onmouseout
property.
Contents: Javascript code executed when a pointer button is moved away from this element.
public void setOnmouseout(String onmouseout)
Set the value of the onmouseout
property.
onmouseout
- the new property valuepublic String getOnmouseover()
Return the value of the onmouseover
property.
Contents: Javascript code executed when a pointer button is moved onto this element.
public void setOnmouseover(String onmouseover)
Set the value of the onmouseover
property.
onmouseover
- the new property valuepublic String getOnmouseup()
Return the value of the onmouseup
property.
Contents: Javascript code executed when a pointer button is released over this element.
public void setOnmouseup(String onmouseup)
Set the value of the onmouseup
property.
onmouseup
- the new property valuepublic String getOnreset()
Return the value of the onreset
property.
Contents: Javascript code executed when this form is reset.
public void setOnreset(String onreset)
Set the value of the onreset
property.
onreset
- the new property valuepublic String getOnsubmit()
Return the value of the onsubmit
property.
Contents: Javascript code executed when this form is submitted.
public void setOnsubmit(String onsubmit)
Set the value of the onsubmit
property.
onsubmit
- the new property valuepublic 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.
public void setRole(String role)
Set the value of the role
property.
role
- the new property valuepublic String getStyle()
Return the value of the style
property.
Contents: CSS style(s) to be applied when this component is rendered.
public void setStyle(String style)
Set the value of the style
property.
style
- the new property valuepublic 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.
public void setStyleClass(String styleClass)
Set the value of the styleClass
property.
styleClass
- the new property valuepublic 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.
public void setTarget(String target)
Set the value of the target
property.
target
- the new property valuepublic String getTitle()
Return the value of the title
property.
Contents: Advisory title information about markup elements generated for this component.
public void setTitle(String title)
Set the value of the title
property.
title
- the new property valuepublic Collection<String> getEventNames()
UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.
UIComponent
does not implement the
ClientBehaviorHolder
interface,
but provides default implementations for the methods defined by
ClientBehaviorHolder
to simplify
subclass implementations. Subclasses that wish to support the
ClientBehaviorHolder
contract
must declare that the subclass implements
ClientBehaviorHolder
, and must
override this method to return a non-Empty Collection
of the client event names that the component supports.
getEventNames
in interface ClientBehaviorHolder
getEventNames
in class UIComponentBase
public String getDefaultEventName()
UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.
UIComponent
does not implement the
ClientBehaviorHolder
interface,
but provides default implementations for the methods defined by
ClientBehaviorHolder
to simplify
subclass implementations. Subclasses that wish to support the
ClientBehaviorHolder
contract
must declare that the subclass implements
ClientBehaviorHolder
, and must
provide an implementation of
ClientBehaviorHolder.getEventNames()
.
getDefaultEventName
in interface ClientBehaviorHolder
getDefaultEventName
in class UIComponentBase
Copyright © 2018 JBoss by Red Hat. All rights reserved.