| com.ivata.mask.field.Field
All known Subclasses: com.ivata.mask.field.FieldImpl,
| Field | | public interface Field (Code) | | Defines a single field within a mask or group of masks.
since:
ivata masks 0.1 (2004-02-26)
author:
Colin MacLeod
author:
colin.macleod@ivata.com |
| Method Summary | |
| Properties | getChoiceProperties()
If this field represents a combo (select) type, returns the choices as a
Properties instance. | | List | getChoicePropertyKeys()
If this field represents a combo (select) type, returns the choice keys
as a List of String instances. | | Class | getDOClass()
Get the data object class for this field, if appropriate. | | String | getDefaultValue()
Get the default value for this field. | | String | getName()
Id of just this field. | | Field | getParent()
Get the field which contains this one. | | String | getPath()
Return the full path to this field, including the names of parent fields
separated by '.' characters. | | String | getType()
Indicates what sort of data this field should hold. | | Mask | getValueObjectMask()
If this field represents a value object, get the mask associated with
this value object. | | boolean | isDisplayOnly()
Get whether or not this field can be amended. | | boolean | isHidden()
| | boolean | isMandatory()
Is this field required or optional?
true if this field is required and must have anon- null, non-empty value. | | boolean | isOneToOne()
If this field represents another value object, but the relationship with
its container is one-to-one, then it can be included in the parent's
mask directly. |
| TYPE_AMOUNT | | String TYPE_AMOUNT(Code) | | Indicates the fields contents should be formatted as an amount.
|
| TYPE_DATE | | String TYPE_DATE(Code) | | Indicates the fields contents should be formatted as a date.
|
| TYPE_NUMBER | | String TYPE_NUMBER(Code) | | Indicates the fields contents should be formatted as a number.
|
| TYPE_PASSWORD | | String TYPE_PASSWORD(Code) | | Indicates the field is an option to be displayed as a password field.
|
| TYPE_RADIO | | String TYPE_RADIO(Code) | | Indicates the field is an option to be displayed as a radio button.
|
| TYPE_SELECT | | String TYPE_SELECT(Code) | | Indicates the field is displayed as a choice combo box.
|
| TYPE_STRING | | String TYPE_STRING(Code) | | Indicates the field is displayed as a short text.
|
| TYPE_TEXTAREA | | String TYPE_TEXTAREA(Code) | | Indicates the field is displayed as a long text.
|
| TYPE_TIMESTAMP | | String TYPE_TIMESTAMP(Code) | | Indicates the fields contents should be formatted as a long timestamp.
|
| getChoiceProperties | | Properties getChoiceProperties()(Code) | | If this field represents a combo (select) type, returns the choices as a
Properties instance.
Properties instance representing the possiblevalues. |
| getChoicePropertyKeys | | List getChoicePropertyKeys()(Code) | | If this field represents a combo (select) type, returns the choice keys
as a List of String instances.
List of String instancesrepresenting the key values of all choice options. |
| getDOClass | | Class getDOClass()(Code) | | Get the data object class for this field, if appropriate.
data object class if this field links to a data object, otherwisenull. |
| getDefaultValue | | String getDefaultValue()(Code) | | Get the default value for this field. If no default has been defined for
this field, is null.
default value for this field, or null if none isdefined. |
| getName | | String getName()(Code) | | Id of just this field.
Id of just this field. |
| getParent | | Field getParent()(Code) | |
Get the field which contains this one.
Field which contains this field, or null if thisis a top-level field. |
| getPath | | String getPath()(Code) | |
Return the full path to this field, including the names of parent fields
separated by '.' characters.
Full path to this field, to uniquely identify it within thesystem. |
| getType | | String getType()(Code) | | Indicates what sort of data this field should hold.
type of the field, from one of the TYPE_ values inthis interface. |
| getValueObjectMask | | Mask getValueObjectMask()(Code) | |
If this field represents a value object, get the mask associated with
this value object. Note: this is not the mask the field is in!.
Mask associated with this value object or null ifthis field is not a value object. |
| isDisplayOnly | | boolean isDisplayOnly()(Code) | | Get whether or not this field can be amended. Useful for automatically
generated fields such as timestamps.
true if the field cannot be manually changed. |
| isHidden | | boolean isHidden()(Code) | |
Is this field hidden or displayed?
true if this field is hidden. |
| isMandatory | | boolean isMandatory()(Code) | |
Is this field required or optional?
true if this field is required and must have anon- null, non-empty value. Otherwise,false for an optional field. |
| isOneToOne | | boolean isOneToOne()(Code) | | If this field represents another value object, but the relationship with
its container is one-to-one, then it can be included in the parent's
mask directly.
true if this field should be displayed directlyin the mask of the parent field. |
|
|