ch.rasc.extclassgenerator

Annotation Type ModelField

@Target(value={FIELD,METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Repeatable(value=ModelFields.class)
public @interface ModelField

Annotation that configures different aspects of a model field. The annotation does not have to be present on the field to be included in the generated JS code. The generator takes all public readable fields into account.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULTVALUE_UNDEFINED Constant for the value undefined.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowBlank Used for validating a model.
boolean	allowNull Use when converting received data into a integer, float/number, boolean or string type.
String	calculate This config defines a simple field calculation function.
String	convert Function which coerces string values in raw data into the field's type Typical use for a virtual field Property ' Ext.data.Field#convert' in JS.
boolean	critical A critical field is a field that must always be sent to the server even if it has not changed.
String	customType Type of the field.
String	dateFormat Specifies format of date.
String	defaultValue The default value.
String[]	depends The field name or names within the Model on which the value of this field depends, and from which a new value may be calculated.
String	mapping Typical use for a virtual field to extract field data from the model object Property ' mapping' in JS.
boolean	persist If set to false prevents the value of this field to be serialized or written with Ext.data.writer.Writer Typical use for a virtual field Property ' persist' in JS.
ReferenceConfig	reference Defines a relationship to another model.
ModelType	type Type of the field.
boolean	unique true if the value of this field is unique amongst all instances.
boolean	useNull If true null value is used if value cannot be parsed.
String	value Name of the field.

Field Detail

DEFAULTVALUE_UNDEFINED

public static final String DEFAULTVALUE_UNDEFINED

Constant for the value undefined. Can only be used for the property defaultValue(). According to the documentation setting defaultValue to undefined prevents defaulting a value.

Element Detail

value

public abstract String value

Name of the field. Property ' name ' in JS.

If not present the name of the field is used.

Default:

""

type

public abstract ModelType type

Type of the field. Property ' type ' in JS.

If not present and Model.autodetectTypes() is true the generator tries to figure out the type. If not present and Model.autodetectTypes() is false the type is set to 'auto'.

Default:

ch.rasc.extclassgenerator.ModelType.NOT_SPECIFIED

customType

public abstract String customType

Type of the field. Property ' type ' in JS. This is used for the new Ext JS 5 Custom Field Types feature.

If not present the library tries to figure out the type.

If type() and customType() are present customType() has precedence.

Default:

""

defaultValue

public abstract String defaultValue

The default value. Property ' defaultValue' in JS.

Can be set to DEFAULTVALUE_UNDEFINED to set defaultValue to the value undefined. This prevents defaulting a value.

Default:

""

dateFormat

public abstract String dateFormat

Specifies format of date. Property ' dateFormat' in JS.
For a list of all supported formats see Sencha Doc: Ext.Date

Will be ignored if the field is not a ModelType.DATE field.

Default:

""

useNull

public abstract boolean useNull

If true null value is used if value cannot be parsed. If false default values are used (0 for integer and float, "" for string and false for boolean).
Property ' useNull' in JS.

Only used if type of field is ModelType.INTEGER, ModelType.FLOAT, ModelType.NUMBER, ModelType.STRING or ModelType.BOOLEAN.

Default:

false

allowNull

public abstract boolean allowNull

Use when converting received data into a integer, float/number, boolean or string type. If the value cannot be parsed, null will be used if allowNull is true, otherwise a default value for that type will be used (0 for integer and float/number, "" for string and false for boolean)

See Ext.data.Field#allowNull

Defaults to false

Only used if type of field is ModelType.INTEGER, ModelType.FLOAT, ModelType.NUMBER, ModelType.STRING or ModelType.BOOLEAN.

This is another name for useNull(). Both properties behave exactly the same. Use only one.

Default:

false

allowBlank

public abstract boolean allowBlank

Used for validating a model.

Set Ext.data.Field#allowBlank

Defaults to true

Default:

true

mapping

public abstract String mapping

Typical use for a virtual field to extract field data from the model object
Property ' mapping' in JS.

Default:

""

persist

public abstract boolean persist

If set to false prevents the value of this field to be serialized or written with Ext.data.writer.Writer
Typical use for a virtual field
Property ' persist' in JS.

Defaults to true

Default:

true

critical

public abstract boolean critical

A critical field is a field that must always be sent to the server even if it has not changed.

See Ext.data.field.FieldView#critical

Defaults to false

Default:

false

depends

public abstract String[] depends

The field name or names within the Model on which the value of this field depends, and from which a new value may be calculated. These values are the values used by the convert() method. If you do not have a convert() method then this config should not be specified. Before using this config you should consider if using a calculate() method instead of a convert() method would be simpler.

See Ext.data.field.FieldView#depends

Defaults to null

Default:

{}

convert

public abstract String convert

Function which coerces string values in raw data into the field's type
Typical use for a virtual field
Property ' Ext.data.Field#convert' in JS.

Default:

""

calculate

public abstract String calculate

This config defines a simple field calculation function. A calculate method only has access to the record data and should return the value of the calculated field. When provided in this way, the depends config is automatically determined by parsing the calculate function. See Ext.data.Field#calculate

Default:

""

unique

public abstract boolean unique

true if the value of this field is unique amongst all instances. When used with a reference this describes a "one-to-one" relationship

See Ext.data.Field#unique

Defaults to false

Default:

false

reference

public abstract ReferenceConfig reference

Defines a relationship to another model.

See Ext.data.Field#reference

Default:

@ch.rasc.extclassgenerator.ReferenceConfig