FieldDefinition (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.repo.forms.FieldDefinition

Direct Known Subclasses:

AssociationFieldDefinition, PropertyFieldDefinition
```
public abstract class FieldDefinition
extends Object
```
Abstract representation of a field defintion.

Author:

Gavin Cornwell

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`binding`
`protected String`	`dataKeyName`
`protected String`	`defaultValue`
`protected String`	`description`
`protected FieldGroup`	`group`
`protected String`	`label`
`protected String`	`name`
`protected boolean`	`protectedField`

Constructor Summary

Constructors
Constructor and Description

FieldDefinition(String name)
Default constructor

Constructors
Constructor and Description
`FieldDefinition(String name)` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBinding()` Returns the binding for the field, this is used by some FormModelProcessor implementations to generate an alternative representation of the data
`String`	`getDataKeyName()` Returns the name of the key being used to hold the data for the field
`String`	`getDefaultValue()` Returns any default value the field may have
`String`	`getDescription()` Returns the description of the field
`FieldGroup`	`getGroup()` Returns the group the field may be a part of
`String`	`getLabel()` Returns the display label for the field
`String`	`getName()` Returns the name of the field
`boolean`	`isProtectedField()` Determines whether the field is protected i.e.
`void`	`setBinding(String binding)` Sets the binding to use for the field, this is used by some FormModelProcessor implementations to generate an alternative representation of the data
`void`	`setDataKeyName(String dataKeyName)` Sets the name of the key to be used to hold the data for the field
`void`	`setDefaultValue(String defaultValue)` Sets the default value for the field
`void`	`setDescription(String description)` Sets the description of the field
`void`	`setGroup(FieldGroup group)` Sets the group the field is part of
`void`	`setLabel(String label)` Sets the display label for the field
`void`	`setProtectedField(boolean protectedField)` Sets whether the field is protected i.e.

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

- Field Detail
  - name
```
protected String name
```
  - label
```
protected String label
```
  - description
```
protected String description
```
  - binding
```
protected String binding
```
  - defaultValue
```
protected String defaultValue
```
  - dataKeyName
```
protected String dataKeyName
```
  - group
```
protected FieldGroup group
```
  - protectedField
```
protected boolean protectedField
```
- Constructor Detail
  - FieldDefinition
```
public FieldDefinition(String name)
```
    Default constructor
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the field
    
    Returns:
    
    The field's name
  - getLabel
```
public String getLabel()
```
    Returns the display label for the field
    
    Returns:
    
    The field's display label
  - setLabel
```
public void setLabel(String label)
```
    Sets the display label for the field
    
    Parameters:
    
    label - The field's display label
  - getDescription
```
public String getDescription()
```
    Returns the description of the field
    
    Returns:
    
    The field's description
  - setDescription
```
public void setDescription(String description)
```
    Sets the description of the field
    
    Parameters:
    
    description - The field's description
  - getBinding
```
public String getBinding()
```
    Returns the binding for the field, this is used by some FormModelProcessor implementations to generate an alternative representation of the data
    
    Returns:
    
    The field's binding
  - setBinding
```
public void setBinding(String binding)
```
    Sets the binding to use for the field, this is used by some FormModelProcessor implementations to generate an alternative representation of the data
    
    Parameters:
    
    binding - The field's binding
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns any default value the field may have
    
    Returns:
    
    The field's default value or null if there isn't one
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    Sets the default value for the field
    
    Parameters:
    
    defaultValue - The field's default value
  - getDataKeyName
```
public String getDataKeyName()
```
    Returns the name of the key being used to hold the data for the field
    
    Returns:
    
    Name of the key being used to hold the data for the field
  - setDataKeyName
```
public void setDataKeyName(String dataKeyName)
```
    Sets the name of the key to be used to hold the data for the field
    
    Parameters:
    
    dataKeyName - The name of the key to be used to hold the data for the field
  - getGroup
```
public FieldGroup getGroup()
```
    Returns the group the field may be a part of
    
    Returns:
    
    The field's group or null if it does not belong to a group
  - setGroup
```
public void setGroup(FieldGroup group)
```
    Sets the group the field is part of
    
    Parameters:
    
    group - The group the field belongs to
  - isProtectedField
```
public boolean isProtectedField()
```
    Determines whether the field is protected i.e. it should be rendered as read-only in any client displaying the field
    
    Returns:
    
    true if the field is protected
  - setProtectedField
```
public void setProtectedField(boolean protectedField)
```
    Sets whether the field is protected i.e. it should be rendered as read-only in any client displaying the field
    
    Parameters:
    
    protectedField - true if the field is protected

Class FieldDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

label

description

binding

defaultValue

dataKeyName

group

protectedField

Constructor Detail

FieldDefinition

Method Detail

getName

getLabel

setLabel

getDescription

setDescription

getBinding

setBinding

getDefaultValue

setDefaultValue

getDataKeyName

setDataKeyName

getGroup

setGroup

isProtectedField

setProtectedField