CategoryViewSet (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.CategoryViewSetTable
  - - com.canto.cumulus.prefs.CategoryViewSet

All Implemented Interfaces:

Item
```
public class CategoryViewSet
extends CategoryViewSetTable
implements Item
```
This class provides access to all settings of a category view set.

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
`void`	`addAllowedMasterCategoryName(java.lang.String name)` Add a master category name to the list of allowed master categories.
`JPack`	`exportSet()` Exports this set into a `JPack`.
`java.util.Collection<java.lang.String>`	`getAllowedMasterCategoryNames()` Returns a collection of all allowed master category names.
`java.lang.String`	`getAutoSwitchCategoryName()` Returns the name of the master category to switch to after activating this category view set.
`int`	`getBackgroundColor()` Returns the RGB value representing the background color in the default sRGB `ColorModel`.
`CategoryViewSetTableList`	`getCategoryViewSetTableList()` Returns the manager for the list of sub-tables with specific configurations.
`boolean`	`getCountAssignedRecords()` Returns whether the application should display the number of directly assigned records behind each category.
`java.lang.String`	`getDescription(int languageID)` Returns the description for the given language id.
`java.lang.String`	`getDisplayName(int languageID, boolean fallbackToDefaultName)` Returns the display name for the given language id.
`FontDetail`	`getFont()` This returns the font configuration for the category tree for the current platform.
`FontDetail`	`getFontMac()` This returns the font configuration for the category tree for the Mac platform.
`FontDetail`	`getFontWin()` This returns the font configuration for the category tree for the Windows platform.
`java.lang.String`	`getID()` Returns the UID of the item in the items namespace.
`boolean`	`getIsDefault()` Returns whether this category view set is the default set.
`java.lang.String`	`getName()` Returns the name of this category view set.
`int`	`getPreferredLanguageID()` Returns the language ID to use for displaying the category tree.
`RestrictionsList`	`getRestrictionsList()` Returns the list of roles and users that are allowed to view this set.
`boolean`	`getRestrictMasterCategories()` Returns whether the list of shown master categories should only contain the allowed master categories of the catalog.
`boolean`	`getUseAutoSwitchViewMode()` Returns true if the application should switch to a specific master category after activating this category view set.
`boolean`	`isDefault()` Returns whether this item is the default item.
`boolean`	`isSharingRestricted()` Returns whether the set visibility is restricted to a group of users or roles.
`boolean`	`isShowLanguageOfCategory()` Returns whether this category view set is configured to show the used language for the displayed category name.
`boolean`	`isUseCustomOrderedLanguageSpecificSortedTree()` Returns whether this category view set is configured to allow custom ordering and language specific sorting of the category tree.
`boolean`	`isUsePreferredLanguage()` Returns whether this category view set is configured to use a preferred language for displaying the category tree when available.
`void`	`removeAllowedMasterCategoryName(java.lang.String name)` Removes a master category name from the list of allowed master categories.
`void`	`setAutoSwitchCategoryName(java.lang.String value)` Sets the name of the master category to switch to after activating this category view set.
`void`	`setBackgroundColor(int color)` Sets the background color as RGB value representing the color.
`void`	`setCountAssignedRecords(boolean count)` Configures whether the application should display the number of directly assigned records behind each category.
`void`	`setDescription(int languageID, java.lang.String description)` Sets the description for the given language.
`void`	`setDisplayName(int languageID, java.lang.String displayName)` Sets the display name for the given language.
`void`	`setPreferredLanguageID(int languageID)` Specifies the language ID to use for displaying the category tree.
`void`	`setRestrictMasterCategories(boolean value)` Sets whether the list of shown master categories should not contain some master categories of the catalog.
`void`	`setSharingRestricted(boolean value)` Sets whether the set visibility is restricted to a group of users or roles.
`void`	`setShowLanguageOfCategory(boolean value)` Specifies whether this category view set is configured to show the used language for the displayed category name.
`void`	`setUseAutoSwitchViewMode(boolean value)` Configures whether the application should switch to a specific master category after activating this category view set.
`void`	`setUseCustomOrderedLanguageSpecificSortedTree(boolean value)` Specifies whether this category view set should allow custom ordering and language specific sorting of the category tree.
`void`	`setUsePreferredLanguage(boolean value)` Specifies whether this category view set should use a preferred language for displaying the category tree when available.

Methods inherited from class com.canto.cumulus.prefs.CategoryViewSetTable
getAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages, getCategoryFieldList, getTableDisplayName, getTableName, setAllowDynamicLanguageSwitchForFieldsSupportingMultipleLanguages

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
  - getName
```
public java.lang.String getName()
```
    Returns the name of this category view set.
    
    Returns:
    name of this category view set
  - 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
  - getRestrictMasterCategories
```
public boolean getRestrictMasterCategories()
```
    Returns whether the list of shown master categories should only contain the allowed master categories of the catalog.
    
    Returns:
    if true the application shows only the allowed master categories when using this category view set
  - setRestrictMasterCategories
```
public void setRestrictMasterCategories(boolean value)
```
    Sets whether the list of shown master categories should not contain some master categories of the catalog. Use addAllowedMasterCategoryName(String) and removeAllowedMasterCategoryName(String) to set the allowed names.
    
    Parameters:
    value - set to true to make the application show only the allowed master categories
  - getUseAutoSwitchViewMode
```
public boolean getUseAutoSwitchViewMode()
```
    Returns true if the application should switch to a specific master category after activating this category view set.
    
    Returns:
    true if the application should switch to a specific master category
  - setUseAutoSwitchViewMode
```
public void setUseAutoSwitchViewMode(boolean value)
```
    Configures whether the application should switch to a specific master category after activating this category view set.
    
    Parameters:
    value - set to true if the application should switch to a specific master category
  - getAutoSwitchCategoryName
```
public java.lang.String getAutoSwitchCategoryName()
```
    Returns the name of the master category to switch to after activating this category view set. This name is being used when getUseAutoSwitchViewMode() returns true.
    
    Returns:
    the master category name to switch to
  - setAutoSwitchCategoryName
```
public void setAutoSwitchCategoryName(java.lang.String value)
```
    Sets the name of the master category to switch to after activating this category view set. This name is being used when getUseAutoSwitchViewMode() returns true.
    
    Parameters:
    value - the master category name to switch to
  - getFontMac
```
public FontDetail getFontMac()
```
    This returns the font configuration for the category tree for the Mac platform.
    
    Returns:
    font configuration for the Mac platform
  - getFontWin
```
public FontDetail getFontWin()
```
    This returns the font configuration for the category tree for the Windows platform.
    
    Returns:
    font configuration for the Windows platform
  - getFont
```
public FontDetail getFont()
```
    This returns the font configuration for the category tree for the current platform.
    
    Returns:
    font configuration for the current platform
  - getIsDefault
```
public boolean getIsDefault()
```
    Returns whether this category view set is the default set.
    
    Returns:
    true if this is the default set
  - getCountAssignedRecords
```
public boolean getCountAssignedRecords()
```
    Returns whether the application should display the number of directly assigned records behind each category.
    
    Returns:
    true if the application should display the number of directly assigned records
  - setCountAssignedRecords
```
public void setCountAssignedRecords(boolean count)
```
    Configures whether the application should display the number of directly assigned records behind each category.
    
    Parameters:
    count - set to true if the application should display the number of directly assigned records
  - addAllowedMasterCategoryName
```
public void addAllowedMasterCategoryName(java.lang.String name)
```
    Add a master category name to the list of allowed master categories. This list is only used if getRestrictMasterCategories() is true.
    
    Parameters:
    name - add the master category name to the list of allowed master categories
  - removeAllowedMasterCategoryName
```
public void removeAllowedMasterCategoryName(java.lang.String name)
```
    Removes a master category name from the list of allowed master categories. This list is only used if getRestrictMasterCategories() is true.
    
    Parameters:
    name - add the master category name to the list of allowed master categories
  - getAllowedMasterCategoryNames
```
public java.util.Collection<java.lang.String> getAllowedMasterCategoryNames()
```
    Returns a collection of all allowed master category names.
    
    Returns:
    collection of String names
  - getCategoryViewSetTableList
```
public CategoryViewSetTableList getCategoryViewSetTableList()
```
    Returns the manager for the list of sub-tables with specific configurations.
    
    Returns:
    sub tables record view settings manager
    Since:
    
    8.0
  - exportSet
```
public JPack exportSet()
```
    Exports this set into a JPack.
    
    Specified by:
    
    exportSet in interface Item
    
    Returns:
    exported data as JPack
    Since:
    
    8.1
    
    See Also:
    CategoryViewSetList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)
  - getID
```
public java.lang.String getID()
```
    Returns the UID of the item in the items namespace.
    
    Specified by:
    
    getID in interface Item
    
    Returns:
    item UID
  - isDefault
```
public boolean isDefault()
```
    Returns whether this item is the default item.
    
    Specified by:
    
    isDefault in interface Item
    
    Returns:
    true if this is the default item
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the description for the given language id.
    
    Specified by:
    
    getDescription in interface Item
    
    Parameters:
    languageID - specifying the language for the description
    
    Returns:
    description text
    Since:
    
    8.0
  - setDescription
```
public void setDescription(int languageID,
                  java.lang.String description)
```
    Sets the description for the given language.
    
    Specified by:
    
    setDescription in interface Item
    
    Parameters:
    languageID - the language to set the description for
    description - the new description
    Since:
    
    8.0
  - getDisplayName
```
public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)
```
    Returns the display name for the given language id.
    
    Specified by:
    
    getDisplayName in interface Item
    
    Parameters:
    languageID - specifying the language for the display name
    fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null
    
    Returns:
    display name
    Since:
    
    8.5
  - setDisplayName
```
public void setDisplayName(int languageID,
                  java.lang.String displayName)
```
    Sets the display name for the given language.
    
    Specified by:
    
    setDisplayName in interface Item
    
    Parameters:
    languageID - the language to set the display name for
    displayName - the new display name
    Since:
    
    8.5
  - isUseCustomOrderedLanguageSpecificSortedTree
```
public boolean isUseCustomOrderedLanguageSpecificSortedTree()
```
    Returns whether this category view set is configured to allow custom ordering and language specific sorting of the category tree.
    
    Returns:
    whether this category view set is configured to allow custom ordering and language specific sorting of the category tree
    Since:
    
    8.5
  - setUseCustomOrderedLanguageSpecificSortedTree
```
public void setUseCustomOrderedLanguageSpecificSortedTree(boolean value)
```
    Specifies whether this category view set should allow custom ordering and language specific sorting of the category tree.
    
    Parameters:
    value - specifies whether to allow custom ordering and language specific sorting of the category tree
    Since:
    
    8.5
  - isUsePreferredLanguage
```
public boolean isUsePreferredLanguage()
```
    Returns whether this category view set is configured to use a preferred language for displaying the category tree when available.
    
    Returns:
    whether this category view set is configured to use a preferred language for displaying the category tree when available
    Since:
    
    8.5
  - setUsePreferredLanguage
```
public void setUsePreferredLanguage(boolean value)
```
    Specifies whether this category view set should use a preferred language for displaying the category tree when available.
    
    Parameters:
    value - specifies whether to use a preferred language for displaying the category tree when available
    Since:
    
    8.5
  - isShowLanguageOfCategory
```
public boolean isShowLanguageOfCategory()
```
    Returns whether this category view set is configured to show the used language for the displayed category name.
    
    Returns:
    whether this category view set is configured to show the used language for the displayed category name
    Since:
    
    8.5
  - setShowLanguageOfCategory
```
public void setShowLanguageOfCategory(boolean value)
```
    Specifies whether this category view set is configured to show the used language for the displayed category name.
    
    Parameters:
    value - specifies whether this category view set is configured to show the used language for the displayed category name
    Since:
    
    8.5
  - getPreferredLanguageID
```
public int getPreferredLanguageID()
```
    Returns the language ID to use for displaying the category tree.
    
    Returns:
    language ID to use for displaying the category tree
    Since:
    
    8.5
  - setPreferredLanguageID
```
public void setPreferredLanguageID(int languageID)
```
    Specifies the language ID to use for displaying the category tree.
    
    Parameters:
    languageID - language ID to use for displaying the category tree
    Since:
    
    8.5
  - isSharingRestricted
```
public boolean isSharingRestricted()
```
    Returns whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    isSharingRestricted in interface Item
    
    Returns:
    true if the set visibility is restricted to a group of users or roles
    Since:
    
    8.6
  - setSharingRestricted
```
public void setSharingRestricted(boolean value)
```
    Sets whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    setSharingRestricted in interface Item
    
    Parameters:
    value - set to true if the set visibility should be restricted to a group of users or roles
    Since:
    
    8.6
  - getRestrictionsList
```
public RestrictionsList getRestrictionsList()
```
    Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.
    
    Specified by:
    
    getRestrictionsList in interface Item
    
    Returns:
    list of roles and users that are allowed to view this set
    Since:
    
    8.6

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 CategoryViewSet

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.CategoryViewSetTable

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

Methods inherited from class java.lang.Object

Method Detail

getName

getBackgroundColor

setBackgroundColor

getRestrictMasterCategories

setRestrictMasterCategories

getUseAutoSwitchViewMode

setUseAutoSwitchViewMode

getAutoSwitchCategoryName

setAutoSwitchCategoryName

getFontMac

getFontWin

getFont

getIsDefault

getCountAssignedRecords

setCountAssignedRecords

addAllowedMasterCategoryName

removeAllowedMasterCategoryName

getAllowedMasterCategoryNames

getCategoryViewSetTableList

exportSet

getID

isDefault

getDescription

setDescription

getDisplayName

setDisplayName

isUseCustomOrderedLanguageSpecificSortedTree

setUseCustomOrderedLanguageSpecificSortedTree

isUsePreferredLanguage

setUsePreferredLanguage

isShowLanguageOfCategory

setShowLanguageOfCategory

getPreferredLanguageID

setPreferredLanguageID

isSharingRestricted

setSharingRestricted

getRestrictionsList