org.apache.tapestry

Interface IForm

All Superinterfaces:

FormBehavior, IAction, IComponent, IRender, org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder

All Known Implementing Classes:

Form, Go

public interface IForm
extends IAction, FormBehavior

A generic way to access a component which defines an HTML form (or, perhaps, other similar constructs, such as a WML Go). This interface exists so that the IRequestCyclecan invoke the rewind(IMarkupWriter, IRequestCycle)method (which is used to deal with a Form that uses the direct service). In release 1.0.5, more responsibility for forms was moved here.

Since:

1.0.2

Author:

Howard Lewis Ship

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_NAME Deprecated. To be removed; use TapestryUtils.FORM_ATTRIBUTEinstead.

Method Summary

Methods

Modifier and Type	Method and Description
IValidationDelegate	getDelegate() Returns the validation delegate for the form.
boolean	getFocus() Returns true if the form should support automatic field focus (that is, adding JavaScript to position the cursor into the first field of the form, automatically).
java.lang.String	getName() Returns the name of the form.
boolean	isClientValidationEnabled() Indicates whether or not client-side validation will be generated during render.
void	rewind(IMarkupWriter writer, IRequestCycle cycle) Invoked by the IRequestCycleto allow a form that uses the direct service, to respond to the form submission.

Methods inherited from interface org.apache.tapestry.IAction

getRequiresSession

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Methods inherited from interface org.apache.tapestry.FormBehavior

addDeferredRunnable, addEventHandler, addHiddenValue, addHiddenValue, getElementId, getElementId, isRewinding, prerenderField, registerForFocus, setEncodingType, wasPrerendered

Field Detail

ATTRIBUTE_NAME

static final java.lang.String ATTRIBUTE_NAME

Deprecated. To be removed; use TapestryUtils.FORM_ATTRIBUTEinstead.

Attribute name used with the request cycle; allows other components to locate the IForm.

Since:

1.0.5

See Also:

Constant Field Values

Method Detail

rewind

void rewind(IMarkupWriter writer,
          IRequestCycle cycle)

Invoked by the IRequestCycleto allow a form that uses the direct service, to respond to the form submission.

getName

java.lang.String getName()

Returns the name of the form. The name is determined as the form component begins to render, but is not reset (as a convienience for building client-side JavaScript event handlers). The Form (and Go) components render this name as both the name and the id attribute (so it can be used like a field's clientId property.

Since:

1.0.5

getDelegate

IValidationDelegate getDelegate()

Returns the validation delegate for the form. Returns null if the form does not have a delegate.

Since:

1.0.8

isClientValidationEnabled

boolean isClientValidationEnabled()

Indicates whether or not client-side validation will be generated during render.

Returns:

true, if client-side validation is enabled, false otherwise

Since:

4.0

getFocus

boolean getFocus()

Returns true if the form should support automatic field focus (that is, adding JavaScript to position the cursor into the first field of the form, automatically). This requires that the Form component be enclosed by a Body component. When a single page contains multiple Forms, only the first Form that renders will get field focus; by setting the Form's focus parameter to false, it is possible to control which Form gets focus.

Since:

4.0