net.sf.mpxj

Class CustomField

java.lang.Object

net.sf.mpxj.CustomField

All Implemented Interfaces:

Comparable<CustomField>

public class CustomField
extends Object
implements Comparable<CustomField>

Configuration detail for a field.

Constructor Summary

Constructors

Constructor and Description
CustomField(FieldType field, CustomFieldContainer parent) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CustomField f)
String	getAlias() Retrieve the alias for this field.
FieldType	getFieldType() Retrieve the field type represented by this instance.
GraphicalIndicator	getGraphicalIndicator() Retrieve the graphical indicator configuration for this field.
CustomFieldLookupTable	getLookupTable() Retrieve the value lookup table associated with this field.
List<CustomFieldValueMask>	getMasks() Retrieve the mask definitions for this field.
Integer	getUniqueID() Retrieve the Unique ID for this field.
CustomField	setAlias(String alias) Set the alias for this field.
CustomField	setUniqueID(Integer uniqueID) Set the Unique ID for this field.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomField

public CustomField(FieldType field,
                   CustomFieldContainer parent)

Constructor.

Parameters:

field - field

parent - parent container

Method Detail

getFieldType

public FieldType getFieldType()

Retrieve the field type represented by this instance.

Returns:

field type

getLookupTable

public CustomFieldLookupTable getLookupTable()

Retrieve the value lookup table associated with this field.

Returns:

value lookup table

getGraphicalIndicator

public GraphicalIndicator getGraphicalIndicator()

Retrieve the graphical indicator configuration for this field.

Returns:

graphical indicator configuration

getAlias

public String getAlias()

Retrieve the alias for this field.

Returns:

field alias

setAlias

public CustomField setAlias(String alias)

Set the alias for this field.

Parameters:

alias - field alias

Returns:

this to allow method chaining

getUniqueID

public Integer getUniqueID()

Retrieve the Unique ID for this field. If this value is not set explicitly, it defaults to the field ID used by Microsoft Project.

Returns:

Unique ID

setUniqueID

public CustomField setUniqueID(Integer uniqueID)

Set the Unique ID for this field.

Parameters:

uniqueID - Unique ID

Returns:

this to allow method chaining

getMasks

public List<CustomFieldValueMask> getMasks()

Retrieve the mask definitions for this field.

Returns:

list of mask definitions

compareTo

public int compareTo(CustomField f)

Specified by:

compareTo in interface Comparable<CustomField>

toString

public String toString()

Overrides:

toString in class Object