com.canto.cumulus.prefs

Class CategoryFieldList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.CategoryFieldList

public class CategoryFieldList
extends ListPackManager

This class manages a list of category fields.

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
CategoryField	getCategoryField(java.lang.String guid) Returns the category field for the given UID.
java.util.List<java.lang.String>	getCategoryFieldNames() Returns a list of category field UIDs contained in this list.
java.util.List<CategoryField>	getCategoryFields() Returns a list of all category fields known to this list.
java.util.List<GUID>	getCategoryFieldUIDs() Returns a list of category field UIDs contained in this list.
CategoryField	insert(FieldDefinition fieldDefinition, int pos) Adds a new field to this list if no field using this fields UID has been added yet.
CategoryField	insertSeparator(java.lang.String name, int pos) Creates a new field grouping separator element at the given position.
void	moveDown(CategoryField entry) Moves the specified entry one position down in this list.
void	moveDownToEnd(CategoryField entry) Moves the specified entry to the last position in this list.
void	moveUp(CategoryField entry) Moves the specified entry one position up in this list.
void	moveUpToTop(CategoryField entry) Moves the specified entry to the top position in this list.
void	remove(CategoryField categoryField) 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

getCategoryFieldNames

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

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

Returns:

collection of String UIDs

getCategoryFieldUIDs

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

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

Returns:

list of GUID

Since:

8.0

getCategoryFields

public java.util.List<CategoryField> getCategoryFields()

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

Returns:

list of CategoryField instances

getCategoryField

public CategoryField getCategoryField(java.lang.String guid)

Returns the category field for the given UID.

Parameters:

guid - the field UID for the field to get

Returns:

the found field or null if not found

insertSeparator

public CategoryField 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 CategoryField 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

remove

public void remove(CategoryField categoryField)

Removes the given field from this list.

Parameters:

categoryField - the field to remove

moveUp

public void moveUp(CategoryField 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(CategoryField 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(CategoryField 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(CategoryField 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