ModelFieldBean (Ext Class Generator 1.0.8 API)

java.lang.Object
- ch.rasc.extclassgenerator.ModelFieldBean

public class ModelFieldBean
extends Object

Represents one field in a ModelBean

Constructor Summary

Constructors
Constructor and Description
`ModelFieldBean(String name, ch.rasc.extclassgenerator.ModelType type)` Creates a new ModelFieldBean with name and type
`ModelFieldBean(String name, String type)` Creates a new ModelFieldBean with name and type

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAllowBlank()`
`Boolean`	`getAllowNull()`
`String`	`getCalculate()`
`String`	`getConvert()`
`Boolean`	`getCritical()`
`String`	`getDateFormat()`
`Object`	`getDefaultValue()`
`List<String>`	`getDepends()`
`String`	`getMapping()`
`ch.rasc.extclassgenerator.ModelType`	`getModelType()`
`String`	`getName()`
`Boolean`	`getPersist()`
`Object`	`getReference()`
`String`	`getType()`
`Boolean`	`getUnique()`
`Boolean`	`getUseNull()`
`List<AbstractValidation>`	`getValidators()`
`boolean`	`hasOnlyName(OutputConfig outputConfig)` Returns true if only the name property is set
`void`	`setAllowBlank(Boolean allowBlank)` Used for validating a model.
`void`	`setAllowNull(Boolean allowNull)` Use when converting received data into a `integer`, `float/number`, `boolean` or `string` type.
`void`	`setCalculate(String calculate)` This config defines a simple field calculation function.
`void`	`setConvert(String convert)` Function which coerces string values in raw data into the field's type Typical use for a virtual field http://localhost/ext4.1/docs/index.html#!/api/Ext.data.Field-cfg-convert Property ' Ext.data.Field.convert' in JS.
`void`	`setCritical(Boolean critical)` A critical field is a field that must always be sent to the server even if it has not changed.
`void`	`setDateFormat(String dateFormat)` Specifies format of date.
`void`	`setDefaultValue(Object defaultValue)` The default value.
`void`	`setDepends(List<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.
`void`	`setMapping(String mapping)` Typical use for a virtual field to extract field data from the model object Property ' mapping' in JS.
`void`	`setModelType(ch.rasc.extclassgenerator.ModelType type)` Type of the field.
`void`	`setName(String name)` Name of the field.
`void`	`setPersist(Boolean persist)` Prevent 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.
`void`	`setReference(Object reference)` Defines a relationship to another model.
`void`	`setUnique(Boolean unique)` true if the value of this field is unique amongst all instances.
`void`	`setUseNull(Boolean useNull)` If true null value is used if value cannot be parsed.
`void`	`setValidators(List<AbstractValidation> validators)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ModelFieldBean
```
public ModelFieldBean(String name,
                      ch.rasc.extclassgenerator.ModelType type)
```
    Creates a new ModelFieldBean with name and type
    
    Parameters:
    
    name - name of the field
    
    type - type of the field
  - ModelFieldBean
```
public ModelFieldBean(String name,
                      String type)
```
    Creates a new ModelFieldBean with name and type
    
    Parameters:
    
    name - name of the field
    
    type - type of the field
- Method Detail
  - hasOnlyName
```
public boolean hasOnlyName(OutputConfig outputConfig)
```
    Returns true if only the name property is set
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
    Name of the field. Property ' name ' in JS.
    
    Parameters:
    
    name - new name for the field
  - getModelType
```
public ch.rasc.extclassgenerator.ModelType getModelType()
```
  - getType
```
public String getType()
```
  - setModelType
```
public void setModelType(ch.rasc.extclassgenerator.ModelType type)
```
    Type of the field. Property ' type ' in JS.
    
    Parameters:
    
    type - new type for the field
  - getDefaultValue
```
public Object getDefaultValue()
```
  - setDefaultValue
```
public void setDefaultValue(Object defaultValue)
```
    The default value. Property ' defaultValue' in JS.
    
    Parameters:
    
    defaultValue - new defaultValue
  - getDateFormat
```
public String getDateFormat()
```
  - setDateFormat
```
public void setDateFormat(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.
    
    Parameters:
    
    dateFormat - new dateFormat String
  - getUseNull
```
public Boolean getUseNull()
```
  - setUseNull
```
public void setUseNull(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.
    
    Parameters:
    
    useNull - new value for useNull
  - getMapping
```
public String getMapping()
```
  - setMapping
```
public void setMapping(String mapping)
```
    Typical use for a virtual field to extract field data from the model object
    Property ' mapping' in JS.
    
    Parameters:
    
    mapping - A path expression
  - getPersist
```
public Boolean getPersist()
```
  - setPersist
```
public void setPersist(Boolean persist)
```
    Prevent 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.
    
    Parameters:
    
    persist - defaults to true, only a false value will be generated
  - getCritical
```
public Boolean getCritical()
```
  - setCritical
```
public void setCritical(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
  - getConvert
```
public String getConvert()
```
  - setConvert
```
public void setConvert(String convert)
```
    Function which coerces string values in raw data into the field's type
    Typical use for a virtual field
    http://localhost/ext4.1/docs/index.html#!/api/Ext.data.Field-cfg-convert Property ' Ext.data.Field.convert' in JS.
    
    Parameters:
    
    convert - A function. JavaScript Syntax example: function(v, record) { return ... ; }
  - getCalculate
```
public String getCalculate()
```
  - setCalculate
```
public void setCalculate(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
  - getValidators
```
public List<AbstractValidation> getValidators()
```
  - setValidators
```
public void setValidators(List<AbstractValidation> validators)
```
  - getDepends
```
public List<String> getDepends()
```
  - setDepends
```
public void setDepends(List<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
  - getReference
```
public Object getReference()
```
  - setReference
```
public void setReference(Object reference)
```
    Defines a relationship to another model. Either a string or an instace of type ReferenceBean
    See Ext.data.Field#reference
  - getAllowNull
```
public Boolean getAllowNull()
```
  - setAllowNull
```
public void setAllowNull(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 setUseNull(Boolean). Both properties behave exactly the same. Use only one.
  - getAllowBlank
```
public Boolean getAllowBlank()
```
  - setAllowBlank
```
public void setAllowBlank(Boolean allowBlank)
```
    Used for validating a model.
    Set Ext.data.Field#allowBlank
    Defaults to true
  - getUnique
```
public Boolean getUnique()
```
  - setUnique
```
public void setUnique(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

Class ModelFieldBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelFieldBean

ModelFieldBean

Method Detail

hasOnlyName

getName

setName

getModelType

getType

setModelType

getDefaultValue

setDefaultValue

getDateFormat

setDateFormat

getUseNull

setUseNull

getMapping

setMapping

getPersist

setPersist

getCritical

setCritical

getConvert

setConvert

getCalculate

setCalculate

getValidators

setValidators

getDepends

setDepends

getReference

setReference

getAllowNull

setAllowNull

getAllowBlank

setAllowBlank

getUnique

setUnique