Field (AEM Forms API)

java.lang.Object
- com.adobe.icc.dbforms.obj.Field

All Implemented Interfaces:

Serializable, Comparable<Field>
```
@Model
public class Field
extends Object
implements Serializable, Comparable<Field>
```
POJO representation of a Field in a Layout (XDP).

Contains the display name, SOM expression, etc. for the Field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Field.FieldType
Enum for various types of Field, such as Date, Time, Integer, Float, etc.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Field.FieldType` Enum for various types of Field, such as Date, Time, Integer, Float, etc.

Constructor Summary

Constructors
Constructor and Description

Field()

Constructors
Constructor and Description
`Field()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Field f)`
`String`	`getCaption()`
`String`	`getDisplayName()` Get the display name for the Field.
`Double`	`getHeight()`
`String`	`getId()` Get the unique identifier for the Field.
`List<String>`	`getLabels()`
`String`	`getPath()` Get the unique path (XFA SOM expression) for the Field.
`Integer`	`getPosition()` Get the position/order in which the Field appears in the Layout.
`Field.FieldType`	`getType()` Get the type for the Field.
`List<String>`	`getValues()`
`Double`	`getWidth()`
`String`	`getXfaFieldType()`
`boolean`	`isMasterPageField()`
`void`	`setCaption(String caption)`
`void`	`setDisplayName(String displayName)` Sets the display name for the Field.
`void`	`setHeight(Double height)`
`void`	`setId(String id)` Sets the unique identifier for the Field.
`void`	`setLabels(List<String> labels)`
`void`	`setMasterPageField(boolean masterPageField)`
`void`	`setPath(String path)` Sets the unique path (XFA SOM expression) for the Field.
`void`	`setPosition(Integer position)` Sets the position/order in which the Field appears in the Layout.
`void`	`setType(Field.FieldType type)` Sets the type for the Field.
`void`	`setValues(List<String> values)`
`void`	`setWidth(Double width)`
`void`	`setXfaFieldType(String xfaFieldType)`

- Constructor Detail
  - Field
```
public Field()
```
- Method Detail
  - isMasterPageField
```
public boolean isMasterPageField()
```
  - setMasterPageField
```
public void setMasterPageField(boolean masterPageField)
```
  - getId
```
public String getId()
```
    Get the unique identifier for the Field.
    
    Returns:
    
    The unique identifier for the Field.
  - setId
```
public void setId(String id)
```
    Sets the unique identifier for the Field.
    
    Parameters:
    
    id - The unique identifier for the Field.
  - getPath
```
public String getPath()
```
    Get the unique path (XFA SOM expression) for the Field.
    
    Returns:
    
    The unique path (XFA SOM expression) for the Field.
  - setPath
```
public void setPath(String path)
```
    Sets the unique path (XFA SOM expression) for the Field.
    
    Parameters:
    
    path - The unique path (XFA SOM expression) for the Field.
  - getDisplayName
```
public String getDisplayName()
```
    Get the display name for the Field.
    
    Returns:
    
    The display name for the Field.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the display name for the Field.
    
    Parameters:
    
    displayName - The display name for the Field.
  - getType
```
public Field.FieldType getType()
```
    Get the type for the Field.
    
    One of the Field.FieldTypes.
    
    Returns:
    
    The type for the Field.
  - setType
```
public void setType(Field.FieldType type)
```
    Sets the type for the Field.
    
    One of the Field.FieldTypes.
    
    Parameters:
    
    type - The type for the Field.
  - getPosition
```
public Integer getPosition()
```
    Get the position/order in which the Field appears in the Layout.
    
    Returns:
    
    The position/order in which the Field appears in the Layout.
  - setPosition
```
public void setPosition(Integer position)
```
    Sets the position/order in which the Field appears in the Layout.
    
    Parameters:
    
    position - The position/order in which the Field appears in the Layout.
  - compareTo
```
public int compareTo(Field f)
```
  - setCaption
```
public void setCaption(String caption)
```
  - getCaption
```
public String getCaption()
```
  - setLabels
```
public void setLabels(List<String> labels)
```
  - setValues
```
public void setValues(List<String> values)
```
  - getValues
```
public List<String> getValues()
```
  - getLabels
```
public List<String> getLabels()
```
  - getXfaFieldType
```
public String getXfaFieldType()
```
  - setXfaFieldType
```
public void setXfaFieldType(String xfaFieldType)
```
  - getWidth
```
public Double getWidth()
```
    Returns:
    
    width of the field if read from the layout, null otherwise. Currently we only read it in case of an Field.FieldType.IMAGE type Field
  - setWidth
```
public void setWidth(Double width)
```
  - getHeight
```
public Double getHeight()
```
    Returns:
    
    height of the field if read from the layout, null otherwise. Currently we only read it in case of an Field.FieldType.IMAGE type Field
  - setHeight
```
public void setHeight(Double height)
```

Class Field

Nested Class Summary

Constructor Summary

Method Summary

Constructor Detail

Field

Method Detail

isMasterPageField

setMasterPageField

getId

setId

getPath

setPath

getDisplayName

setDisplayName

getType

setType

getPosition

setPosition

compareTo

setCaption

getCaption

setLabels

setValues

getValues

getLabels

getXfaFieldType

setXfaFieldType

getWidth

setWidth

getHeight

setHeight