org.apache.myfaces.custom.form
Class HtmlForm

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIForm
              javax.faces.component.html.HtmlForm
                  org.apache.myfaces.custom.form.AbstractHtmlForm
                      org.apache.myfaces.custom.form.HtmlForm

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, org.apache.myfaces.component.ForceIdAware

public class HtmlForm
extends AbstractHtmlForm

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

HtmlForm()

Method Summary

java.lang.String	getAction() This attribute can be used to set an entirely different action (might be something JSF-unspecific) to the form.
java.lang.String	getFamily()
java.lang.String	getMethod() This attribute can be used to set a method to the form which is different to the regular POST method used.
java.lang.Integer	getPort() This attribute can be used to set the port for the action attribute
java.lang.String	getScheme() This attribute can be used to set the url scheme for the action attribute
java.lang.String	getServerName() This attribute can be used to set the url server name or ip address for the action attribute
boolean	isForceId() If true, this component will force the use of the specified id when rendering.
boolean	isForceIdIndex() If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setAction(java.lang.String action)
void	setForceId(boolean forceId)
void	setForceIdIndex(boolean forceIdIndex)
void	setMethod(java.lang.String method)
void	setPort(java.lang.Integer port)
void	setScheme(java.lang.String scheme)
void	setServerName(java.lang.String serverName)

Methods inherited from class org.apache.myfaces.custom.form.AbstractHtmlForm

getClientId

Methods inherited from class javax.faces.component.html.HtmlForm

getAccept, getAcceptcharset, getDir, getEnctype, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnreset, getOnsubmit, getStyle, getStyleClass, getTarget, getTitle, setAccept, setAcceptcharset, setDir, setEnctype, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnreset, setOnsubmit, setStyle, setStyleClass, setTarget, setTitle

Methods inherited from class javax.faces.component.UIForm

isSubmitted, processDecodes, processUpdates, processValidators, setSubmitted

Methods inherited from class javax.faces.component.UIComponentBase

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

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

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlForm

public HtmlForm()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIForm

getPort

public java.lang.Integer getPort()

Description copied from class: AbstractHtmlForm

This attribute can be used to set the port for the action attribute

Specified by:

getPort in class AbstractHtmlForm

setPort

public void setPort(java.lang.Integer port)

getScheme

public java.lang.String getScheme()

Description copied from class: AbstractHtmlForm

This attribute can be used to set the url scheme for the action attribute

Specified by:

getScheme in class AbstractHtmlForm

setScheme

public void setScheme(java.lang.String scheme)

getServerName

public java.lang.String getServerName()

Description copied from class: AbstractHtmlForm

This attribute can be used to set the url server name or ip address for the action attribute

Specified by:

getServerName in class AbstractHtmlForm

setServerName

public void setServerName(java.lang.String serverName)

getAction

public java.lang.String getAction()

Description copied from class: AbstractHtmlForm

This attribute can be used to set an entirely different action (might be something JSF-unspecific) to the form.

Specified by:

getAction in class AbstractHtmlForm

setAction

public void setAction(java.lang.String action)

getMethod

public java.lang.String getMethod()

Description copied from class: AbstractHtmlForm

This attribute can be used to set a method to the form which is different to the regular POST method used.

Specified by:

getMethod in class AbstractHtmlForm

setMethod

public void setMethod(java.lang.String method)

isForceId

public boolean isForceId()

Description copied from class: AbstractHtmlForm

If true, this component will force the use of the specified id when rendering.

Specified by:

isForceId in interface org.apache.myfaces.component.ForceIdAware

Specified by:

isForceId in class AbstractHtmlForm

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()

Description copied from class: AbstractHtmlForm

If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Specified by:

isForceIdIndex in interface org.apache.myfaces.component.ForceIdAware

Specified by:

isForceIdIndex in class AbstractHtmlForm

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.html.HtmlForm

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.html.HtmlForm