RecordFieldOptions (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.RecordFieldOptions

```
public class RecordFieldOptions
extends BaseManager
```
This class stores the general settings of a record view.

See Also:
RecordView.getRecordFieldOptions(), RecordFieldList

Nested Class Summary
- 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`	`FIELD_NAME_ALIGNMENT_LEFT`
`static int`	`FIELD_NAME_ALIGNMENT_RIGHT`
`static int`	`LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD`
`static int`	`LABEL_COLOR_BACKGROUND_MODE_OPTION_RECORD_NAME_IF_AVAILABLE`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages()` Returns whether this view should allow the user to select another language for display for all fields supporting multiple languages.
`int`	`getBackgroundColor()` Returns the RGB value representing the background color in the default sRGB `ColorModel`.
`int`	`getBackgroundColorForAlternateRows()` Returns the RGB value representing the background color in the default sRGB `ColorModel`.
`int`	`getFieldNameAlignment()` Returns the alignment for field names.
`FontDetail`	`getFont()` This returns the font configuration for the field names for the current platform.
`FontDetail`	`getFont2()` This returns the second font configuration for the current platform.
`FontDetail`	`getFont3()` This returns the third font configuration for the current platform.
`FontDetail`	`getFontMac()` This returns the font configuration for the field names for the Mac platform.
`FontDetail`	`getFontMac2()` This returns the second font configuration for the Mac platform.
`FontDetail`	`getFontMac3()` This returns the third font configuration for the Mac platform.
`FontDetail`	`getFontWin()` This returns the font configuration for the field names for the Windows platform.
`FontDetail`	`getFontWin2()` This returns the second font configuration for the Windows platform.
`FontDetail`	`getFontWin3()` This returns the third font configuration for the Windows platform.
`java.lang.String`	`getLabelColorBackgroundField()` Returns the field UID of the label field being used for rendering the background color.
`int`	`getLabelColorBackgroundMode()` Returns the mode which specified how the color of a label field should be used as a background color.
`RecordFieldList`	`getRecordFieldList()` Returns the instance managing settings of individual fields.
`boolean`	`getShowEmbeddedMetadataTags()` Returns whether the thumbnail shown in the report view will be extended with the content of the `GUID.UID_EMBEDDED_METADATA_TAGS` field.
`boolean`	`getShowFieldNames()` Returns whether the field names should be shown.
`boolean`	`getShowFieldValues()` This specifies in case of a record view of type `RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN` whether field values should be shown.
`boolean`	`getShowFrame()` Returns whether a frame should be drawn around the record when rendering a record views of type `RecordView.RECORD_VIEW_TYPE_THUMBNAIL` or `RecordView.RECORD_VIEW_TYPE_PALETTE`.
`boolean`	`getShowReportThumbnail()` Returns whether the report view should show a thumbnail.
`int`	`getSpacing()` Returns the space around the image when rendering a record view of type `RecordView.RECORD_VIEW_TYPE_THUMBNAIL`, `RecordView.RECORD_VIEW_TYPE_DETAILS` and `RecordView.RECORD_VIEW_TYPE_PALETTE`.
`boolean`	`getUseFieldFontsForFieldNames()` Returns whether this view should use the field value font definitions for displaying the field names.
`boolean`	`getUseFieldValuesOverlay()` This specifies in case of a record view of type `RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN` whether field values should be shown below the preview or overlay the preview.
`boolean`	`getUseLabelColorAsBackground()` Returns whether the field value of a label field should be used as a background color.
`boolean`	`getUseSecondColorForAlternateRows()` Returns whether this view should use a different background color for every second row.
`void`	`setAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages(boolean value)` Configures whether this view should allow the user to select another language for display for all fields supporting multiple languages.
`void`	`setBackgroundColor(int color)` Sets the background color as RGB value representing the color.
`void`	`setBackgroundColorForAlternateRows(int color)` Sets the background color as RGB value representing the color.
`void`	`setFieldNameAlignment(int value)` Specifies the alignment for field names.
`void`	`setLabelColorBackgroundField(java.lang.String guid)` Sets the field UID of the label field being used for rendering the background color.
`void`	`setLabelColorBackgroundMode(int mode)` Configures the mode which specified how the color of a label field should be used as a background color.
`void`	`setShowEmbeddedMetadataTags(boolean value)` Specifies whether the thumbnail shown in the report view will be extended with the content of the `GUID.UID_EMBEDDED_METADATA_TAGS` field.
`void`	`setShowFieldNames(boolean value)` Configures whether the field names should be shown.
`void`	`setShowFieldValues(boolean value)` Configures in case of a record view of type `RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN` whether field values should be shown.
`void`	`setShowFrame(boolean value)` Configures whether a frame should be drawn around the record when rendering a record views of type `RecordView.RECORD_VIEW_TYPE_THUMBNAIL` or `RecordView.RECORD_VIEW_TYPE_PALETTE`.
`void`	`setShowReportThumbnail(boolean value)` Specifies whether the report view should show a thumbnail.
`void`	`setSpacing(int value)` Configures the space around the image when rendering a record view of type `RecordView.RECORD_VIEW_TYPE_THUMBNAIL`, `RecordView.RECORD_VIEW_TYPE_DETAILS` and `RecordView.RECORD_VIEW_TYPE_PALETTE`.
`void`	`setUseFieldFontsForFieldNames(boolean value)` Specifies whether this view should use the field value font definitions for displaying the field names.
`void`	`setUseFieldNamesOverlay(boolean value)` Specifies in case of a record view of type `RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN` whether field values should be shown below the preview or overlay the preview.
`void`	`setUseLabelColorAsBackground(boolean value)` Configures whether the field value of a label field should be used as a background color.
`void`	`setUseSecondColorForAlternateRows(boolean value)` Specifies whether this view should use a different background color for every second row.

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
  - LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD
```
public static final int LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD
```
    See Also:
    Constant Field Values
  - LABEL_COLOR_BACKGROUND_MODE_OPTION_RECORD_NAME_IF_AVAILABLE
```
public static final int LABEL_COLOR_BACKGROUND_MODE_OPTION_RECORD_NAME_IF_AVAILABLE
```
    See Also:
    Constant Field Values
  - FIELD_NAME_ALIGNMENT_LEFT
```
public static final int FIELD_NAME_ALIGNMENT_LEFT
```
    See Also:
    Constant Field Values
  - FIELD_NAME_ALIGNMENT_RIGHT
```
public static final int FIELD_NAME_ALIGNMENT_RIGHT
```
    See Also:
    Constant Field Values
- Method Detail
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Returns the RGB value representing the background color in the default sRGB ColorModel. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Returns:
    the RGB value of the color in the default sRGB ColorModel.
  - setBackgroundColor
```
public void setBackgroundColor(int color)
```
    Sets the background color as RGB value representing the color. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Parameters:
    color - the combined RGB components
  - getUseSecondColorForAlternateRows
```
public boolean getUseSecondColorForAlternateRows()
```
    Returns whether this view should use a different background color for every second row.
    
    Returns:
    true if this view should use a different background color for every second row
    Since:
    
    8.0
  - getAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages
```
public boolean getAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages()
```
    Returns whether this view should allow the user to select another language for display for all fields supporting multiple languages.
    
    Returns:
    true if this view should allow the user to select another language for display for all fields supporting multiple languages
    Since:
    
    8.6
  - setAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages
```
public void setAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages(boolean value)
```
    Configures whether this view should allow the user to select another language for display for all fields supporting multiple languages.
    
    Parameters:
    value - true if this view should allow the user to select another language for display for all fields supporting multiple languages, otherwise false
    Since:
    
    8.6
  - getShowEmbeddedMetadataTags
```
public boolean getShowEmbeddedMetadataTags()
```
    Returns whether the thumbnail shown in the report view will be extended with the content of the GUID.UID_EMBEDDED_METADATA_TAGS field.
    
    Returns:
    true if the thumbnail should be extended
    Since:
    
    8.6
  - setShowEmbeddedMetadataTags
```
public void setShowEmbeddedMetadataTags(boolean value)
```
    Specifies whether the thumbnail shown in the report view will 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
  - setUseSecondColorForAlternateRows
```
public void setUseSecondColorForAlternateRows(boolean value)
```
    Specifies whether this view should use a different background color for every second row.
    
    Parameters:
    value - true if this view should use a different background color for every second row
    Since:
    
    8.0
  - getBackgroundColorForAlternateRows
```
public int getBackgroundColorForAlternateRows()
```
    Returns the RGB value representing the background color in the default sRGB ColorModel. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Returns:
    the RGB value of the color in the default sRGB ColorModel.
    Since:
    
    8.0
  - setBackgroundColorForAlternateRows
```
public void setBackgroundColorForAlternateRows(int color)
```
    Sets the background color as RGB value representing the color. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
    
    Parameters:
    color - the combined RGB components
    Since:
    
    8.0
  - getShowReportThumbnail
```
public boolean getShowReportThumbnail()
```
    Returns whether the report view should show a thumbnail.
    
    Returns:
    true if a thumbnail should be shown
    Since:
    
    8.0
  - setShowReportThumbnail
```
public void setShowReportThumbnail(boolean value)
```
    Specifies whether the report view should show a thumbnail.
    
    Parameters:
    value - true if a thumbnail should be shown
    Since:
    
    8.0
  - getUseLabelColorAsBackground
```
public boolean getUseLabelColorAsBackground()
```
    Returns whether the field value of a label field should be used as a background color. The exact meaning of this options depends on the getLabelColorBackgroundMode() setting. This option is only used for record views of type RecordView.RECORD_VIEW_TYPE_THUMBNAIL, RecordView.RECORD_VIEW_TYPE_DETAILS and RecordView.RECORD_VIEW_TYPE_PALETTE.
    
    Returns:
    true if the label color of a specific field should be used as background color
  - setUseLabelColorAsBackground
```
public void setUseLabelColorAsBackground(boolean value)
```
    Configures whether the field value of a label field should be used as a background color. The exact meaning of this options depends on the getLabelColorBackgroundMode() setting. This option is only used for record views of type RecordView.RECORD_VIEW_TYPE_THUMBNAIL, RecordView.RECORD_VIEW_TYPE_DETAILS and RecordView.RECORD_VIEW_TYPE_PALETTE.
    
    Parameters:
    value - set to true if the label color of a specific field should be used as background color
  - getLabelColorBackgroundMode
```
public int getLabelColorBackgroundMode()
```
    Returns the mode which specified how the color of a label field should be used as a background color. The supported modes are LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD and LABEL_COLOR_BACKGROUND_MODE_OPTION_RECORD_NAME_IF_AVAILABLE. Defaults to LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD.
    
    Returns:
    mode which specified how the color of a label field should be used as a background color
  - setLabelColorBackgroundMode
```
public void setLabelColorBackgroundMode(int mode)
```
    Configures the mode which specified how the color of a label field should be used as a background color. The supported modes are LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD and LABEL_COLOR_BACKGROUND_MODE_OPTION_RECORD_NAME_IF_AVAILABLE.
    
    Parameters:
    mode - specifies how the color of a label field should be used as a background color
  - getLabelColorBackgroundField
```
public java.lang.String getLabelColorBackgroundField()
```
    Returns the field UID of the label field being used for rendering the background color.
    
    Returns:
    field UID or null if not configured
  - setLabelColorBackgroundField
```
public void setLabelColorBackgroundField(java.lang.String guid)
```
    Sets the field UID of the label field being used for rendering the background color.
    
    Parameters:
    guid - field UID
  - getSpacing
```
public int getSpacing()
```
    Returns the space around the image when rendering a record view of type RecordView.RECORD_VIEW_TYPE_THUMBNAIL, RecordView.RECORD_VIEW_TYPE_DETAILS and RecordView.RECORD_VIEW_TYPE_PALETTE. Defaults to 0.
    
    Returns:
    space around image
  - setSpacing
```
public void setSpacing(int value)
```
    Configures the space around the image when rendering a record view of type RecordView.RECORD_VIEW_TYPE_THUMBNAIL, RecordView.RECORD_VIEW_TYPE_DETAILS and RecordView.RECORD_VIEW_TYPE_PALETTE.
    
    Parameters:
    value - space around image
  - getShowFrame
```
public boolean getShowFrame()
```
    Returns whether a frame should be drawn around the record when rendering a record views of type RecordView.RECORD_VIEW_TYPE_THUMBNAIL or RecordView.RECORD_VIEW_TYPE_PALETTE.
    
    Returns:
    true if a frame should be drawn around the record
  - setShowFrame
```
public void setShowFrame(boolean value)
```
    Configures whether a frame should be drawn around the record when rendering a record views of type RecordView.RECORD_VIEW_TYPE_THUMBNAIL or RecordView.RECORD_VIEW_TYPE_PALETTE.
    
    Parameters:
    value - true if a frame should be drawn around the record
  - getShowFieldNames
```
public boolean getShowFieldNames()
```
    Returns whether the field names should be shown.
    
    Returns:
    true if the field names should be shown
  - setShowFieldNames
```
public void setShowFieldNames(boolean value)
```
    Configures whether the field names should be shown.
    
    Parameters:
    value - set to true if the field names should be shown
  - getFieldNameAlignment
```
public int getFieldNameAlignment()
```
    Returns the alignment for field names. Currently only evaluated for views of type RecordView.RECORD_VIEW_TYPE_REPORT. The supported alignments are FIELD_NAME_ALIGNMENT_LEFT and FIELD_NAME_ALIGNMENT_RIGHT. Defaults to FIELD_NAME_ALIGNMENT_LEFT.
    
    Returns:
    alignment for field names
    Since:
    
    8.0
  - setFieldNameAlignment
```
public void setFieldNameAlignment(int value)
```
    Specifies the alignment for field names. Currently only evaluated for views of type RecordView.RECORD_VIEW_TYPE_REPORT. The supported alignments are FIELD_NAME_ALIGNMENT_LEFT and FIELD_NAME_ALIGNMENT_RIGHT.
    
    Parameters:
    value - alignment for field names
    Since:
    
    8.0
  - getUseFieldFontsForFieldNames
```
public boolean getUseFieldFontsForFieldNames()
```
    Returns whether this view should use the field value font definitions for displaying the field names.
    
    Returns:
    true if this view should use the field value font definitions for displaying the field names
    Since:
    
    8.0
  - setUseFieldFontsForFieldNames
```
public void setUseFieldFontsForFieldNames(boolean value)
```
    Specifies whether this view should use the field value font definitions for displaying the field names.
    
    Parameters:
    value - true if this view should use the field value font definitions for displaying the field names
    Since:
    
    8.0
  - getShowFieldValues
```
public boolean getShowFieldValues()
```
    This specifies in case of a record view of type RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN whether field values should be shown.
    
    Returns:
    true if field values should be shown
  - setShowFieldValues
```
public void setShowFieldValues(boolean value)
```
    Configures in case of a record view of type RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN whether field values should be shown.
    
    Parameters:
    value - set to true if field values should be shown
  - getUseFieldValuesOverlay
```
public boolean getUseFieldValuesOverlay()
```
    This specifies in case of a record view of type RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN whether field values should be shown below the preview or overlay the preview.
    
    Returns:
    true if field values should be overlay the preview
    Since:
    
    8.0
  - setUseFieldNamesOverlay
```
public void setUseFieldNamesOverlay(boolean value)
```
    Specifies in case of a record view of type RecordView.RECORD_VIEW_TYPE_PREVIEW_WIN whether field values should be shown below the preview or overlay the preview.
    
    Parameters:
    value - true if field values should be overlay the preview
    Since:
    
    8.0
  - getRecordFieldList
```
public RecordFieldList getRecordFieldList()
```
    Returns the instance managing settings of individual fields.
    
    Returns:
    manager for settings of individual fields
  - getFontMac
```
public FontDetail getFontMac()
```
    This returns the font configuration for the field names for the Mac platform.
    
    Returns:
    font configuration for the Mac platform
  - getFontWin
```
public FontDetail getFontWin()
```
    This returns the font configuration for the field names for the Windows platform.
    
    Returns:
    font configuration for the Windows platform
  - getFontMac2
```
public FontDetail getFontMac2()
```
    This returns the second font configuration for the Mac platform.
    
    Returns:
    second font configuration for the Mac platform
    Since:
    
    8.0
  - getFontWin2
```
public FontDetail getFontWin2()
```
    This returns the second font configuration for the Windows platform.
    
    Returns:
    second font configuration for the Windows platform
    Since:
    
    8.0
  - getFontMac3
```
public FontDetail getFontMac3()
```
    This returns the third font configuration for the Mac platform.
    
    Returns:
    third font configuration for the Mac platform
    Since:
    
    8.0
  - getFontWin3
```
public FontDetail getFontWin3()
```
    This returns the third font configuration for the Windows platform.
    
    Returns:
    third font configuration for the Windows platform
    Since:
    
    8.0
  - getFont
```
public FontDetail getFont()
```
    This returns the font configuration for the field names for the current platform.
    
    Returns:
    font configuration for the current platform
  - getFont2
```
public FontDetail getFont2()
```
    This returns the second font configuration for the current platform.
    
    Returns:
    second font configuration for the current platform
    Since:
    
    8.0
  - getFont3
```
public FontDetail getFont3()
```
    This returns the third font configuration for the current platform.
    
    Returns:
    third font configuration for the current platform
    Since:
    
    8.0

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class RecordFieldOptions

Nested Class Summary

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

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LABEL_COLOR_BACKGROUND_MODE_OPTION_ENTIRE_RECORD

LABEL_COLOR_BACKGROUND_MODE_OPTION_RECORD_NAME_IF_AVAILABLE

FIELD_NAME_ALIGNMENT_LEFT

FIELD_NAME_ALIGNMENT_RIGHT

Method Detail

getBackgroundColor

setBackgroundColor

getUseSecondColorForAlternateRows

getAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages

setAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages

getShowEmbeddedMetadataTags

setShowEmbeddedMetadataTags

setUseSecondColorForAlternateRows

getBackgroundColorForAlternateRows

setBackgroundColorForAlternateRows

getShowReportThumbnail

setShowReportThumbnail

getUseLabelColorAsBackground

setUseLabelColorAsBackground

getLabelColorBackgroundMode

setLabelColorBackgroundMode

getLabelColorBackgroundField

setLabelColorBackgroundField

getSpacing

setSpacing

getShowFrame

setShowFrame

getShowFieldNames

setShowFieldNames

getFieldNameAlignment

setFieldNameAlignment

getUseFieldFontsForFieldNames

setUseFieldFontsForFieldNames

getShowFieldValues

setShowFieldValues

getUseFieldValuesOverlay

setUseFieldNamesOverlay

getRecordFieldList

getFontMac

getFontWin

getFontMac2

getFontWin2

getFontMac3

getFontWin3

getFont

getFont2

getFont3