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:
NamingContainer, StateHolder

public class HtmlForm
extends UIForm


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HtmlForm()
          Construct an instance of the HtmlForm.
 
Method Summary
 java.lang.String getAccept()
          Gets Provides a comma-separated list of content types that the server processing this form can handle.
 java.lang.String getAcceptcharset()
          Gets The list of character encodings accepted by the server for this form.
 java.lang.String getDir()
          Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getEnctype()
          Gets The content type used to submit this form to the server.
 java.lang.String getFamily()
           
 java.lang.String getLang()
          Gets The base language of this document.
 java.lang.String getOnclick()
          Gets Script to be invoked when the element is clicked.
 java.lang.String getOndblclick()
          Gets Script to be invoked when the element is double-clicked.
 java.lang.String getOnkeydown()
          Gets Script to be invoked when a key is pressed down over this element.
 java.lang.String getOnkeypress()
          Gets Script to be invoked when a key is pressed over this element.
 java.lang.String getOnkeyup()
          Gets Script to be invoked when a key is released over this element.
 java.lang.String getOnmousedown()
          Gets Script to be invoked when the pointing device is pressed over this element.
 java.lang.String getOnmousemove()
          Gets Script to be invoked when the pointing device is moved while it is in this element.
 java.lang.String getOnmouseout()
          Gets Script to be invoked when the pointing device is moves out of this element.
 java.lang.String getOnmouseover()
          Gets Script to be invoked when the pointing device is moved into this element.
 java.lang.String getOnmouseup()
          Gets Script to be invoked when the pointing device is released over this element.
 java.lang.String getOnreset()
          Gets Script to be invoked when this form is reset.
 java.lang.String getOnsubmit()
          Gets Script to be invoked when this form is submitted.
 java.lang.String getStyle()
          Gets CSS styling instructions.
 java.lang.String getStyleClass()
          Gets The CSS class for this element.
 java.lang.String getTarget()
          Gets Names the frame that should display content generated by invoking this action.
 java.lang.String getTitle()
          Gets An advisory title for this element.
 void restoreState(FacesContext facesContext, java.lang.Object state)
          Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
 java.lang.Object saveState(FacesContext facesContext)
          Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
 void setAccept(java.lang.String accept)
          Sets Provides a comma-separated list of content types that the server processing this form can handle.
 void setAcceptcharset(java.lang.String acceptcharset)
          Sets The list of character encodings accepted by the server for this form.
 void setDir(java.lang.String dir)
          Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 void setEnctype(java.lang.String enctype)
          Sets The content type used to submit this form to the server.
 void setLang(java.lang.String lang)
          Sets The base language of this document.
 void setOnclick(java.lang.String onclick)
          Sets Script to be invoked when the element is clicked.
 void setOndblclick(java.lang.String ondblclick)
          Sets Script to be invoked when the element is double-clicked.
 void setOnkeydown(java.lang.String onkeydown)
          Sets Script to be invoked when a key is pressed down over this element.
 void setOnkeypress(java.lang.String onkeypress)
          Sets Script to be invoked when a key is pressed over this element.
 void setOnkeyup(java.lang.String onkeyup)
          Sets Script to be invoked when a key is released over this element.
 void setOnmousedown(java.lang.String onmousedown)
          Sets Script to be invoked when the pointing device is pressed over this element.
 void setOnmousemove(java.lang.String onmousemove)
          Sets Script to be invoked when the pointing device is moved while it is in this element.
 void setOnmouseout(java.lang.String onmouseout)
          Sets Script to be invoked when the pointing device is moves out of this element.
 void setOnmouseover(java.lang.String onmouseover)
          Sets Script to be invoked when the pointing device is moved into this element.
 void setOnmouseup(java.lang.String onmouseup)
          Sets Script to be invoked when the pointing device is released over this element.
 void setOnreset(java.lang.String onreset)
          Sets Script to be invoked when this form is reset.
 void setOnsubmit(java.lang.String onsubmit)
          Sets Script to be invoked when this form is submitted.
 void setStyle(java.lang.String style)
          Sets CSS styling instructions.
 void setStyleClass(java.lang.String styleClass)
          Sets The CSS class for this element.
 void setTarget(java.lang.String target)
          Sets Names the frame that should display content generated by invoking this action.
 void setTitle(java.lang.String title)
          Sets An advisory title for this element.
 
Methods inherited from class javax.faces.component.UIForm
getContainerClientId, 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, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlForm

public HtmlForm()
Construct an instance of the HtmlForm.

Method Detail

getStyle

public java.lang.String getStyle()
Gets CSS styling instructions.

Returns:
the new style value

setStyle

public void setStyle(java.lang.String style)
Sets CSS styling instructions.

Parameters:
style - the new style value

getStyleClass

public java.lang.String getStyleClass()
Gets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Returns:
the new styleClass value

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Parameters:
styleClass - the new styleClass value

getDir

public java.lang.String getDir()
Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Returns:
the new dir value

setDir

public void setDir(java.lang.String dir)
Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Parameters:
dir - the new dir value

getLang

public java.lang.String getLang()
Gets The base language of this document.

Returns:
the new lang value

setLang

public void setLang(java.lang.String lang)
Sets The base language of this document.

Parameters:
lang - the new lang value

getTitle

public java.lang.String getTitle()
Gets An advisory title for this element. Often used by the user agent as a tooltip.

Returns:
the new title value

setTitle

public void setTitle(java.lang.String title)
Sets An advisory title for this element. Often used by the user agent as a tooltip.

Parameters:
title - the new title value

getOnclick

public java.lang.String getOnclick()
Gets Script to be invoked when the element is clicked.

Returns:
the new onclick value

setOnclick

public void setOnclick(java.lang.String onclick)
Sets Script to be invoked when the element is clicked.

Parameters:
onclick - the new onclick value

getOndblclick

public java.lang.String getOndblclick()
Gets Script to be invoked when the element is double-clicked.

Returns:
the new ondblclick value

setOndblclick

public void setOndblclick(java.lang.String ondblclick)
Sets Script to be invoked when the element is double-clicked.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public java.lang.String getOnmousedown()
Gets Script to be invoked when the pointing device is pressed over this element.

Returns:
the new onmousedown value

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)
Sets Script to be invoked when the pointing device is pressed over this element.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public java.lang.String getOnmouseup()
Gets Script to be invoked when the pointing device is released over this element.

Returns:
the new onmouseup value

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)
Sets Script to be invoked when the pointing device is released over this element.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public java.lang.String getOnmouseover()
Gets Script to be invoked when the pointing device is moved into this element.

Returns:
the new onmouseover value

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)
Sets Script to be invoked when the pointing device is moved into this element.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public java.lang.String getOnmousemove()
Gets Script to be invoked when the pointing device is moved while it is in this element.

Returns:
the new onmousemove value

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)
Sets Script to be invoked when the pointing device is moved while it is in this element.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public java.lang.String getOnmouseout()
Gets Script to be invoked when the pointing device is moves out of this element.

Returns:
the new onmouseout value

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)
Sets Script to be invoked when the pointing device is moves out of this element.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public java.lang.String getOnkeypress()
Gets Script to be invoked when a key is pressed over this element.

Returns:
the new onkeypress value

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)
Sets Script to be invoked when a key is pressed over this element.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public java.lang.String getOnkeydown()
Gets Script to be invoked when a key is pressed down over this element.

Returns:
the new onkeydown value

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)
Sets Script to be invoked when a key is pressed down over this element.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public java.lang.String getOnkeyup()
Gets Script to be invoked when a key is released over this element.

Returns:
the new onkeyup value

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)
Sets Script to be invoked when a key is released over this element.

Parameters:
onkeyup - the new onkeyup value

getTarget

public java.lang.String getTarget()
Gets Names the frame that should display content generated by invoking this action.

Returns:
the new target value

setTarget

public void setTarget(java.lang.String target)
Sets Names the frame that should display content generated by invoking this action.

Parameters:
target - the new target value

getAccept

public java.lang.String getAccept()
Gets Provides a comma-separated list of content types that the server processing this form can handle.

Returns:
the new accept value

setAccept

public void setAccept(java.lang.String accept)
Sets Provides a comma-separated list of content types that the server processing this form can handle.

Parameters:
accept - the new accept value

getAcceptcharset

public java.lang.String getAcceptcharset()
Gets The list of character encodings accepted by the server for this form.

Returns:
the new acceptcharset value

setAcceptcharset

public void setAcceptcharset(java.lang.String acceptcharset)
Sets The list of character encodings accepted by the server for this form.

Parameters:
acceptcharset - the new acceptcharset value

getEnctype

public java.lang.String getEnctype()
Gets The content type used to submit this form to the server.

Returns:
the new enctype value

setEnctype

public void setEnctype(java.lang.String enctype)
Sets The content type used to submit this form to the server.

Parameters:
enctype - the new enctype value

getOnreset

public java.lang.String getOnreset()
Gets Script to be invoked when this form is reset.

Returns:
the new onreset value

setOnreset

public void setOnreset(java.lang.String onreset)
Sets Script to be invoked when this form is reset.

Parameters:
onreset - the new onreset value

getOnsubmit

public java.lang.String getOnsubmit()
Gets Script to be invoked when this form is submitted.

Returns:
the new onsubmit value

setOnsubmit

public void setOnsubmit(java.lang.String onsubmit)
Sets Script to be invoked when this form is submitted.

Parameters:
onsubmit - the new onsubmit value

saveState

public java.lang.Object saveState(FacesContext facesContext)
Description copied from class: UIComponentBase
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

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

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIForm
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIForm


Copyright © 2011 Apache Software Foundation. All Rights Reserved.