field

Includes a field of the specified type in the query editor.

Syntax

<field
    name="text"
    inner="(true|false)"?
    ( type="(text|number|boolean)" | type="enumeration" enum="text" | type="lookup" source="text" multiple="(true|false)" )
  />

Attributes

name="text"

The name of the field. The name you specify must be unique among the fields in this editor.

inner="(true|false)" (optional)

Specifies whether or not the field is a standard, predefined Widget Framework query field, or a custom field. This affects how the field contents are accessed in your Java handler class.

If you specify true, then the field name must exactly match one of the properties of the com.escenic.framework.datasource.model.SourceDefinition class, and will be accessible using its get method in the Java handler class. If you specify false or omit this attribute, then the field will be added to SourceDefinition's Fields property, which contains a map of all custom fields. If you specify true, for a field that does not exactly match one of SourceDefinition's properties, then an exception will be thrown at run-time.

For further information about this, see Creating a Handler Class.

type="(text|number|boolean)"

Specifies the type of value the field will accept.

Allowed values are:

text: The field will accept any text value.
number: The field will only accept numerical value.
boolean: The field will be displayed as a check box, only capable of accepting on/off values.

type="enumeration"

Specifies that the field will be displayed as a drop-down box containing a list of allowed values.

enum="text"

The name of an enumeration definition containing a list of options to display. The enumeration must be defined in a properties file (/com/escenic/framework/ui/Enumerations.properties) in the Widget Framework's global configuration layer. For further information, see Defining Enumeration Options.

type="lookup"

Specifies that the field will be displayed as a "type-to-select" box where the characters the user enters are used to look up matching system objects from which he can then make a selection.

source="text"

The name of the web service that performs the look-up. This name must match a service definition listed in a properties file (/com/escenic/framework/webservice/LookupSources.properties) in the Widget Framework's global configuration layer. For further information, see Defining Look-up Services.

multiple="(true|false)" (optional)

Determines whether or not this lookup field allows multiple entries.

Allowed values are:

true: Multiple entries are allowed.
false: Multiple entries are not allowed. (Default)