UserPreferencesController (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.viewcontroller.UserPreferencesController

All Implemented Interfaces:

Controller
```
public class UserPreferencesController
extends java.lang.Object
implements Controller
```
A MVC controller for user preferences view.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UserPreferencesController.Property
The properties that may be edited by the view associated to this controller.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserPreferencesController.Property` The properties that may be edited by the view associated to this controller.

Constructor Summary

Constructors
Constructor and Description
`UserPreferencesController(UserPreferences preferences, ViewFactory viewFactory, ContentManager contentManager)` Creates the controller of user preferences view.
`UserPreferencesController(UserPreferences preferences, ViewFactory viewFactory, ContentManager contentManager, HomeController homeController)` Creates the controller of user preferences view.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(UserPreferencesController.Property property, java.beans.PropertyChangeListener listener)` Adds the property change `listener` in parameter to this controller.
`void`	`checkUpdates()` Checks if some updates are available.
`void`	`displayView(View parentView)` Displays the view controlled by this controller.
`int`	`getAutoSaveDelayForRecovery()` Returns the edited auto recovery save delay.
`java.lang.String`	`getCurrency()` Returns the edited currency.
`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.
`int`	`getFurnitureModelIconSize()` Returns the size used to generate icons of furniture viewed from top.
`java.lang.String`	`getLanguage()` Returns the edited language.
`float`	`getNewFloorThickness()` Returns the edited new floor thickness.
`float`	`getNewWallHeight()` Returns the edited new wall height.
`TextureImage`	`getNewWallPattern()` Returns the edited new wall top pattern in plan.
`float`	`getNewWallThickness()` Returns the edited new wall thickness.
`LengthUnit`	`getUnit()` Returns the edited unit.
`DialogView`	`getView()` Returns the view associated with this controller.
`TextureImage`	`getWallPattern()` Returns the default walls top pattern in plan.
`void`	`importLanguageLibrary()` Imports a language library chosen by the user.
`boolean`	`isAerialViewCenteredOnSelectionEnabled()` Returns whether aerial view should be centered on selection or not.
`boolean`	`isAutoSaveForRecoveryEnabled()` Returns `true` if auto recovery save is enabled.
`boolean`	`isCheckUpdatesEnabled()` Returns `true` if updates should be checked.
`boolean`	`isEditingIn3DViewEnabled()` Returns whether interactive editing in 3D view is enabled or not.
`boolean`	`isFurnitureCatalogViewedInTree()` Returns `true` if furniture catalog should be viewed in a tree.
`boolean`	`isFurnitureViewedFromTop()` Returns how furniture should be displayed in plan.
`boolean`	`isGridVisible()` Returns whether grid is visible or not.
`boolean`	`isMagnetismEnabled()` Returns whether magnetism is enabled or not.
`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`	`isPropertyEditable(UserPreferencesController.Property property)` Returns `true` if the given `property` is editable.
`boolean`	`isRoomFloorColoredOrTextured()` Returns `true` if floor texture is visible in plan.
`boolean`	`isRulersVisible()` Returns whether rulers are visible or not.
`boolean`	`isValueAddedTaxEnabled()` Returns `true` if Value Added Tax should be taken in account in prices.
`boolean`	`mayImportLanguageLibrary()` Returns `true` if language libraries can be imported.
`void`	`modifyUserPreferences()` Controls the modification of user preferences.
`void`	`removePropertyChangeListener(UserPreferencesController.Property property, java.beans.PropertyChangeListener listener)` Removes the property change `listener` in parameter from this controller.
`void`	`resetDisplayedActionTips()` Resets the displayed flags of action tips.
`void`	`setAerialViewCenteredOnSelectionEnabled(boolean aerialViewCenteredOnSelectionEnabled)` Sets whether aerial view should be centered on selection or not.
`void`	`setAutoSaveDelayForRecovery(int autoSaveDelayForRecovery)` Sets the edited auto recovery save delay.
`void`	`setAutoSaveForRecoveryEnabled(boolean autoSaveForRecoveryEnabled)` Sets whether auto recovery save is enabled or not.
`void`	`setCheckUpdatesEnabled(boolean updatesChecked)` Sets whether updates should be checked or not.
`void`	`setCurrency(java.lang.String currency)` Sets the edited currency.
`void`	`setDefaultFontName(java.lang.String defaultFontName)` Sets the name of the font that should be used by default.
`void`	`setEditingIn3DViewEnabled(boolean editingIn3DViewEnabled)` Sets whether interactive editing in 3D view is enabled or not.
`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 size used to generate icons of furniture viewed from top.
`void`	`setFurnitureViewedFromTop(boolean furnitureViewedFromTop)` Sets how furniture should be displayed in plan.
`void`	`setGridVisible(boolean gridVisible)` Sets whether grid is visible or not.
`void`	`setLanguage(java.lang.String language)` Sets the edited language.
`void`	`setMagnetismEnabled(boolean magnetismEnabled)` Sets whether magnetism is enabled or not.
`void`	`setNavigationPanelVisible(boolean navigationPanelVisible)` Sets whether the navigation panel should be displayed or not.
`void`	`setNewFloorThickness(float newFloorThickness)` Sets the edited new floor thickness.
`void`	`setNewWallHeight(float newWallHeight)` Sets the edited new wall height.
`void`	`setNewWallPattern(TextureImage newWallPattern)` Sets the edited new wall top pattern in plan, and notifies listeners of this change.
`void`	`setNewWallThickness(float newWallThickness)` Sets the edited new wall thickness.
`void`	`setObserverCameraSelectedAtChange(boolean observerCameraSelectedAtChange)` Sets whether the observer camera should be selected at each change.
`void`	`setRoomFloorColoredOrTextured(boolean floorTextureVisible)` Sets whether floor texture is visible in plan or not.
`void`	`setRulersVisible(boolean rulersVisible)` Sets whether rulers are visible or not.
`void`	`setUnit(LengthUnit unit)` Sets the edited unit.
`void`	`setValueAddedTaxEnabled(boolean valueAddedTaxEnabled)` Sets whether Value Added Tax should be taken in account in prices.
`void`	`setWallPattern(TextureImage wallPattern)` Sets default walls top pattern in plan, and notifies listeners of this change.
`protected void`	`updateProperties()` Updates preferences properties edited by this controller.

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

- Constructor Detail
  - UserPreferencesController
```
public UserPreferencesController(UserPreferences preferences,
                                 ViewFactory viewFactory,
                                 ContentManager contentManager)
```
    Creates the controller of user preferences view.
  - UserPreferencesController
```
public UserPreferencesController(UserPreferences preferences,
                                 ViewFactory viewFactory,
                                 ContentManager contentManager,
                                 HomeController homeController)
```
    Creates the controller of user preferences view.
- Method Detail
  - getView
```
public DialogView getView()
```
    Returns the view associated with this controller.
    
    Specified by:
    
    getView in interface Controller
  - displayView
```
public void displayView(View parentView)
```
    Displays the view controlled by this controller.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(UserPreferencesController.Property property,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the property change listener in parameter to this controller.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(UserPreferencesController.Property property,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the property change listener in parameter from this controller.
  - updateProperties
```
protected void updateProperties()
```
    Updates preferences properties edited by this controller.
  - isPropertyEditable
```
public boolean isPropertyEditable(UserPreferencesController.Property property)
```
    Returns true if the given property is editable. Depending on whether a property is editable or not, the view associated to this controller may render it differently. The implementation of this method always returns true except for LANGUAGE if it's not editable.
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
    Sets the edited language.
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns the edited language.
  - setUnit
```
public void setUnit(LengthUnit unit)
```
    Sets the edited unit.
  - getUnit
```
public LengthUnit getUnit()
```
    Returns the edited unit.
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Sets the edited currency.
    
    Since:
    
    6.0
  - getCurrency
```
public java.lang.String getCurrency()
```
    Returns the edited currency.
    
    Since:
    
    6.0
  - setValueAddedTaxEnabled
```
public void setValueAddedTaxEnabled(boolean valueAddedTaxEnabled)
```
    Sets whether Value Added Tax should be taken in account in prices.
    
    Since:
    
    6.0
  - isValueAddedTaxEnabled
```
public boolean isValueAddedTaxEnabled()
```
    Returns true if Value Added Tax should be taken in account in prices.
    
    Since:
    
    6.0
  - setFurnitureCatalogViewedInTree
```
public void setFurnitureCatalogViewedInTree(boolean furnitureCatalogViewedInTree)
```
    Sets whether the furniture catalog should be viewed in a tree or a different way.
  - isFurnitureCatalogViewedInTree
```
public boolean isFurnitureCatalogViewedInTree()
```
    Returns true if furniture catalog should be viewed in a tree.
  - setNavigationPanelVisible
```
public void setNavigationPanelVisible(boolean navigationPanelVisible)
```
    Sets whether the navigation panel should be displayed or not.
  - isNavigationPanelVisible
```
public boolean isNavigationPanelVisible()
```
    Returns true if the navigation panel should be displayed.
  - setEditingIn3DViewEnabled
```
public void setEditingIn3DViewEnabled(boolean editingIn3DViewEnabled)
```
    Sets whether interactive editing in 3D view is enabled or not.
    
    Since:
    
    7.2
  - isEditingIn3DViewEnabled
```
public boolean isEditingIn3DViewEnabled()
```
    Returns whether interactive editing in 3D view is enabled or not.
    
    Since:
    
    7.2
  - setAerialViewCenteredOnSelectionEnabled
```
public void setAerialViewCenteredOnSelectionEnabled(boolean aerialViewCenteredOnSelectionEnabled)
```
    Sets whether aerial view should be centered on selection or not.
    
    Since:
    
    4.0
  - isAerialViewCenteredOnSelectionEnabled
```
public boolean isAerialViewCenteredOnSelectionEnabled()
```
    Returns whether aerial view should be centered on selection or not.
    
    Since:
    
    4.0
  - setObserverCameraSelectedAtChange
```
public void setObserverCameraSelectedAtChange(boolean observerCameraSelectedAtChange)
```
    Sets whether the observer camera should be selected at each change.
    
    Since:
    
    5.5
  - isObserverCameraSelectedAtChange
```
public boolean isObserverCameraSelectedAtChange()
```
    Returns whether the observer camera should be selected at each change.
    
    Since:
    
    5.5
  - setMagnetismEnabled
```
public void setMagnetismEnabled(boolean magnetismEnabled)
```
    Sets whether magnetism is enabled or not.
  - isMagnetismEnabled
```
public boolean isMagnetismEnabled()
```
    Returns whether magnetism is enabled or not.
  - setRulersVisible
```
public void setRulersVisible(boolean rulersVisible)
```
    Sets whether rulers are visible or not.
  - isRulersVisible
```
public boolean isRulersVisible()
```
    Returns whether rulers are visible or not.
  - setGridVisible
```
public void setGridVisible(boolean gridVisible)
```
    Sets whether grid is visible or not.
  - isGridVisible
```
public boolean isGridVisible()
```
    Returns whether grid is visible or not.
  - setDefaultFontName
```
public void setDefaultFontName(java.lang.String defaultFontName)
```
    Sets the name of the font that should be used by default.
    
    Since:
    
    5.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
  - setFurnitureViewedFromTop
```
public void setFurnitureViewedFromTop(boolean furnitureViewedFromTop)
```
    Sets how furniture should be displayed in plan.
  - isFurnitureViewedFromTop
```
public boolean isFurnitureViewedFromTop()
```
    Returns how furniture should be displayed in plan.
  - setFurnitureModelIconSize
```
public void setFurnitureModelIconSize(int furnitureModelIconSize)
```
    Sets the size used to generate icons of furniture viewed from top.
    
    Since:
    
    5.5
  - getFurnitureModelIconSize
```
public int getFurnitureModelIconSize()
```
    Returns the size used to generate icons of furniture viewed from top.
    
    Since:
    
    5.5
  - setRoomFloorColoredOrTextured
```
public void setRoomFloorColoredOrTextured(boolean floorTextureVisible)
```
    Sets whether floor texture is visible in plan or not.
  - isRoomFloorColoredOrTextured
```
public boolean isRoomFloorColoredOrTextured()
```
    Returns true if floor texture is visible in plan.
  - setWallPattern
```
public void setWallPattern(TextureImage wallPattern)
```
    Sets default walls top pattern in plan, and notifies listeners of this change.
  - getWallPattern
```
public TextureImage getWallPattern()
```
    Returns the default walls top pattern in plan.
  - setNewWallPattern
```
public void setNewWallPattern(TextureImage newWallPattern)
```
    Sets the edited new wall top pattern in plan, and notifies listeners of this change.
    
    Since:
    
    4.0
  - getNewWallPattern
```
public TextureImage getNewWallPattern()
```
    Returns the edited new wall top pattern in plan.
    
    Since:
    
    4.0
  - setNewWallThickness
```
public void setNewWallThickness(float newWallThickness)
```
    Sets the edited new wall thickness.
  - getNewWallThickness
```
public float getNewWallThickness()
```
    Returns the edited new wall thickness.
  - setNewWallHeight
```
public void setNewWallHeight(float newWallHeight)
```
    Sets the edited new wall height.
  - getNewWallHeight
```
public float getNewWallHeight()
```
    Returns the edited new wall height.
  - setNewFloorThickness
```
public void setNewFloorThickness(float newFloorThickness)
```
    Sets the edited new floor thickness.
  - getNewFloorThickness
```
public float getNewFloorThickness()
```
    Returns the edited new floor thickness.
  - setCheckUpdatesEnabled
```
public void setCheckUpdatesEnabled(boolean updatesChecked)
```
    Sets whether updates should be checked or not.
    
    Since:
    
    4.0
  - isCheckUpdatesEnabled
```
public boolean isCheckUpdatesEnabled()
```
    Returns true if updates should be checked.
    
    Since:
    
    4.0
  - setAutoSaveDelayForRecovery
```
public void setAutoSaveDelayForRecovery(int autoSaveDelayForRecovery)
```
    Sets the edited auto recovery save delay.
  - getAutoSaveDelayForRecovery
```
public int getAutoSaveDelayForRecovery()
```
    Returns the edited auto recovery save delay.
  - setAutoSaveForRecoveryEnabled
```
public void setAutoSaveForRecoveryEnabled(boolean autoSaveForRecoveryEnabled)
```
    Sets whether auto recovery save is enabled or not.
  - isAutoSaveForRecoveryEnabled
```
public boolean isAutoSaveForRecoveryEnabled()
```
    Returns true if auto recovery save is enabled.
  - checkUpdates
```
public void checkUpdates()
```
    Checks if some updates are available.
    
    Since:
    
    4.0
  - mayImportLanguageLibrary
```
public boolean mayImportLanguageLibrary()
```
    Returns true if language libraries can be imported.
  - importLanguageLibrary
```
public void importLanguageLibrary()
```
    Imports a language library chosen by the user.
  - resetDisplayedActionTips
```
public void resetDisplayedActionTips()
```
    Resets the displayed flags of action tips.
  - modifyUserPreferences
```
public void modifyUserPreferences()
```
    Controls the modification of user preferences.

Class UserPreferencesController

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPreferencesController

UserPreferencesController

Method Detail

getView

displayView

addPropertyChangeListener

removePropertyChangeListener

updateProperties

isPropertyEditable

setLanguage

getLanguage

setUnit

getUnit

setCurrency

getCurrency

setValueAddedTaxEnabled

isValueAddedTaxEnabled

setFurnitureCatalogViewedInTree

isFurnitureCatalogViewedInTree

setNavigationPanelVisible

isNavigationPanelVisible

setEditingIn3DViewEnabled

isEditingIn3DViewEnabled

setAerialViewCenteredOnSelectionEnabled

isAerialViewCenteredOnSelectionEnabled

setObserverCameraSelectedAtChange

isObserverCameraSelectedAtChange

setMagnetismEnabled

isMagnetismEnabled

setRulersVisible

isRulersVisible

setGridVisible

isGridVisible

setDefaultFontName

getDefaultFontName

setFurnitureViewedFromTop

isFurnitureViewedFromTop

setFurnitureModelIconSize

getFurnitureModelIconSize

setRoomFloorColoredOrTextured

isRoomFloorColoredOrTextured

setWallPattern

getWallPattern

setNewWallPattern

getNewWallPattern

setNewWallThickness

getNewWallThickness

setNewWallHeight

getNewWallHeight

setNewFloorThickness

getNewFloorThickness

setCheckUpdatesEnabled

isCheckUpdatesEnabled

setAutoSaveDelayForRecovery

getAutoSaveDelayForRecovery

setAutoSaveForRecoveryEnabled

isAutoSaveForRecoveryEnabled

checkUpdates

mayImportLanguageLibrary

importLanguageLibrary

resetDisplayedActionTips

modifyUserPreferences