com.canto.cumulus.prefs

Class RecordField

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.RecordField

Direct Known Subclasses:

CategoryField

public class RecordField
extends BaseManager

This class manages the record field settings in a record view.

See Also:

RecordFieldList.getRecordField(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecordField.Visibility

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

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENUM_VIEW_MODE_OPTION_DROPDOWN_MENU
static int	ENUM_VIEW_MODE_OPTION_RADIO_BUTTONS
static int	IMAGE_SIZE_OPTION_LARGE
static int	IMAGE_SIZE_OPTION_MEDIUM
static int	IMAGE_SIZE_OPTION_SMALL

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

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCategoryViewSet() Returns the category view set to use for showing further details.
java.lang.String	getFieldName() Returns this fields display name.
java.lang.String	getFieldName(int languageID) Returns the name for the given language id.
FontDetail	getFont() This returns the font configuration for this field for the current platform.
FontDetail	getFontMac() This returns the font configuration for this field for the Mac platform.
FontDetail	getFontWin() This returns the font configuration for this field for the Windows platform.
int	getImageSize() Returns the wanted default image size for this thumbnail field.
int	getMaximumFractionDigits() Returns the number of fraction digits to use when displaying this field.
int	getPreferredLanguageID() Returns the language ID to use for displaying the content.
int	getPreferredSingleValueEnumView() Returns the mode for rendering this enum field.
boolean	getShowEmbeddedMetadataTags() Returns whether a FieldTypes.FieldTypePicture field will be extended with the content of the GUID.UID_EMBEDDED_METADATA_TAGS field.
boolean	getShowFrame() Returns whether this field should be rendered with a frame.
int	getSpacing() Returns the spacing around this field when being rendered.
int	getTextNumberOfLines() Returns the number of lines to use when rendering this field.
int	getType() Returns the type of this field.
java.lang.String	getUID() Returns this fields UID.
boolean	getUseRegionalSettings() Returns whether a FieldTypes.FieldTypeInteger or FieldTypes.FieldTypeLong field will be displayed by using regional settings or just as a plain number.
int	getValueInterpretation() Returns this fields value interpretation.
java.util.Set<java.lang.Integer>	getVisibilityMatchingEnumIDs() Return the selected enum IDs when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field.
RecordField.Visibility	getVisibilityMode() Return the visibility mode for this field.
java.lang.String	getVisibilityQueryMatchName() Return the query name to use when using the visibility mode RecordField.Visibility.QUERY_MATCH for this field.
java.lang.String	getVisibilityQueryString() Return the query string to use when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field.
boolean	isSeparator() Returns whether this field represents a field or a field grouping separator element.
boolean	isUsePreferredLanguage() Returns whether this field is configured to use a preferred language for displaying the content.
boolean	isVisibleForItem(Item item, java.util.Map<java.lang.String,java.lang.Boolean> visibilityQueryResultCache) Returns whether this field should be shown for the given item according to the visibility rules of this field.
void	setCategoryViewSet(java.lang.String categoryViewSet) Sets the category view set to use for showing further details.
void	setFieldName(int languageID, java.lang.String name) Sets the name for the given language.
void	setImageSize(int value) Configures the wanted default image size for this thumbnail field.
void	setMaximumFractionDigits(int value) Configures the number of fraction digits to use when displaying this field.
void	setPreferredLanguageID(int languageID) Specifies the language ID to use for displaying the content.
void	setPreferredSingleValueEnumView(int view) Configures the mode for rendering this enum field.
void	setShowEmbeddedMetadataTags(boolean value) Specifies whether a FieldTypes.FieldTypePicture field should be extended with the content of the GUID.UID_EMBEDDED_METADATA_TAGS field.
void	setShowFrame(boolean value) Configures whether this field should be rendered with a frame.
void	setSpacing(int value) Sets the spacing around this field when being rendered.
void	setTextNumberOfLine(int value) Configures the number of lines to use when rendering this field.
void	setUsePreferredLanguage(boolean value) Specifies whether this field should configured to use a preferred language for displaying the content.
void	setUseRegionalSettings(boolean value) Specifies whether a FieldTypes.FieldTypeInteger or FieldTypes.FieldTypeLong field will be displayed by using regional settings or just as a plain number.
void	setVisibilityMatchingEnumIDs(java.util.Set<java.lang.Integer> enumIDs) Configures the selected enum IDs when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field.
void	setVisibilityMode(RecordField.Visibility visibility) Configures the visibility mode for this field.
void	setVisibilityQueryMatchName(java.lang.String queryName) Configures the query name to use when using the visibility mode RecordField.Visibility.QUERY_MATCH for this field.
void	setVisibilityQueryString(java.lang.String query) Configures the query string to use when using the visibility mode RecordField.Visibility.QUERY_MATCH or as a fallback for the mode RecordField.Visibility.QUERY_MATCH.

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

Field Detail

ENUM_VIEW_MODE_OPTION_DROPDOWN_MENU

public static final int ENUM_VIEW_MODE_OPTION_DROPDOWN_MENU

See Also:

Constant Field Values

ENUM_VIEW_MODE_OPTION_RADIO_BUTTONS

public static final int ENUM_VIEW_MODE_OPTION_RADIO_BUTTONS

See Also:

Constant Field Values

IMAGE_SIZE_OPTION_SMALL

public static final int IMAGE_SIZE_OPTION_SMALL

See Also:

Constant Field Values

IMAGE_SIZE_OPTION_MEDIUM

public static final int IMAGE_SIZE_OPTION_MEDIUM

See Also:

Constant Field Values

IMAGE_SIZE_OPTION_LARGE

public static final int IMAGE_SIZE_OPTION_LARGE

See Also:

Constant Field Values

Method Detail

getType

public int getType()

Returns the type of this field.

Returns:

type of this field

isSeparator

public boolean isSeparator()

Returns whether this field represents a field or a field grouping separator element.

Returns:

true if this is a field group separator

Since:

8.1

getUID

public java.lang.String getUID()

Returns this fields UID.

Returns:

this fields UID

getValueInterpretation

public int getValueInterpretation()

Returns this fields value interpretation.

Returns:

this fields value interpretation

getFieldName

public java.lang.String getFieldName()

Returns this fields display name.

Returns:

this fields display name

getFieldName

public java.lang.String getFieldName(int languageID)

Returns the name for the given language id.

Parameters:

languageID - specifying the language for the description

Returns:

name for the given language or the default name if no specific name could be found

Since:

8.1

setFieldName

public void setFieldName(int languageID,
                java.lang.String name)

Sets the name for the given language.

Parameters:

languageID - the language to set the name for

name - the new name

Since:

8.1

getSpacing

public int getSpacing()

Returns the spacing around this field when being rendered. Only used for the thumbnail field.

Returns:

spacing around this field when being rendered

setSpacing

public void setSpacing(int value)

Sets the spacing around this field when being rendered. Only used for the thumbnail field.

Parameters:

value - spacing around this field when being rendered

getShowFrame

public boolean getShowFrame()

Returns whether this field should be rendered with a frame. Only used for the thumbnail field.

Returns:

true if this field should be rendered with a frame

setShowFrame

public void setShowFrame(boolean value)

Configures whether this field should be rendered with a frame. Only used for the thumbnail field.

Parameters:

value - set to true if this field should be rendered with a frame

getTextNumberOfLines

public int getTextNumberOfLines()

Returns the number of lines to use when rendering this field. Only used for the fields of type FieldTypes.FieldTypeString and FieldTypes.FieldTypeEnum. Defaults to 1 for FieldTypes.FieldTypeString and 5 for FieldTypes.FieldTypeEnum.

Returns:

number of lines

setTextNumberOfLine

public void setTextNumberOfLine(int value)

Configures the number of lines to use when rendering this field. Only used for the fields of type FieldTypes.FieldTypeString and FieldTypes.FieldTypeEnum.

Parameters:

value - number of lines for this field

getMaximumFractionDigits

public int getMaximumFractionDigits()

Returns the number of fraction digits to use when displaying this field. Only used for the fields of type FieldTypes.FieldTypeDouble. Defaults to 2.

Returns:

number of fraction digits

Since:

9.1

setMaximumFractionDigits

public void setMaximumFractionDigits(int value)

Configures the number of fraction digits to use when displaying this field. Only used for the fields of type FieldTypes.FieldTypeDouble.

Parameters:

value - number of fraction digits for this field

Since:

9.1

getPreferredSingleValueEnumView

public int getPreferredSingleValueEnumView()

Returns the mode for rendering this enum field. Available modes are ENUM_VIEW_MODE_OPTION_DROPDOWN_MENU and ENUM_VIEW_MODE_OPTION_RADIO_BUTTONS. Defaults to ENUM_VIEW_MODE_OPTION_DROPDOWN_MENU.

Returns:

mode for rendering this enum field

setPreferredSingleValueEnumView

public void setPreferredSingleValueEnumView(int view)

Configures the mode for rendering this enum field. Available modes are ENUM_VIEW_MODE_OPTION_DROPDOWN_MENU and ENUM_VIEW_MODE_OPTION_RADIO_BUTTONS.

Parameters:

view - mode for rendering this enum field

getCategoryViewSet

public java.lang.String getCategoryViewSet()

Returns the category view set to use for showing further details.

Returns:

category view set to use for showing further details

setCategoryViewSet

public void setCategoryViewSet(java.lang.String categoryViewSet)

Sets the category view set to use for showing further details.

Parameters:

categoryViewSet - category view set to use for showing further details

getImageSize

public int getImageSize()

Returns the wanted default image size for this thumbnail field. Available sizes are IMAGE_SIZE_OPTION_SMALL, IMAGE_SIZE_OPTION_MEDIUM and IMAGE_SIZE_OPTION_LARGE. Defaults to IMAGE_SIZE_OPTION_SMALL.

Returns:

default image size for this thumbnail field

setImageSize

public void setImageSize(int value)

Configures the wanted default image size for this thumbnail field. Available sizes are IMAGE_SIZE_OPTION_SMALL, IMAGE_SIZE_OPTION_MEDIUM and IMAGE_SIZE_OPTION_LARGE.

Parameters:

value - default image size for this thumbnail field

getFontMac

public FontDetail getFontMac()

This returns the font configuration for this field for the Mac platform.

Returns:

font configuration for the Mac platform

getFontWin

public FontDetail getFontWin()

This returns the font configuration for this field for the Windows platform.

Returns:

font configuration for the Windows platform

getFont

public FontDetail getFont()

This returns the font configuration for this field for the current platform.

Returns:

font configuration for the current platform

isUsePreferredLanguage

public boolean isUsePreferredLanguage()

Returns whether this field is configured to use a preferred language for displaying the content. Currently this is only supported for the GUID.UID_REC_CATEGORIES field.

Returns:

whether this field is configured to use a preferred language for displaying the content

Since:

8.6

setUsePreferredLanguage

public void setUsePreferredLanguage(boolean value)

Specifies whether this field should configured to use a preferred language for displaying the content. Currently this is only supported for the GUID.UID_REC_CATEGORIES field.

Parameters:

value - whether this field is configured to use a preferred language for displaying the content

Since:

8.6

getPreferredLanguageID

public int getPreferredLanguageID()

Returns the language ID to use for displaying the content. Currently this is only supported for the GUID.UID_REC_CATEGORIES field.

Returns:

language ID to use for displaying the content

Since:

8.6

setPreferredLanguageID

public void setPreferredLanguageID(int languageID)

Specifies the language ID to use for displaying the content. Currently this is only supported for the GUID.UID_REC_CATEGORIES field.

Parameters:

languageID - language ID to use for displaying the content

Since:

8.6

getShowEmbeddedMetadataTags

public boolean getShowEmbeddedMetadataTags()

Returns whether a FieldTypes.FieldTypePicture field will be extended with the content of the GUID.UID_EMBEDDED_METADATA_TAGS field.

Returns:

true if the picture should be extended

Since:

8.6

setShowEmbeddedMetadataTags

public void setShowEmbeddedMetadataTags(boolean value)

Specifies whether a FieldTypes.FieldTypePicture field should be extended with the content of the GUID.UID_EMBEDDED_METADATA_TAGS field.

Parameters:

value - true if the picture should be extended

Since:

8.6

getUseRegionalSettings

public boolean getUseRegionalSettings()

Returns whether a FieldTypes.FieldTypeInteger or FieldTypes.FieldTypeLong field will be displayed by using regional settings or just as a plain number.

Returns:

true if regional settings should be respected

Since:

8.6

setUseRegionalSettings

public void setUseRegionalSettings(boolean value)

Specifies whether a FieldTypes.FieldTypeInteger or FieldTypes.FieldTypeLong field will be displayed by using regional settings or just as a plain number.

Parameters:

value - true if regional settings should be respected

Since:

8.6

getVisibilityMode

public RecordField.Visibility getVisibilityMode()

Return the visibility mode for this field.

Returns:

visibility mode for this field

Since:

9.0

setVisibilityMode

public void setVisibilityMode(RecordField.Visibility visibility)

Configures the visibility mode for this field.

Parameters:

visibility - new visibility mode for this field

Since:

9.0

getVisibilityMatchingEnumIDs

public java.util.Set<java.lang.Integer> getVisibilityMatchingEnumIDs()

Return the selected enum IDs when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field.

Returns:

selected enum IDs when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field

Since:

9.0

setVisibilityMatchingEnumIDs

public void setVisibilityMatchingEnumIDs(java.util.Set<java.lang.Integer> enumIDs)

Configures the selected enum IDs when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field.

Parameters:

enumIDs - selected enum IDs when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field

Since:

9.0

getVisibilityQueryMatchName

public java.lang.String getVisibilityQueryMatchName()

Return the query name to use when using the visibility mode RecordField.Visibility.QUERY_MATCH for this field.

Returns:

query name to use when using the visibility mode RecordField.Visibility.QUERY_MATCH for this field or null if not configured

Since:

9.0

setVisibilityQueryMatchName

public void setVisibilityQueryMatchName(java.lang.String queryName)

Configures the query name to use when using the visibility mode RecordField.Visibility.QUERY_MATCH for this field.

Parameters:

queryName - query name to use when using the visibility mode RecordField.Visibility.QUERY_MATCH for this field

Since:

9.0

getVisibilityQueryString

public java.lang.String getVisibilityQueryString()

Return the query string to use when using the visibility mode RecordField.Visibility.STRING_ENUM_MATCH for this field. When this field uses the mode RecordField.Visibility.QUERY_MATCH try to look up the query referenced by getVisibilityQueryMatchName() using Preferences.getRecordQuery(String) first and use this query string only as a fallback in case that query is currently not available.

Returns:

query string or null if not yet configured

Since:

9.0

setVisibilityQueryString

public void setVisibilityQueryString(java.lang.String query)

Configures the query string to use when using the visibility mode RecordField.Visibility.QUERY_MATCH or as a fallback for the mode RecordField.Visibility.QUERY_MATCH.

Parameters:

query - query string

Since:

9.0

isVisibleForItem

public boolean isVisibleForItem(Item item,
                       java.util.Map<java.lang.String,java.lang.Boolean> visibilityQueryResultCache)

Returns whether this field should be shown for the given item according to the visibility rules of this field. For performance optimization you can give a resultCache map to speed up the check for multiple fields on the same item that might evaluate the identical visibility rules.

Parameters:

item - item to check

visibilityQueryResultCache - null or a cache map which is filled by this method based on the given item and should be reused for the next calls to this method on the same item

Returns:

true if this field should be visible

Since:

9.0