com.adobe.icc.dbforms.obj
Class Field

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class Field
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

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

static class

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

Constructor Summary

Field()

Method Summary

int	compareTo(Field f)
java.lang.String	getDisplayName() Get the display name for the Field.
java.lang.String	getId() Get the unique identifier for the Field.
java.lang.String	getPath() Get the unique path (XFA SOM expression) for the Field.
java.lang.Integer	getPosition() Get the position/order in which the Field appears in the Layout.
Field.FieldType	getType() Get the type for the Field.
void	setDisplayName(java.lang.String displayName) Sets the display name for the Field.
void	setId(java.lang.String id) Sets the unique identifier for the Field.
void	setPath(java.lang.String path) Sets the unique path (XFA SOM expression) for the Field.
void	setPosition(java.lang.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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

public Field()

Method Detail

getId

public java.lang.String getId()

Get the unique identifier for the Field.

Returns:

The unique identifier for the Field.

setId

public void setId(java.lang.String id)

Sets the unique identifier for the Field.

Parameters:

id - The unique identifier for the Field.

getPath

public java.lang.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(java.lang.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 java.lang.String getDisplayName()

Get the display name for the Field.

Returns:

The display name for the Field.

setDisplayName

public void setDisplayName(java.lang.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 java.lang.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(java.lang.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)

Specified by:

compareTo in interface java.lang.Comparable