org.apache.myfaces.custom.form
Class AbstractHtmlForm

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HtmlForm

public abstract class AbstractHtmlForm
extends javax.faces.component.html.HtmlForm
implements org.apache.myfaces.component.ForceIdAware

Renders a HTML form element which allow defining a different scheme, servername or port for the action url to which the form is submited

Version:

$Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $

Author:

Mathias Broekelmann (latest modification by $Author: lu4242 $)

Field Summary

static java.lang.String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIForm

COMPONENT_FAMILY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

AbstractHtmlForm()

Method Summary

abstract 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	getClientId(javax.faces.context.FacesContext context)
abstract 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.
abstract java.lang.Integer	getPort() This attribute can be used to set the port for the action attribute
abstract java.lang.String	getScheme() This attribute can be used to set the url scheme for the action attribute
abstract java.lang.String	getServerName() This attribute can be used to set the url server name or ip address for the action attribute
abstract boolean	isForceId() If true, this component will force the use of the specified id when rendering.
abstract 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.)

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, restoreState, saveState, 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

getFamily, 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

Methods inherited from interface org.apache.myfaces.component.ForceIdAware

setForceId, setForceIdIndex

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlForm

public AbstractHtmlForm()

Method Detail

getClientId

public java.lang.String getClientId(javax.faces.context.FacesContext context)

Overrides:

getClientId in class javax.faces.component.UIComponentBase

getPort

public abstract java.lang.Integer getPort()

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

getScheme

public abstract java.lang.String getScheme()

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

getServerName

public abstract java.lang.String getServerName()

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

getAction

public abstract java.lang.String getAction()

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

getMethod

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

isForceId

public abstract boolean isForceId()

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

Specified by:

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

Returns:

isForceIdIndex

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

Specified by:

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

Returns: