com.adobe.icc.dbforms.obj

Class Field

java.lang.Object

com.adobe.icc.dbforms.obj.Field

All Implemented Interfaces:

Serializable, Comparable<Field>

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.

Constructor Summary

Constructors

Constructor and Description
Field()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Field f)
String	getCaption()
String	getDisplayName() Get the display name for the Field.
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()
String	getXfaFieldType()
boolean	isMasterPageField()
void	setCaption(String caption)
void	setDisplayName(String displayName) Sets the display name for the Field.
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	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)