## Uses of Interface
org.apache.tapestry5.Field

- Packages that use Field
  Package | Description
  --- | ---
  org.apache.tapestry5 | Root package for Tapestry, containing common interfaces and data types used throughout the framework.
  org.apache.tapestry5.corelib.base | Base components intended to be extended by other components rather than used directly in templates.
  org.apache.tapestry5.corelib.components | The set of core components available in all Tapestry applications
  org.apache.tapestry5.corelib.internal | [INTERNAL USE ONLY] support classes for the Tapestry-core module; API subject to change core components.
  org.apache.tapestry5.internal.beanvalidator | [INTERNAL USE ONLY] JSR-303 Bean Validation implementation details; API subject to change
  org.apache.tapestry5.internal.services | [INTERNAL USE ONLY] internal service classes; API subject to change
  org.apache.tapestry5.internal.translator | [INTERNAL USE ONLY] translator implementation classes; API subject to change.
  org.apache.tapestry5.internal.util | [INTERNAL USE ONLY] various utility classes; API subject to change.
  org.apache.tapestry5.kaptcha.components | Kaptcha components
  org.apache.tapestry5.services | Core services
  org.apache.tapestry5.test | Support for testing Tapestry pages
  org.apache.tapestry5.upload.components | Tapestry-upload module components
  org.apache.tapestry5.validator | Validators for use by Tapestry (and custom) form field components.

- - ### Uses of Field in org.apache.tapestry5

    Subinterfaces of Field in org.apache.tapestry5
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Field2` Due to how control names and client ids are allocated inside during an Ajax request, it is difficult to to connect input data and field validation errors to the fields, since the control name and client id are different during the processing of the submitted form data and during the subsequent render.

    Methods in org.apache.tapestry5 with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | BaseValidationDecorator.`afterField(Field field)`
    `void` | ValidationDecorator.`afterField(Field field)` Deprecated. Invoked after the field has completed rendering itself.
    `void` | BaseValidationDecorator.`afterLabel(Field field)`
    `void` | ValidationDecorator.`afterLabel(Field field)` Deprecated. Invoked by `Label` after rendering itself.
    `void` | BaseValidationDecorator.`beforeField(Field field)`
    `void` | ValidationDecorator.`beforeField(Field field)` Deprecated. Renders immediately before the field itself.
    `void` | BaseValidationDecorator.`beforeLabel(Field field)`
    `void` | ValidationDecorator.`beforeLabel(Field field)` Deprecated. Invoked by a `Label` before rendering itself.
    `String` | ValidationTracker.`getError(Field field)` Returns a previously recorded error message.
    `String` | ValidationTrackerImpl.`getError(Field field)`
    `String` | ValidationTrackerWrapper.`getError(Field field)`
    `String` | ValidationTracker.`getInput(Field field)` Returns a previously recorded input value.
    `String` | ValidationTrackerImpl.`getInput(Field field)`
    `String` | ValidationTrackerWrapper.`getInput(Field field)`
    `boolean` | ValidationTracker.`inError(Field field)` For a given field, determines if the field is "in error", meaning that an error message has been previously recorded for the field.
    `boolean` | ValidationTrackerImpl.`inError(Field field)`
    `boolean` | ValidationTrackerWrapper.`inError(Field field)`
    `void` | BaseValidationDecorator.`insideField(Field field)`
    `void` | ValidationDecorator.`insideField(Field field)` Deprecated. Invoked at a point where the decorator may write additional attributes into the field.
    `void` | BaseValidationDecorator.`insideLabel(Field field, Element labelElement)`
    `void` | ValidationDecorator.`insideLabel(Field field, Element labelElement)` Deprecated. Invoked after the label has rendered its tag, but before it has rendered content inside the tag, to allow the decorator to write additional attributes.
    `T` | Translator.`parseClient(Field field, String clientValue, String message)` Converts a submitted request value into an appropriate server side value.
    `void` | FormValidationControl.`recordError(Field field, String errorMessage)` A convenience method for invoking `ValidationTracker.recordError(Field, String)`.
    `void` | ValidationTracker.`recordError(Field field, String errorMessage)` Records an error message for a field.
    `void` | ValidationTrackerImpl.`recordError(Field field, String errorMessage)`
    `void` | ValidationTrackerWrapper.`recordError(Field field, String errorMessage)`
    `void` | ValidationTracker.`recordInput(Field field, String input)` Called by a field to record the exact input from the user, prior to any validation.
    `void` | ValidationTrackerImpl.`recordInput(Field field, String input)`
    `void` | ValidationTrackerWrapper.`recordInput(Field field, String input)`
    `void` | Validator.`render(Field field, C constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)` Hook used by components to allow the validator to contribute additional attributes or (more often) client-side JavaScript (via the `FormSupport.addValidation(Field, String, String, Object)`).
    `void` | Translator.`render(Field field, String message, MarkupWriter writer, FormSupport formSupport)` Hook used by components to allow the validator to contribute additional attributes or (more often) client-side JavaScript (via the `FormSupport.addValidation(Field, String, String, Object)`).
    `void` | Validator.`validate(Field field, C constraintValue, MessageFormatter formatter, T value)` Invoked after the client-submitted value has been `translated` to check that the value conforms to expectations (often, in terms of minimum or maximum value).

  - ### Uses of Field in org.apache.tapestry5.corelib.base

    Classes in org.apache.tapestry5.corelib.base that implement Field
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractField` Provides initialization of the clientId and elementName properties.
    `class` | `AbstractTextField` Abstract class for a variety of components that render some variation of a text field.

  - ### Uses of Field in org.apache.tapestry5.corelib.components

    Classes in org.apache.tapestry5.corelib.components that implement Field
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Checkbox` A Checkbox component is simply a <input type="checkbox">.
    `class` | `Checklist` A list of checkboxes, allowing selection of multiple items in a list.
    `class` | `DateField` A component used to collect a provided date from the user using a client-side JavaScript calendar.
    `class` | `Palette` Multiple selection component.
    `class` | `PasswordField` A version of `TextField`, but rendered out as an <input type="password"> element.
    `class` | `Radio` A radio button (i.e., <input type="radio">).
    `class` | `RadioGroup` A wrapper component around some number of `Radio` components, used to organize the selection and define the property to be edited.
    `class` | `Select` Select an item from a list of values, using an [X]HTML <select> element on the client side.
    `class` | `TextArea` TextArea component corresponds to a <textarea> element.
    `class` | `TextField` TextField component corresponds to `<input>` element.

    Methods in org.apache.tapestry5.corelib.components with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | BeanEditForm.`recordError(Field field, String errorMessage)`
    `void` | Form.`recordError(Field field, String errorMessage)`

  - ### Uses of Field in org.apache.tapestry5.corelib.internal

    Methods in org.apache.tapestry5.corelib.internal with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | FormSupportAdapter.`addValidation(Field field, String validationName, String message, Object constraint)`
    `void` | FormSupportImpl.`addValidation(Field field, String validationName, String message, Object constraint)`

  - ### Uses of Field in org.apache.tapestry5.internal.beanvalidator

    Methods in org.apache.tapestry5.internal.beanvalidator with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `FieldValidator` | BeanFieldValidatorDefaultSource.`createDefaultValidator(Field field, String overrideId, Messages overrideMessages, Locale locale, Class propertyType, AnnotationProvider propertyAnnotations)`

    Constructors in org.apache.tapestry5.internal.beanvalidator with parameters of type Field
    Constructor and Description
    `BeanFieldValidator(Field field, ValidatorFactory validatorFactory, BeanValidatorGroupSource beanValidationGroupSource, ClientConstraintDescriptorSource clientValidatorSource, FormSupport formSupport, Environment environment)`

  - ### Uses of Field in org.apache.tapestry5.internal.services

    Methods in org.apache.tapestry5.internal.services with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientBehaviorSupportImpl.`addValidation(Field field, String validationName, String message, Object constraint)`
    `FieldTranslator` | FieldTranslatorSourceImpl.`createDefaultTranslator(Field field, String overrideId, Messages overrideMessages, Locale locale, Class propertyType, AnnotationProvider propertyAnnotations)`
    `FieldValidator` | FieldValidatorDefaultSourceImpl.`createDefaultValidator(Field field, String overrideId, Messages overrideMessages, Locale locale, Class propertyType, AnnotationProvider propertyAnnotations)`
    `FieldTranslator` | FieldTranslatorSourceImpl.`createTranslator(Field field, String overrideId, Messages overrideMessages, Locale locale, Translator translator)`
    `FieldValidator` | FieldValidatorSourceImpl.`createValidator(Field field, String validatorType, String constraintValue)`
    `FieldValidator` | FieldValidatorSourceImpl.`createValidator(Field field, String validatorType, String constraintValue, String overrideId, Messages overrideMessages, Locale locale)`
    `FieldValidator` | FieldValidatorSourceImpl.`createValidators(Field field, String specification)`

    Constructors in org.apache.tapestry5.internal.services with parameters of type Field
    Constructor and Description
    `FieldTranslatorImpl(Field field, Translator<T> translator, MessageFormatter formatter, FormSupport formSupport)`
    `FieldValidatorImpl(Field field, Object constraintValue, MessageFormatter messageFormatter, Validator validator, FormSupport formSupport)`

  - ### Uses of Field in org.apache.tapestry5.internal.translator

    Methods in org.apache.tapestry5.internal.translator with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `T` | NumericTranslator.`parseClient(Field field, String clientValue, String message)`
    `String` | StringTranslator.`parseClient(Field field, String clientValue, String message)` Passes the clientValue through unchanged.
    `void` | NumericTranslator.`render(Field field, String message, MarkupWriter writer, FormSupport formSupport)`
    `void` | StringTranslator.`render(Field field, String message, MarkupWriter writer, FormSupport formSupport)` Does nothing.

  - ### Uses of Field in org.apache.tapestry5.internal.util

    Methods in org.apache.tapestry5.internal.util with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | ValidationDecoratorWrapper.`afterField(Field field)`
    `void` | ValidationDecoratorWrapper.`afterLabel(Field field)`
    `void` | ValidationDecoratorWrapper.`beforeField(Field field)`
    `void` | ValidationDecoratorWrapper.`beforeLabel(Field field)`
    `void` | AutofocusValidationDecorator.`insideField(Field field)`
    `void` | ValidationDecoratorWrapper.`insideField(Field field)`
    `void` | ValidationDecoratorWrapper.`insideLabel(Field field, Element labelElement)`

  - ### Uses of Field in org.apache.tapestry5.kaptcha.components

    Classes in org.apache.tapestry5.kaptcha.components that implement Field
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KaptchaField` Field paired with a `KaptchaImage` to ensure that the user has provided the correct value.

  - ### Uses of Field in org.apache.tapestry5.services

    Methods in org.apache.tapestry5.services with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientBehaviorSupport.`addValidation(Field field, String validationName, String message, Object constraint)` Deprecated. Collects field validation information.
    `void` | FormSupport.`addValidation(Field field, String validationName, String message, Object constraint)` Deprecated. Deprecated in 5.4 with no exact replacement; this default implementation now does nothing. Invoke `FormSupport.isClientValidationEnabled()`, and (if true), use `JavaScriptSupport` to add necessary modules, and add triggering and configuring attributes to the field's `Element`.
    `FieldTranslator` | FieldTranslatorSource.`createDefaultTranslator(Field field, String overrideId, Messages overrideMessages, Locale locale, Class propertyType, AnnotationProvider propertyAnnotations)` Creates a `FieldTranslator` for the given property, or returns null if one can't be constructed.
    `FieldValidator` | FieldValidatorDefaultSource.`createDefaultValidator(Field field, String overrideId, Messages overrideMessages, Locale locale, Class propertyType, AnnotationProvider propertyAnnotations)` Analyzes the property type and property annotations to determine the default set of validations for the property, which are wrapped to form a `FieldValidator` for a field.
    `FieldTranslator` | FieldTranslatorSource.`createTranslator(Field field, String overrideId, Messages overrideMessages, Locale locale, Translator translator)` Wraps a `Translator` as a FieldTranslator.
    `FieldValidator` | FieldValidatorSource.`createValidator(Field field, String validatorType, String constraintValue)` Creates the validator.
    `FieldValidator` | FieldValidatorSource.`createValidator(Field field, String validatorType, String constraintValue, String overrideId, Messages overrideMessages, Locale locale)` Full featured version of `FieldValidatorSource.createValidator(Field, String, String)` used in situations where the container of the field is not necesarrilly the place to look for override messages, and the id of the field is not the key to use when checking.
    `FieldValidator` | FieldValidatorSource.`createValidators(Field field, String specification)` Creates a set of validators.
    `FieldTranslator` | PropertyEditContext.`getTranslator(Field field)` Returns the translator appropriate for the field (this is based on the property type).
    `FieldValidator` | PropertyEditContext.`getValidator(Field field)` Returns the FieldValidator for the field.

  - ### Uses of Field in org.apache.tapestry5.test

    Methods in org.apache.tapestry5.test that return Field
    Modifier and Type | Method and Description
    --- | ---
    `protected Field` | TapestryTestCase.`mockField()`
    `protected Field` | TapestryTestCase.`mockFieldWithLabel(String label)`

    Methods in org.apache.tapestry5.test with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | TapestryTestCase.`train_createValidator(FieldValidatorSource source, Field field, String validatorType, String constraintValue, String overrideId, Messages overrideMessages, Locale locale, FieldValidator result)`
    `protected void` | TapestryTestCase.`train_getInput(ValidationTracker tracker, Field field, String input)`
    `protected void` | TapestryTestCase.`train_getLabel(Field field, String label)`
    `protected void` | TapestryTestCase.`train_inError(ValidationTracker tracker, Field field, boolean inError)`
    `protected void` | TapestryTestCase.`train_isDisabled(Field field, boolean disabled)`
    `protected void` | TapestryTestCase.`train_isRequired(Field field, boolean required)`

  - ### Uses of Field in org.apache.tapestry5.upload.components

    Classes in org.apache.tapestry5.upload.components that implement Field
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Upload` A component to upload a file.

  - ### Uses of Field in org.apache.tapestry5.validator

    Methods in org.apache.tapestry5.validator with parameters of type Field
    Modifier and Type | Method and Description
    --- | ---
    `void` | MaxLength.`render(Field field, Integer constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | MinLength.`render(Field field, Integer constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | Max.`render(Field field, Long constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | Min.`render(Field field, Long constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | Regexp.`render(Field field, Pattern constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | Email.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | None.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)` Does nothing.
    `void` | Required.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
    `void` | MaxLength.`validate(Field field, Integer constraintValue, MessageFormatter formatter, String value)`
    `void` | MinLength.`validate(Field field, Integer constraintValue, MessageFormatter formatter, String value)`
    `void` | Max.`validate(Field field, Long constraintValue, MessageFormatter formatter, Number value)`
    `void` | Min.`validate(Field field, Long constraintValue, MessageFormatter formatter, Number value)`
    `void` | Regexp.`validate(Field field, Pattern constraintValue, MessageFormatter formatter, String value)`
    `void` | None.`validate(Field field, Void constraintValue, MessageFormatter formatter, Object value)` Does nothing.
    `void` | Required.`validate(Field field, Void constraintValue, MessageFormatter formatter, Object value)`
    `void` | Email.`validate(Field field, Void constraintValue, MessageFormatter formatter, String value)`

${project.version} - Copyright © 2003-2014 The Apache Software Foundation.