javax.faces.component.html
Class HtmlForm

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIForm
              extended by 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 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
protected static class HtmlForm.PropertyKeys
           
 
Field Summary
static java.lang.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
HtmlForm()
           
 
Method Summary
 java.lang.String getAccept()
          Return the value of the accept property.
 java.lang.String getAcceptcharset()
          Return the value of the acceptcharset property.
 java.lang.String getDefaultEventName()
          

This is a default implementation of ClientBehaviorHolder.getDefaultEventName().

 java.lang.String getDir()
          Return the value of the dir property.
 java.lang.String getEnctype()
          Return the value of the enctype property.
 java.util.Collection<java.lang.String> getEventNames()
          

This is a default implementation of ClientBehaviorHolder.getEventNames().

 java.lang.String getLang()
          Return the value of the lang property.
 java.lang.String getOnclick()
          Return the value of the onclick property.
 java.lang.String getOndblclick()
          Return the value of the ondblclick property.
 java.lang.String getOnkeydown()
          Return the value of the onkeydown property.
 java.lang.String getOnkeypress()
          Return the value of the onkeypress property.
 java.lang.String getOnkeyup()
          Return the value of the onkeyup property.
 java.lang.String getOnmousedown()
          Return the value of the onmousedown property.
 java.lang.String getOnmousemove()
          Return the value of the onmousemove property.
 java.lang.String getOnmouseout()
          Return the value of the onmouseout property.
 java.lang.String getOnmouseover()
          Return the value of the onmouseover property.
 java.lang.String getOnmouseup()
          Return the value of the onmouseup property.
 java.lang.String getOnreset()
          Return the value of the onreset property.
 java.lang.String getOnsubmit()
          Return the value of the onsubmit property.
 java.lang.String getStyle()
          Return the value of the style property.
 java.lang.String getStyleClass()
          Return the value of the styleClass property.
 java.lang.String getTarget()
          Return the value of the target property.
 java.lang.String getTitle()
          Return the value of the title property.
 void setAccept(java.lang.String accept)
          Set the value of the accept property.
 void setAcceptcharset(java.lang.String acceptcharset)
          Set the value of the acceptcharset property.
 void setDir(java.lang.String dir)
          Set the value of the dir property.
 void setEnctype(java.lang.String enctype)
          Set the value of the enctype property.
 void setLang(java.lang.String lang)
          Set the value of the lang property.
 void setOnclick(java.lang.String onclick)
          Set the value of the onclick property.
 void setOndblclick(java.lang.String ondblclick)
          Set the value of the ondblclick property.
 void setOnkeydown(java.lang.String onkeydown)
          Set the value of the onkeydown property.
 void setOnkeypress(java.lang.String onkeypress)
          Set the value of the onkeypress property.
 void setOnkeyup(java.lang.String onkeyup)
          Set the value of the onkeyup property.
 void setOnmousedown(java.lang.String onmousedown)
          Set the value of the onmousedown property.
 void setOnmousemove(java.lang.String onmousemove)
          Set the value of the onmousemove property.
 void setOnmouseout(java.lang.String onmouseout)
          Set the value of the onmouseout property.
 void setOnmouseover(java.lang.String onmouseover)
          Set the value of the onmouseover property.
 void setOnmouseup(java.lang.String onmouseup)
          Set the value of the onmouseup property.
 void setOnreset(java.lang.String onreset)
          Set the value of the onreset property.
 void setOnsubmit(java.lang.String onsubmit)
          Set the value of the onsubmit property.
 void setStyle(java.lang.String style)
          Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
          Set the value of the styleClass property.
 void setTarget(java.lang.String target)
          Set the value of the target property.
 void setTitle(java.lang.String title)
          Set the value of the title 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, 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, 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
Constructor Detail

HtmlForm

public HtmlForm()
Method Detail

getAccept

public java.lang.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(java.lang.String accept)

Set the value of the accept property.


getAcceptcharset

public java.lang.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(java.lang.String acceptcharset)

Set the value of the acceptcharset property.


getDir

public java.lang.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).


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


getEnctype

public java.lang.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(java.lang.String enctype)

Set the value of the enctype property.


getLang

public java.lang.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(java.lang.String lang)

Set the value of the lang property.


getOnclick

public java.lang.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(java.lang.String onclick)

Set the value of the onclick property.


getOndblclick

public java.lang.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(java.lang.String ondblclick)

Set the value of the ondblclick property.


getOnkeydown

public java.lang.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(java.lang.String onkeydown)

Set the value of the onkeydown property.


getOnkeypress

public java.lang.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(java.lang.String onkeypress)

Set the value of the onkeypress property.


getOnkeyup

public java.lang.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(java.lang.String onkeyup)

Set the value of the onkeyup property.


getOnmousedown

public java.lang.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(java.lang.String onmousedown)

Set the value of the onmousedown property.


getOnmousemove

public java.lang.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(java.lang.String onmousemove)

Set the value of the onmousemove property.


getOnmouseout

public java.lang.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(java.lang.String onmouseout)

Set the value of the onmouseout property.


getOnmouseover

public java.lang.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(java.lang.String onmouseover)

Set the value of the onmouseover property.


getOnmouseup

public java.lang.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(java.lang.String onmouseup)

Set the value of the onmouseup property.


getOnreset

public java.lang.String getOnreset()

Return the value of the onreset property.

Contents: Javascript code executed when this form is reset.


setOnreset

public void setOnreset(java.lang.String onreset)

Set the value of the onreset property.


getOnsubmit

public java.lang.String getOnsubmit()

Return the value of the onsubmit property.

Contents: Javascript code executed when this form is submitted.


setOnsubmit

public void setOnsubmit(java.lang.String onsubmit)

Set the value of the onsubmit property.


getStyle

public java.lang.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(java.lang.String style)

Set the value of the style property.


getStyleClass

public java.lang.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(java.lang.String styleClass)

Set the value of the styleClass property.


getTarget

public java.lang.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(java.lang.String target)

Set the value of the target property.


getTitle

public java.lang.String getTitle()

Return the value of the title property.

Contents: Advisory title information about markup elements generated for this component.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.


getEventNames

public java.util.Collection<java.lang.String> getEventNames()
Description copied from class: 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.

Specified by:
getEventNames in interface ClientBehaviorHolder
Overrides:
getEventNames in class UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()
Description copied from class: 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().

Specified by:
getDefaultEventName in interface ClientBehaviorHolder
Overrides:
getDefaultEventName in class UIComponentBase


Submit a bug or feature

Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.

Generated on 10-February-2011 12:41