org.apache.tapestry.valid
Interface IFieldTracking

All Known Implementing Classes:

FieldTracking

public interface IFieldTracking

Defines the interface for an object that tracks input fields. This interface is now poorly named, in that it tracks errors that may not be associated with a specific field.

For each field, a flag is stored indicating if the field is, in fact, in error. The input supplied by the client is stored so that if the form is re-rendered (as is typically done when there are input errors), the value entered by the user is displayed back to the user. An error message renderer is stored; this is an object that can render the error message (it is usually a RenderStringwrapper around a simple string).

Since:

1.0.8

Version:

$Id: IFieldTracking.java 244092 2005-02-01 01:38:37Z hlship $

Author:

Howard Lewis Ship

Method Summary

IFormComponent	getComponent() Returns the field component.
ValidationConstraint	getConstraint() Returns the validation constraint that was violated by the input.
IRender	getErrorRenderer() Returns an object that will render the error message.
String	getFieldName() Returns the name of the field, that is, the name assigned by the form (this will differ from the component's id when any kind of looping operation is in effect).
String	getInput() Returns the invalid input recorded for the field.
boolean	isInError() Returns true if the field is in error (that is, if it has an error message renderer.

Method Detail

isInError

boolean isInError()

Returns true if the field is in error (that is, if it has an error message renderer.

getComponent

IFormComponent getComponent()

Returns the field component. This may return null if the error is not associated with any particular field.

getErrorRenderer

IRender getErrorRenderer()

Returns an object that will render the error message. Alternately, the toString() of the renderer can be used as a simple error message.

Since:

1.0.9

getInput

String getInput()

Returns the invalid input recorded for the field. This is stored so that, on a subsequent render, the smae invalid input can be presented to the client to be corrected.

getFieldName

String getFieldName()

Returns the name of the field, that is, the name assigned by the form (this will differ from the component's id when any kind of looping operation is in effect).

getConstraint

ValidationConstraint getConstraint()

Returns the validation constraint that was violated by the input. This may be null if the constraint isn't known.