UserPreferences (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.model.UserPreferences

Direct Known Subclasses:

AppletUserPreferences, DefaultUserPreferences, FileUserPreferences
```
public abstract class UserPreferences
extends java.lang.Object
```
User preferences.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UserPreferences.Property
The properties of user preferences that may change.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserPreferences.Property` The properties of user preferences that may change.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FURNITURE_LIBRARY_TYPE`
`static java.lang.String`	`LANGUAGE_LIBRARY_TYPE`
`static java.lang.String`	`TEXTURES_LIBRARY_TYPE`

Constructor Summary

Constructors
Constructor and Description

UserPreferences()
Creates user preferences.

Constructors
Constructor and Description
`UserPreferences()` Creates user preferences.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAutoCompletionString(java.lang.String property, java.lang.String autoCompletionString)` Adds the given string to the list of the strings used in auto completion of a `property` and notifies listeners of this change.
`abstract void`	`addFurnitureLibrary(java.lang.String furnitureLibraryLocation)` Adds `furnitureLibraryName` to furniture catalog to make the furniture it contains available.
`abstract void`	`addLanguageLibrary(java.lang.String languageLibraryLocation)` Adds the language library to make the languages it contains available to supported languages.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds the property change `listener` in parameter to these preferences.
`void`	`addPropertyChangeListener(UserPreferences.Property property, java.beans.PropertyChangeListener listener)` Adds the `listener` in parameter to these preferences to listen to the changes of the given `property`.
`abstract void`	`addTexturesLibrary(java.lang.String texturesLibraryLocation)` Adds the textures library at the given location to textures catalog to make the textures it contains available.
`abstract boolean`	`furnitureLibraryExists(java.lang.String furnitureLibraryLocation)` Returns `true` if the furniture library at the given location exists.
`java.util.List<java.lang.String>`	`getAutoCompletedProperties()` Returns the list of properties with auto completion strings.
`java.util.List<java.lang.String>`	`getAutoCompletionStrings(java.lang.String property)` Returns the strings that may be used for the auto completion of the given `property`.
`int`	`getAutoSaveDelayForRecovery()` Returns the delay between two automatic save operations of homes for recovery purpose.
`java.lang.String`	`getCurrency()` Returns the currency in use, noted with ISO 4217 code, or `null` if prices aren't used in application.
`java.lang.String`	`getDefaultFontName()` Returns the name of the font that should be used by default or `null` if the default font should be the default one in the application.
`java.lang.String[]`	`getDefaultSupportedLanguages()` Returns the array of default available languages in Sweet Home 3D.
`TextStyle`	`getDefaultTextStyle(java.lang.Class<? extends Selectable> selectableClass)` Returns the default text style of a class of selectable item.
`java.math.BigDecimal`	`getDefaultValueAddedTaxPercentage()` Returns the Value Added Tax percentage applied to prices by default, or `null` if VAT isn't taken into account in the application.
`FurnitureCatalog`	`getFurnitureCatalog()` Returns the furniture catalog.
`int`	`getFurnitureModelIconSize()` Returns the size used to generate icons of furniture viewed from top.
`java.util.List<HomeDescriptor>`	`getHomeExamples()` Returns the home examples available for the user.
`java.lang.String`	`getLanguage()` Returns the preferred language to display information, noted with an ISO 639 code that may be followed by an underscore and an ISO 3166 code.
`LengthUnit`	`getLengthUnit()` Returns the length unit currently in use.
`abstract java.util.List<Library>`	`getLibraries()` Returns the libraries available in user preferences.
`java.lang.String`	`getLocalizedString(java.lang.Class<?> resourceClass, java.lang.String resourceKey, java.lang.Object... resourceParameters)` Returns the string matching `resourceKey` in current language in the context of `resourceClass`.
`java.lang.String`	`getLocalizedString(java.lang.String resourceFamily, java.lang.String resourceKey, java.lang.Object... resourceParameters)` Returns the string matching `resourceKey` in current language for the given resource family.
`java.util.Iterator<java.lang.String>`	`getLocalizedStringKeys(java.lang.String resourceFamily)` Returns the keys of the localized property strings of the given resource family.
`float`	`getNewFloorThickness()` Returns default thickness of the floor of new levels in home.
`java.lang.Integer`	`getNewRoomFloorColor()` Returns the default color of new rooms in home.
`float`	`getNewWallBaseboardHeight()` Returns default baseboard height of new home walls.
`float`	`getNewWallBaseboardThickness()` Returns default baseboard thickness of new walls in home.
`float`	`getNewWallHeight()` Returns default wall height of new home walls.
`TextureImage`	`getNewWallPattern()` Returns the pattern used for new walls in plan or `null` if it's not set.
`float`	`getNewWallThickness()` Returns default thickness of new walls in home.
`PatternsCatalog`	`getPatternsCatalog()` Returns the patterns catalog available to fill plan areas.
`java.lang.String`	`getPhotoRenderer()` Returns the preferred rendering engine used to create photos.
`java.util.List<java.lang.Integer>`	`getRecentColors()` Returns an unmodifiable list of the recent colors.
`java.util.List<java.lang.String>`	`getRecentHomes()` Returns an unmodifiable list of the recent homes.
`int`	`getRecentHomesMaxCount()` Returns the maximum count of homes that should be proposed to the user.
`java.util.List<TextureImage>`	`getRecentTextures()` Returns an unmodifiable list of the recent textures.
`java.util.List<java.lang.ClassLoader>`	`getResourceClassLoaders()` Returns the class loaders through which localized strings returned by `getLocalizedString` might be loaded.
`int`	`getStoredCamerasMaxCount()` Returns the maximum count of stored cameras in homes that should be proposed to the user.
`java.lang.String[]`	`getSupportedLanguages()` Returns the array of available languages in Sweet Home 3D including languages in libraries.
`TexturesCatalog`	`getTexturesCatalog()` Returns the textures catalog.
`java.lang.Long`	`getUpdatesMinimumDate()` Returns the minimum date of updates that may interest user.
`TextureImage`	`getWallPattern()` Returns the wall pattern in plan used by default.
`boolean`	`isActionTipIgnored(java.lang.String actionKey)` Returns whether an action tip should be ignored or not.
`boolean`	`isAerialViewCenteredOnSelectionEnabled()` Returns whether aerial view should be centered on selection or not.
`boolean`	`isCheckUpdatesEnabled()` Returns `true` if updates should be checked.
`boolean`	`isDrawingModeEnabled()` Returns `true` is `drawing mode` should be taken into account.
`boolean`	`isEditingIn3DViewEnabled()` Returns whether interactive editing in 3D view is enabled or not.
`boolean`	`isFurnitureCatalogViewedInTree()` Returns `true` if the furniture catalog should be viewed in a tree.
`boolean`	`isFurnitureViewedFromTop()` Returns `true` if furniture should be viewed from its top in plan.
`boolean`	`isGridVisible()` Returns `true` if plan grid visible.
`boolean`	`isLanguageEditable()` Returns `true` if the language in preferences can be set.
`boolean`	`isMagnetismEnabled()` Returns `true` if magnetism is enabled.
`boolean`	`isNavigationPanelVisible()` Returns `true` if the navigation panel should be displayed.
`boolean`	`isObserverCameraSelectedAtChange()` Returns whether the observer camera should be selected at each change.
`boolean`	`isRoomFloorColoredOrTextured()` Returns `true` if room floors should be rendered with color or texture in plan.
`boolean`	`isRulersVisible()` Returns `true` if rulers are visible.
`boolean`	`isValueAddedTaxEnabled()` Returns `true` if Value Added Tax should be taken in account in prices.
`abstract boolean`	`languageLibraryExists(java.lang.String languageLibraryLocation)` Returns `true` if the language library at the given location exists.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Removes the property change `listener` in parameter from these preferences.
`void`	`removePropertyChangeListener(UserPreferences.Property property, java.beans.PropertyChangeListener listener)` Removes the `listener` in parameter from these preferences.
`void`	`resetIgnoredActionTips()` Resets the ignore flag of action tips.
`void`	`setActionTipIgnored(java.lang.String actionKey)` Sets which action tip should be ignored.
`void`	`setAerialViewCenteredOnSelectionEnabled(boolean aerialViewCenteredOnSelectionEnabled)` Sets whether aerial view should be centered on selection or not.
`void`	`setAutoCompletionStrings(java.lang.String property, java.util.List<java.lang.String> autoCompletionStrings)` Sets the auto completion strings list of the given `property` and notifies listeners of this change.
`void`	`setAutoSaveDelayForRecovery(int autoSaveDelayForRecovery)` Sets the delay between two automatic save operations of homes for recovery purpose.
`void`	`setCheckUpdatesEnabled(boolean updatesChecked)` Sets whether updates should be checked or not.
`void`	`setCurrency(java.lang.String currency)` Sets the currency in use.
`void`	`setDefaultFontName(java.lang.String defaultFontName)` Sets the name of the font that should be used by default.
`void`	`setDefaultValueAddedTaxPercentage(java.math.BigDecimal valueAddedTaxPercentage)` Sets the Value Added Tax percentage applied to prices by default.
`void`	`setEditingIn3DViewEnabled(boolean editingIn3DViewEnabled)` Sets whether interactive editing in 3D view is enabled or not.
`void`	`setFloorColoredOrTextured(boolean roomFloorColoredOrTextured)` Sets whether room floors should be rendered with color or texture, and notifies listeners of this change.
`protected void`	`setFurnitureCatalog(FurnitureCatalog catalog)` Sets furniture catalog.
`void`	`setFurnitureCatalogViewedInTree(boolean furnitureCatalogViewedInTree)` Sets whether the furniture catalog should be viewed in a tree or a different way.
`void`	`setFurnitureModelIconSize(int furnitureModelIconSize)` Sets the name of the font that should be used by default.
`void`	`setFurnitureViewedFromTop(boolean furnitureViewedFromTop)` Sets how furniture icon should be displayed in plan, and notifies listeners of this change.
`void`	`setGridVisible(boolean gridVisible)` Sets whether plan grid is visible or not, and notifies listeners of this change.
`protected void`	`setHomeExamples(java.util.List<HomeDescriptor> homeExamples)` Sets the home examples available for the user.
`void`	`setLanguage(java.lang.String language)` If language can be changed, sets the preferred language to display information, changes current default locale accordingly and notifies listeners of this change.
`void`	`setMagnetismEnabled(boolean magnetismEnabled)` Sets whether magnetism is enabled or not, and notifies listeners of this change.
`void`	`setNavigationPanelVisible(boolean navigationPanelVisible)` Sets whether the navigation panel should be displayed or not.
`void`	`setNewFloorThickness(float newFloorThickness)` Sets default thickness of the floor of new levels in home, and notifies listeners of this change.
`void`	`setNewRoomFloorColor(java.lang.Integer newRoomFloorColor)` Sets the default color of new rooms in home, and notifies listeners of this change.
`void`	`setNewWallBaseboardHeight(float newWallBaseboardHeight)` Sets default baseboard height of new walls, and notifies listeners of this change.
`void`	`setNewWallBaseboardThickness(float newWallBaseboardThickness)` Sets default baseboard thickness of new walls in home, and notifies listeners of this change.
`void`	`setNewWallHeight(float newWallHeight)` Sets default wall height of new walls, and notifies listeners of this change.
`void`	`setNewWallPattern(TextureImage newWallPattern)` Sets how new walls should be displayed in plan, and notifies listeners of this change.
`void`	`setNewWallThickness(float newWallThickness)` Sets default thickness of new walls in home, and notifies listeners of this change.
`void`	`setObserverCameraSelectedAtChange(boolean observerCameraSelectedAtChange)` Sets whether the observer camera should be selected at each change.
`protected void`	`setPatternsCatalog(PatternsCatalog catalog)` Sets the patterns available to fill plan areas.
`void`	`setPhotoRenderer(java.lang.String photoRenderer)` Sets the preferred rendering engine used to create photos.
`void`	`setRecentColors(java.util.List<java.lang.Integer> recentColors)` Sets the recent colors list and notifies listeners of this change.
`void`	`setRecentHomes(java.util.List<java.lang.String> recentHomes)` Sets the recent homes list and notifies listeners of this change.
`void`	`setRecentTextures(java.util.List<TextureImage> recentTextures)` Sets the recent colors list and notifies listeners of this change.
`void`	`setRulersVisible(boolean rulersVisible)` Sets whether rulers are visible or not, and notifies listeners of this change.
`protected void`	`setSupportedLanguages(java.lang.String[] supportedLanguages)` Sets the available languages in Sweet Home 3D.
`protected void`	`setTexturesCatalog(TexturesCatalog catalog)` Sets textures catalog.
`void`	`setUnit(LengthUnit unit)` Changes the unit currently in use, and notifies listeners of this change.
`void`	`setUpdatesMinimumDate(java.lang.Long updatesMinimumDate)` Sets the minimum date of updates that may interest user, and notifies listeners of this change.
`void`	`setValueAddedTaxEnabled(boolean valueAddedTaxEnabled)` Sets whether Value Added Tax should be taken in account in prices.
`void`	`setWallPattern(TextureImage wallPattern)` Sets how walls should be displayed in plan by default, and notifies listeners of this change.
`abstract boolean`	`texturesLibraryExists(java.lang.String texturesLibraryLocation)` Returns `true` if the textures library at the given location exists.
`abstract void`	`write()` Writes user preferences.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FURNITURE_LIBRARY_TYPE
```
public static final java.lang.String FURNITURE_LIBRARY_TYPE
```
    See Also:
    
    Constant Field Values
  - TEXTURES_LIBRARY_TYPE
```
public static final java.lang.String TEXTURES_LIBRARY_TYPE
```
    See Also:
    
    Constant Field Values
  - LANGUAGE_LIBRARY_TYPE
```
public static final java.lang.String LANGUAGE_LIBRARY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserPreferences
```
public UserPreferences()
```
    Creates user preferences.
    Caution: during creation, the default locale will be updated if it doesn't belong to the supported ones.
- Method Detail
  - write
```
public abstract void write()
                    throws RecorderException
```
    Writes user preferences.
    
    Throws:
    
    RecorderException - if user preferences couldn'y be saved.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Adds the property change listener in parameter to these preferences.
    Caution: a user preferences instance generally exists during all the application ; therefore you should take care of not bounding permanently listeners to this object (for example, do not create anonymous listeners on user preferences in classes depending on an edited home).
    
    Since:
    
    6.4
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Removes the property change listener in parameter from these preferences.
    
    Since:
    
    6.4
  - addPropertyChangeListener
```
public void addPropertyChangeListener(UserPreferences.Property property,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the listener in parameter to these preferences to listen to the changes of the given property.
    Caution: a user preferences instance generally exists during all the application ; therefore you should take care of not bounding permanently listeners to this object (for example, do not create anonymous listeners on user preferences in classes depending on an edited home).
  - removePropertyChangeListener
```
public void removePropertyChangeListener(UserPreferences.Property property,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the listener in parameter from these preferences.
  - getFurnitureCatalog
```
public FurnitureCatalog getFurnitureCatalog()
```
    Returns the furniture catalog.
  - setFurnitureCatalog
```
protected void setFurnitureCatalog(FurnitureCatalog catalog)
```
    Sets furniture catalog.
  - getTexturesCatalog
```
public TexturesCatalog getTexturesCatalog()
```
    Returns the textures catalog.
  - setTexturesCatalog
```
protected void setTexturesCatalog(TexturesCatalog catalog)
```
    Sets textures catalog.
  - getPatternsCatalog
```
public PatternsCatalog getPatternsCatalog()
```
    Returns the patterns catalog available to fill plan areas.
  - setPatternsCatalog
```
protected void setPatternsCatalog(PatternsCatalog catalog)
```
    Sets the patterns available to fill plan areas.
  - getLengthUnit
```
public LengthUnit getLengthUnit()
```
    Returns the length unit currently in use.
  - setUnit
```
public void setUnit(LengthUnit unit)
```
    Changes the unit currently in use, and notifies listeners of this change.
    
    Parameters:
    
    unit - one of the values of Unit.
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns the preferred language to display information, noted with an ISO 639 code that may be followed by an underscore and an ISO 3166 code.
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
    If language can be changed, sets the preferred language to display information, changes current default locale accordingly and notifies listeners of this change.
    
    Parameters:
    
    language - an ISO 639 code that may be followed by an underscore and an ISO 3166 code (for example fr, de, it, en_US, zh_CN).
  - isLanguageEditable
```
public boolean isLanguageEditable()
```
    Returns true if the language in preferences can be set.
    
    Returns:
    
    true except if user.language System property isn't writable.
    
    Since:
    
    3.4
  - getDefaultSupportedLanguages
```
public java.lang.String[] getDefaultSupportedLanguages()
```
    Returns the array of default available languages in Sweet Home 3D.
  - getSupportedLanguages
```
public java.lang.String[] getSupportedLanguages()
```
    Returns the array of available languages in Sweet Home 3D including languages in libraries.
    
    Since:
    
    3.4
  - setSupportedLanguages
```
protected void setSupportedLanguages(java.lang.String[] supportedLanguages)
```
    Sets the available languages in Sweet Home 3D.
    
    Since:
    
    3.4
  - getLocalizedString
```
public java.lang.String getLocalizedString(java.lang.Class<?> resourceClass,
                                           java.lang.String resourceKey,
                                           java.lang.Object... resourceParameters)
```
    Returns the string matching resourceKey in current language in the context of resourceClass. If resourceParameters isn't empty the string is considered as a format string, and the returned string will be formatted with these parameters. This implementation searches first the key in a properties file named as resourceClass, then if this file doesn't exist, it searches the key prefixed by resourceClass name and a dot in a package.properties file in the folder matching the package of resourceClass.
    
    Throws:
    
    java.lang.IllegalArgumentException - if no string for the given key can be found
  - getLocalizedString
```
public java.lang.String getLocalizedString(java.lang.String resourceFamily,
                                           java.lang.String resourceKey,
                                           java.lang.Object... resourceParameters)
```
    Returns the string matching resourceKey in current language for the given resource family. resourceFamily should match the absolute path of a .properties resource family, shouldn't start by a slash and may contain dots '.' or slash '/' as folder separators. If resourceParameters isn't empty the string is considered as a format string, and the returned string will be formatted with these parameters. This implementation searches the key in a properties file named as resourceFamily.
    
    Throws:
    
    java.lang.IllegalArgumentException - if no string for the given key can be found
    
    Since:
    
    2.3
  - getLocalizedStringKeys
```
public java.util.Iterator<java.lang.String> getLocalizedStringKeys(java.lang.String resourceFamily)
```
    Returns the keys of the localized property strings of the given resource family. resourceFamily should match the absolute path of a .properties resource family, shouldn't start by a slash and may contain dots '.' or slash '/' as folder separators.
    
    Since:
    
    5.7
  - getResourceClassLoaders
```
public java.util.List<java.lang.ClassLoader> getResourceClassLoaders()
```
    Returns the class loaders through which localized strings returned by getLocalizedString might be loaded.
    
    Since:
    
    2.3
  - getCurrency
```
public java.lang.String getCurrency()
```
    Returns the currency in use, noted with ISO 4217 code, or null if prices aren't used in application.
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Sets the currency in use.
  - isValueAddedTaxEnabled
```
public boolean isValueAddedTaxEnabled()
```
    Returns true if Value Added Tax should be taken in account in prices.
    
    Since:
    
    6.0
  - setValueAddedTaxEnabled
```
public void setValueAddedTaxEnabled(boolean valueAddedTaxEnabled)
```
    Sets whether Value Added Tax should be taken in account in prices.
    
    Parameters:
    
    valueAddedTaxEnabled - if true VAT will be added to prices.
    
    Since:
    
    6.0
  - getDefaultValueAddedTaxPercentage
```
public java.math.BigDecimal getDefaultValueAddedTaxPercentage()
```
    Returns the Value Added Tax percentage applied to prices by default, or null if VAT isn't taken into account in the application.
    
    Since:
    
    6.0
  - setDefaultValueAddedTaxPercentage
```
public void setDefaultValueAddedTaxPercentage(java.math.BigDecimal valueAddedTaxPercentage)
```
    Sets the Value Added Tax percentage applied to prices by default.
    
    Parameters:
    
    valueAddedTaxPercentage - the default VAT percentage
    
    Since:
    
    6.0
  - isFurnitureCatalogViewedInTree
```
public boolean isFurnitureCatalogViewedInTree()
```
    Returns true if the furniture catalog should be viewed in a tree.
    
    Since:
    
    2.3
  - setFurnitureCatalogViewedInTree
```
public void setFurnitureCatalogViewedInTree(boolean furnitureCatalogViewedInTree)
```
    Sets whether the furniture catalog should be viewed in a tree or a different way.
    
    Since:
    
    2.3
  - isNavigationPanelVisible
```
public boolean isNavigationPanelVisible()
```
    Returns true if the navigation panel should be displayed.
    
    Since:
    
    2.3
  - setNavigationPanelVisible
```
public void setNavigationPanelVisible(boolean navigationPanelVisible)
```
    Sets whether the navigation panel should be displayed or not.
    
    Since:
    
    2.3
  - isEditingIn3DViewEnabled
```
public boolean isEditingIn3DViewEnabled()
```
    Returns whether interactive editing in 3D view is enabled or not.
    
    Since:
    
    7.2
  - setEditingIn3DViewEnabled
```
public void setEditingIn3DViewEnabled(boolean editingIn3DViewEnabled)
```
    Sets whether interactive editing in 3D view is enabled or not.
    
    Since:
    
    7.2
  - isAerialViewCenteredOnSelectionEnabled
```
public boolean isAerialViewCenteredOnSelectionEnabled()
```
    Returns whether aerial view should be centered on selection or not.
    
    Since:
    
    4.0
  - setAerialViewCenteredOnSelectionEnabled
```
public void setAerialViewCenteredOnSelectionEnabled(boolean aerialViewCenteredOnSelectionEnabled)
```
    Sets whether aerial view should be centered on selection or not.
    
    Since:
    
    4.0
  - isObserverCameraSelectedAtChange
```
public boolean isObserverCameraSelectedAtChange()
```
    Returns whether the observer camera should be selected at each change.
    
    Since:
    
    5.5
  - setObserverCameraSelectedAtChange
```
public void setObserverCameraSelectedAtChange(boolean observerCameraSelectedAtChange)
```
    Sets whether the observer camera should be selected at each change.
    
    Since:
    
    5.5
  - isMagnetismEnabled
```
public boolean isMagnetismEnabled()
```
    Returns true if magnetism is enabled.
    
    Returns:
    
    true by default.
  - setMagnetismEnabled
```
public void setMagnetismEnabled(boolean magnetismEnabled)
```
    Sets whether magnetism is enabled or not, and notifies listeners of this change.
    
    Parameters:
    
    magnetismEnabled - true if magnetism is enabled, false otherwise.
  - isRulersVisible
```
public boolean isRulersVisible()
```
    Returns true if rulers are visible.
    
    Returns:
    
    true by default.
  - setRulersVisible
```
public void setRulersVisible(boolean rulersVisible)
```
    Sets whether rulers are visible or not, and notifies listeners of this change.
    
    Parameters:
    
    rulersVisible - true if rulers are visible, false otherwise.
  - isGridVisible
```
public boolean isGridVisible()
```
    Returns true if plan grid visible.
    
    Returns:
    
    true by default.
  - setGridVisible
```
public void setGridVisible(boolean gridVisible)
```
    Sets whether plan grid is visible or not, and notifies listeners of this change.
    
    Parameters:
    
    gridVisible - true if grid is visible, false otherwise.
  - isDrawingModeEnabled
```
public boolean isDrawingModeEnabled()
```
    Returns true is drawing mode should be taken into account.
    
    Since:
    
    6.0
  - getDefaultFontName
```
public java.lang.String getDefaultFontName()
```
    Returns the name of the font that should be used by default or null if the default font should be the default one in the application.
    
    Since:
    
    5.0
  - setDefaultFontName
```
public void setDefaultFontName(java.lang.String defaultFontName)
```
    Sets the name of the font that should be used by default.
    
    Since:
    
    5.0
  - isFurnitureViewedFromTop
```
public boolean isFurnitureViewedFromTop()
```
    Returns true if furniture should be viewed from its top in plan.
    
    Since:
    
    2.0
  - setFurnitureViewedFromTop
```
public void setFurnitureViewedFromTop(boolean furnitureViewedFromTop)
```
    Sets how furniture icon should be displayed in plan, and notifies listeners of this change.
    
    Parameters:
    
    furnitureViewedFromTop - if true the furniture should be viewed from its top.
    
    Since:
    
    2.0
  - getFurnitureModelIconSize
```
public int getFurnitureModelIconSize()
```
    Returns the size used to generate icons of furniture viewed from top.
    
    Since:
    
    5.5
  - setFurnitureModelIconSize
```
public void setFurnitureModelIconSize(int furnitureModelIconSize)
```
    Sets the name of the font that should be used by default.
    
    Since:
    
    5.5
  - isRoomFloorColoredOrTextured
```
public boolean isRoomFloorColoredOrTextured()
```
    Returns true if room floors should be rendered with color or texture in plan.
    
    Returns:
    
    false by default.
    
    Since:
    
    2.0
  - setFloorColoredOrTextured
```
public void setFloorColoredOrTextured(boolean roomFloorColoredOrTextured)
```
    Sets whether room floors should be rendered with color or texture, and notifies listeners of this change.
    
    Parameters:
    
    roomFloorColoredOrTextured - true if floor color or texture is used, false otherwise.
    
    Since:
    
    2.0
  - getWallPattern
```
public TextureImage getWallPattern()
```
    Returns the wall pattern in plan used by default.
    
    Since:
    
    2.0
  - setWallPattern
```
public void setWallPattern(TextureImage wallPattern)
```
    Sets how walls should be displayed in plan by default, and notifies listeners of this change.
    
    Since:
    
    2.0
  - getNewWallPattern
```
public TextureImage getNewWallPattern()
```
    Returns the pattern used for new walls in plan or null if it's not set.
    
    Since:
    
    4.0
  - setNewWallPattern
```
public void setNewWallPattern(TextureImage newWallPattern)
```
    Sets how new walls should be displayed in plan, and notifies listeners of this change.
    
    Since:
    
    4.0
  - getNewWallThickness
```
public float getNewWallThickness()
```
    Returns default thickness of new walls in home.
  - setNewWallThickness
```
public void setNewWallThickness(float newWallThickness)
```
    Sets default thickness of new walls in home, and notifies listeners of this change.
  - getNewWallHeight
```
public float getNewWallHeight()
```
    Returns default wall height of new home walls.
  - setNewWallHeight
```
public void setNewWallHeight(float newWallHeight)
```
    Sets default wall height of new walls, and notifies listeners of this change.
  - getNewWallBaseboardThickness
```
public float getNewWallBaseboardThickness()
```
    Returns default baseboard thickness of new walls in home.
    
    Since:
    
    5.0
  - setNewWallBaseboardThickness
```
public void setNewWallBaseboardThickness(float newWallBaseboardThickness)
```
    Sets default baseboard thickness of new walls in home, and notifies listeners of this change.
    
    Since:
    
    5.0
  - getNewWallBaseboardHeight
```
public float getNewWallBaseboardHeight()
```
    Returns default baseboard height of new home walls.
    
    Since:
    
    5.0
  - setNewWallBaseboardHeight
```
public void setNewWallBaseboardHeight(float newWallBaseboardHeight)
```
    Sets default baseboard height of new walls, and notifies listeners of this change.
    
    Since:
    
    5.0
  - getNewRoomFloorColor
```
public java.lang.Integer getNewRoomFloorColor()
```
    Returns the default color of new rooms in home.
    
    Since:
    
    6.4
  - setNewRoomFloorColor
```
public void setNewRoomFloorColor(java.lang.Integer newRoomFloorColor)
```
    Sets the default color of new rooms in home, and notifies listeners of this change.
    
    Since:
    
    6.4
  - getNewFloorThickness
```
public float getNewFloorThickness()
```
    Returns default thickness of the floor of new levels in home.
    
    Since:
    
    3.4
  - setNewFloorThickness
```
public void setNewFloorThickness(float newFloorThickness)
```
    Sets default thickness of the floor of new levels in home, and notifies listeners of this change.
    
    Since:
    
    3.4
  - isCheckUpdatesEnabled
```
public boolean isCheckUpdatesEnabled()
```
    Returns true if updates should be checked.
    
    Since:
    
    4.0
  - setCheckUpdatesEnabled
```
public void setCheckUpdatesEnabled(boolean updatesChecked)
```
    Sets whether updates should be checked or not.
    
    Since:
    
    4.0
  - getUpdatesMinimumDate
```
public java.lang.Long getUpdatesMinimumDate()
```
    Returns the minimum date of updates that may interest user.
    
    Returns:
    
    the date expressed in millis second since the epoch or null if not defined.
    
    Since:
    
    4.0
  - setUpdatesMinimumDate
```
public void setUpdatesMinimumDate(java.lang.Long updatesMinimumDate)
```
    Sets the minimum date of updates that may interest user, and notifies listeners of this change.
    
    Since:
    
    4.0
  - getAutoSaveDelayForRecovery
```
public int getAutoSaveDelayForRecovery()
```
    Returns the delay between two automatic save operations of homes for recovery purpose.
    
    Returns:
    
    a delay in milliseconds or 0 to disable auto save.
    
    Since:
    
    3.0
  - setAutoSaveDelayForRecovery
```
public void setAutoSaveDelayForRecovery(int autoSaveDelayForRecovery)
```
    Sets the delay between two automatic save operations of homes for recovery purpose.
    
    Since:
    
    3.0
  - getRecentHomes
```
public java.util.List<java.lang.String> getRecentHomes()
```
    Returns an unmodifiable list of the recent homes.
  - setRecentHomes
```
public void setRecentHomes(java.util.List<java.lang.String> recentHomes)
```
    Sets the recent homes list and notifies listeners of this change.
  - getRecentHomesMaxCount
```
public int getRecentHomesMaxCount()
```
    Returns the maximum count of homes that should be proposed to the user.
  - getStoredCamerasMaxCount
```
public int getStoredCamerasMaxCount()
```
    Returns the maximum count of stored cameras in homes that should be proposed to the user.
    
    Since:
    
    4.5
  - setActionTipIgnored
```
public void setActionTipIgnored(java.lang.String actionKey)
```
    Sets which action tip should be ignored.
    This method should be overridden to store the ignore information. By default it just notifies listeners of this change.
  - isActionTipIgnored
```
public boolean isActionTipIgnored(java.lang.String actionKey)
```
    Returns whether an action tip should be ignored or not.
    This method should be overridden to return the display information stored in setActionTipIgnored. By default it returns true.
  - resetIgnoredActionTips
```
public void resetIgnoredActionTips()
```
    Resets the ignore flag of action tips.
    This method should be overridden to clear all the display flags. By default it just notifies listeners of this change.
  - getDefaultTextStyle
```
public TextStyle getDefaultTextStyle(java.lang.Class<? extends Selectable> selectableClass)
```
    Returns the default text style of a class of selectable item.
  - getAutoCompletionStrings
```
public java.util.List<java.lang.String> getAutoCompletionStrings(java.lang.String property)
```
    Returns the strings that may be used for the auto completion of the given property.
    
    Since:
    
    3.4
  - addAutoCompletionString
```
public void addAutoCompletionString(java.lang.String property,
                                    java.lang.String autoCompletionString)
```
    Adds the given string to the list of the strings used in auto completion of a property and notifies listeners of this change.
    
    Since:
    
    3.4
  - setAutoCompletionStrings
```
public void setAutoCompletionStrings(java.lang.String property,
                                     java.util.List<java.lang.String> autoCompletionStrings)
```
    Sets the auto completion strings list of the given property and notifies listeners of this change.
    
    Since:
    
    3.4
  - getAutoCompletedProperties
```
public java.util.List<java.lang.String> getAutoCompletedProperties()
```
    Returns the list of properties with auto completion strings.
    
    Since:
    
    3.4
  - getRecentColors
```
public java.util.List<java.lang.Integer> getRecentColors()
```
    Returns an unmodifiable list of the recent colors.
    
    Since:
    
    4.0
  - setRecentColors
```
public void setRecentColors(java.util.List<java.lang.Integer> recentColors)
```
    Sets the recent colors list and notifies listeners of this change.
    
    Since:
    
    4.0
  - getRecentTextures
```
public java.util.List<TextureImage> getRecentTextures()
```
    Returns an unmodifiable list of the recent textures.
    
    Since:
    
    4.4
  - setRecentTextures
```
public void setRecentTextures(java.util.List<TextureImage> recentTextures)
```
    Sets the recent colors list and notifies listeners of this change.
    
    Since:
    
    4.4
  - setHomeExamples
```
protected void setHomeExamples(java.util.List<HomeDescriptor> homeExamples)
```
    Sets the home examples available for the user.
    
    Since:
    
    5.5
  - getHomeExamples
```
public java.util.List<HomeDescriptor> getHomeExamples()
```
    Returns the home examples available for the user.
    
    Since:
    
    5.5
  - setPhotoRenderer
```
public void setPhotoRenderer(java.lang.String photoRenderer)
```
    Sets the preferred rendering engine used to create photos.
    
    Since:
    
    7.0
  - getPhotoRenderer
```
public java.lang.String getPhotoRenderer()
```
    Returns the preferred rendering engine used to create photos.
    
    Since:
    
    7.0
  - addLanguageLibrary
```
public abstract void addLanguageLibrary(java.lang.String languageLibraryLocation)
                                 throws RecorderException
```
    Adds the language library to make the languages it contains available to supported languages.
    
    Parameters:
    
    languageLibraryLocation - the location where the library can be found.
    
    Throws:
    
    RecorderException
    
    Since:
    
    2.3
  - languageLibraryExists
```
public abstract boolean languageLibraryExists(java.lang.String languageLibraryLocation)
                                       throws RecorderException
```
    Returns true if the language library at the given location exists.
    
    Parameters:
    
    languageLibraryLocation - the name of the resource to check
    
    Throws:
    
    RecorderException
    
    Since:
    
    2.3
  - addFurnitureLibrary
```
public abstract void addFurnitureLibrary(java.lang.String furnitureLibraryLocation)
                                  throws RecorderException
```
    Adds furnitureLibraryName to furniture catalog to make the furniture it contains available.
    
    Parameters:
    
    furnitureLibraryLocation - the location where the library can be found.
    
    Throws:
    
    RecorderException
  - furnitureLibraryExists
```
public abstract boolean furnitureLibraryExists(java.lang.String furnitureLibraryLocation)
                                        throws RecorderException
```
    Returns true if the furniture library at the given location exists.
    
    Parameters:
    
    furnitureLibraryLocation - the name of the resource to check
    
    Throws:
    
    RecorderException
  - addTexturesLibrary
```
public abstract void addTexturesLibrary(java.lang.String texturesLibraryLocation)
                                 throws RecorderException
```
    Adds the textures library at the given location to textures catalog to make the textures it contains available.
    
    Parameters:
    
    texturesLibraryLocation - the location where the library can be found.
    
    Throws:
    
    RecorderException
    
    Since:
    
    2.3
  - texturesLibraryExists
```
public abstract boolean texturesLibraryExists(java.lang.String texturesLibraryLocation)
                                       throws RecorderException
```
    Returns true if the textures library at the given location exists.
    
    Parameters:
    
    texturesLibraryLocation - the name of the resource to check
    
    Throws:
    
    RecorderException
    
    Since:
    
    2.3
  - getLibraries
```
public abstract java.util.List<Library> getLibraries()
```
    Returns the libraries available in user preferences.
    
    Since:
    
    4.0

Class UserPreferences

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FURNITURE_LIBRARY_TYPE

TEXTURES_LIBRARY_TYPE

LANGUAGE_LIBRARY_TYPE

Constructor Detail

UserPreferences

Method Detail

write

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

getFurnitureCatalog

setFurnitureCatalog

getTexturesCatalog

setTexturesCatalog

getPatternsCatalog

setPatternsCatalog

getLengthUnit

setUnit

getLanguage

setLanguage

isLanguageEditable

getDefaultSupportedLanguages

getSupportedLanguages

setSupportedLanguages

getLocalizedString

getLocalizedString

getLocalizedStringKeys

getResourceClassLoaders

getCurrency

setCurrency

isValueAddedTaxEnabled

setValueAddedTaxEnabled

getDefaultValueAddedTaxPercentage

setDefaultValueAddedTaxPercentage

isFurnitureCatalogViewedInTree

setFurnitureCatalogViewedInTree

isNavigationPanelVisible

setNavigationPanelVisible

isEditingIn3DViewEnabled

setEditingIn3DViewEnabled

isAerialViewCenteredOnSelectionEnabled

setAerialViewCenteredOnSelectionEnabled

isObserverCameraSelectedAtChange

setObserverCameraSelectedAtChange

isMagnetismEnabled

setMagnetismEnabled

isRulersVisible

setRulersVisible

isGridVisible

setGridVisible

isDrawingModeEnabled

getDefaultFontName

setDefaultFontName

isFurnitureViewedFromTop

setFurnitureViewedFromTop

getFurnitureModelIconSize

setFurnitureModelIconSize

isRoomFloorColoredOrTextured

setFloorColoredOrTextured

getWallPattern

setWallPattern

getNewWallPattern

setNewWallPattern

getNewWallThickness

setNewWallThickness

getNewWallHeight

setNewWallHeight

getNewWallBaseboardThickness

setNewWallBaseboardThickness

getNewWallBaseboardHeight

setNewWallBaseboardHeight

getNewRoomFloorColor