(Quick Reference)

customField

Purpose

Adds a DefaultCustomField to the parent container.

Examples

// Within a form
<v:form bean="${bookInstance}">
  <v:customField name="customField" caption="My Field">
	<ul>
		<li>Author: ${bookInstance.author}<li>
		<li>Title: ${bookInstance.title}</li>
	<ul>
  </v:customField>
</v:form>

// Standalone <v:customField>My Custom Field</v:customField>

Description

The customField tag is a special type of field tag, where the field component is a DefaultCustomField.

This is a subclass of the CustomField class in the customfield Vaadin Addon.

The customfield Addon allows creating fields with arbitrary layouts inside a form.

Body

  • Contains the field interface - any combination of HTML and tags.

Attributes

Specific
  • name (required) The property name of the field
  • caption (optional) The caption of the field. Unlike other fields, this cannot be obtained from the body, so should be set explicitly as an attribute.

General
  • var (optional) Uses Grails's set tag to set the value of the specified variable to be this component.
  • class (optional) The CSS class name to add to the component using the addStyleName() method
  • sizeUndefined (optional) Calls setSizeUndefined() on the component. (Attribute value is ignored)
  • sizeFull (optional) Calls setSizeFull() on the component. (Attribute value is ignored)

See Vaadin DefaultCustomField API docs for full list of allowed attributes.