classafFormBean::FormField

HTML attribute. Any other miscellaneous attributes that should be rendered on the <input>. Example:

attributes = "data-foo='bar'"

HTML attribute. The value to render as an autocomplete attribute on the <input>. See autocomplete on whatwg and MDN for valid values. Example:

autocomplete = "cc-number"

Used by the <select> renderer. This is the label to display in the blank option.

leave as null to use OptionsProvider.blankLabel value.

HTML attribute. The value to render as a CSS class attribute on the <input>.

HTML attribute. If true then a disabled attribute is rendered on the <input>.

Performs basic HTML5 validation.

The error message associated with this field.

Setting this to a non-null value invalidate the form field.

The Fantom field this FormField represents.

A link back to the owning FormBean instance.

Used as temporary store when uploading binary data, such as Bufs and Files. Contains the value that the form field will be set to.

The Str value that will be rendered in the HTML form. You may set this value before the form is rendered to set a default value.

If the formValue is null then the field value is used instead and converted by valueEncoder.

This formValue is also set during form validation so any user entered values are re-rendered should the form be re-displayed.

If non-null an extra <div> is rendered after the <input> to supply a helpful hint. The hint is usually rendered with the formBean-hint CSS class.

The InputSkin used to render the field to HTML.

If null then a default InputSkin is chosen based on the type attribute.

Is this form field invalid?

Setting this to false also clears any errMsg.

The label to display next to the <input>.

If null then it defaults to a human readable version of the field name.

Create FormField instances via IoC:

formField := scope.build(FormField#, [field, formBean])

HTML5 validation attribute. Sets the maximum value (inclusive) for numbers (Int) and dates (Date).

HTML5 validation attribute. Sets the maximum value (inclusive). May be an Int, Date, DateTime, or Str.

HTML5 validation attribute. Sets the minimum value (inclusive). May be an Int, Date, DateTime, or Str.

HTML5 validation attribute. Sets the minimum length (inclusive) a string should be.

Returns a message for the given field. Messages are looked up in the following order:

• <bean>.<field>.<key>
• <field>.<key>
• <key>

And the following substitutions are made:

• ${label} -> formField.label
• ${value} -> formField.formValue
• ${arg1} -> arg1.toStr
• ${arg2} -> arg2.toStr
• ${arg3} -> arg3.toStr

The form value is substituted for ${value} because it is intended for use by validation msgs.

Returns null if a msg could not be found.

Used by the <select> renderer. The OptionsProvider used to supply option values when rendering <select> tags.

If null then a default OptionsProvider is chosen based on the field type.

HTML5 validation attribute. Sets a regular expression that the (stringified) value should match. Starting ^ and ending $ characters are implicit and not required.

HTML attribute. The value to render as a placeholder attribute on the <input>.

Populates this FormField instance with values from the @HtmlInput facet (if any) and message values.

Hook to render this field to HTML. By default this defers rendering to an InputSkin.

Override to perform custom field rendering.

HTML5 validation attribute. Set to true to mark the input as required. If null (the default) then the input is required if the field is non-nullable.

Sets the given form field message. Messages are stored in the FormBean under the key:

• <bean>.<field>.<key>

null values are removed from the messges map.

Used by the <select> renderer. Set to true to show a blank value at the start of the options list.

leave as null to use OptionsProvider.showBlank value.

A general stash, handy for passing data to static validate methods.

HTML5 validation attribute. Defines the interval for a numeric input.

Converts the given value to a string using the preferred ValueEncoder.

Converts the given client value (string) to a server side object using the preferred ValueEncoder.

HTML attribute. The type of input to render.

If null then it defaults to text.

Validates this form field. Calls doHtmlValidation() and then any static @Validate method that corresponds to this field.

@Validate methods may check invalid and errMsg to ascertain if any previous validation failed.

After validation check the value of the invalid and errMsg fields.

A static method that performs extra server side validation.

The afBedSheet::ValueEncoder used to convert the field value to and from a Str.

If null then a default ValueEncoder based on the field type is chosen from BedSheet's ValueEncoders service.

If true then the field is rendered into the HTML form as normal, but no attempt is made to validate the form value or decode it back to a Fantom value.

Useful for rendering static, read only, HTML associated with the field.