HtmlForm (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.faces.component.html
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:: NamingContainer, StateHolder

public class HtmlForm
extends UIForm
extends UIForm

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.

Field Summary

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

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

HtmlForm()


Method Summary

String getAccept()
          Return the value of the accept property.

String getAcceptcharset()
          Return the value of the acceptcharset property.

String getDir()
          Return the value of the dir property.

String getEnctype()
          Return the value of the enctype property.

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 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 restoreState(FacesContext _context, Object _state)
           Perform any processing required to restore the state from the entries in the state Object.

Object saveState(FacesContext _context)
           Gets the state of the instance as a Serializable Object.

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 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.

Methods inherited from class javax.faces.component.UIForm

getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.UIComponent

encodeAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`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
`bindings`

Fields inherited from interface javax.faces.component.NamingContainer
`SEPARATOR_CHAR`

Constructor Summary
`HtmlForm()`

Method Summary
`String`	`getAccept()` Return the value of the `accept` property.
`String`	`getAcceptcharset()` Return the value of the `acceptcharset` property.
`String`	`getDir()` Return the value of the `dir` property.
`String`	`getEnctype()` Return the value of the `enctype` property.
`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`	`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`	`restoreState(FacesContext _context, Object _state)` Perform any processing required to restore the state from the entries in the state Object.
`Object`	`saveState(FacesContext _context)` Gets the state of the instance as a `Serializable` Object.
`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`	`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.

Methods inherited from class javax.faces.component.UIForm
`getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted`

Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.UIComponent
`encodeAll`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

See Also:: Constant Field Values

Constructor Detail

HtmlForm

public HtmlForm()

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).

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.

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.

saveState

public Object saveState(FacesContext _context)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:: saveState in interface StateHolder
Overrides:: saveState in class UIComponentBase

restoreState

public void restoreState(FacesContext _context,
                         Object _state)