com.canto.cumulus.prefs

Class RecordFieldList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.RecordFieldList

public class RecordFieldList
extends ListPackManager

This class manages a list of record fields.

See Also:

PrintSetAdvanced.getRecordFieldList(), RecordFieldOptions.getRecordFieldList()

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
RecordField	getRecordField(java.lang.String guid) Returns the record field for the given UID.
java.util.List<java.lang.String>	getRecordFieldNames() Returns a list of record field UIDs contained in this list.
java.util.List<RecordField>	getRecordFields() Returns a list of all record fields known to this list.
java.util.List<GUID>	getRecordFieldUIDs() Returns a list of record field UIDs contained in this list.
RecordField	insert(FieldDefinition fieldDefinition, int pos) Adds a new field to this list if no field using this fields UID has been added yet.
RecordField	insert(RecordField field, int pos) Inserts the given record field at the specified position.
RecordField	insertSeparator(java.lang.String name, int pos) Creates a new field grouping separator element at the given position.
void	moveDown(RecordField entry) Moves the specified entry one position down in this list.
void	moveDownToEnd(RecordField entry) Moves the specified entry to the last position in this list.
void	moveUp(RecordField entry) Moves the specified entry one position up in this list.
void	moveUpToTop(RecordField entry) Moves the specified entry to the top position in this list.
void	remove(RecordField recordField) Removes the given field from this list.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

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

Method Detail

getRecordFieldNames

public java.util.List<java.lang.String> getRecordFieldNames()

Returns a list of record field UIDs contained in this list.

Returns:

collection of String UIDs

getRecordFieldUIDs

public java.util.List<GUID> getRecordFieldUIDs()

Returns a list of record field UIDs contained in this list.

Returns:

list of GUID

Since:

8.0

getRecordFields

public java.util.List<RecordField> getRecordFields()

Returns a list of all record fields known to this list.

Returns:

list of RecordField instances

getRecordField

public RecordField getRecordField(java.lang.String guid)

Returns the record field for the given UID.

Parameters:

guid - the field UID for the field to get

Returns:

the found record field or null if not found

insertSeparator

public RecordField insertSeparator(java.lang.String name,
                          int pos)

Creates a new field grouping separator element at the given position.

Parameters:

name - Name of the separating group

pos - position to insert

Returns:

the created instance

Since:

8.1

insert

public RecordField insert(FieldDefinition fieldDefinition,
                 int pos)

Adds a new field to this list if no field using this fields UID has been added yet. The position specified the position within the list the new field will have after creation.

Parameters:

fieldDefinition - the field definition to create the field for

pos - the position to insert the field

Returns:

the new created field or the found field

insert

public RecordField insert(RecordField field,
                 int pos)

Inserts the given record field at the specified position.

Parameters:

field - the field to insert

pos - the position to insert the field

Returns:

the new added field or the found one

remove

public void remove(RecordField recordField)

Removes the given field from this list.

Parameters:

recordField - the field to remove

moveUp

public void moveUp(RecordField entry)
            throws JPack.NoSuchElementException

Moves the specified entry one position up in this list.

Parameters:

entry - the entry to move

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveUpToTop

public void moveUpToTop(RecordField entry)
                 throws JPack.NoSuchElementException

Moves the specified entry to the top position in this list.

Parameters:

entry - the entry to move

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveDown

public void moveDown(RecordField entry)
              throws JPack.NoSuchElementException

Moves the specified entry one position down in this list.

Parameters:

entry - the entry to move

Throws:

JPack.NoSuchElementException - in case of an invalid entry

moveDownToEnd

public void moveDownToEnd(RecordField entry)
                   throws JPack.NoSuchElementException

Moves the specified entry to the last position in this list.

Parameters:

entry - the entry to move

Throws:

JPack.NoSuchElementException - in case of an invalid entry