public class FileUserPreferences extends UserPreferences
default user preferences
and stored in user preferences on local file system.UserPreferences.Property
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PLUGIN_LANGUAGE_LIBRARY_FAMILY |
FURNITURE_LIBRARY_TYPE, LANGUAGE_LIBRARY_TYPE, TEXTURES_LIBRARY_TYPE
Constructor and Description |
---|
FileUserPreferences()
Creates user preferences read from user preferences in file system,
and from resource files.
|
FileUserPreferences(java.io.File preferencesFolder,
java.io.File[] applicationFolders)
Creates user preferences stored in the folders given in parameter.
|
FileUserPreferences(java.io.File preferencesFolder,
java.io.File[] applicationFolders,
java.util.concurrent.Executor updater)
Creates user preferences stored in the folders given in parameter.
|
Modifier and Type | Method and Description |
---|---|
void |
addFurnitureLibrary(java.lang.String furnitureLibraryPath)
Adds the file
furnitureLibraryPath to the first furniture libraries folder
to make the furniture library available to catalog. |
void |
addLanguageLibrary(java.lang.String languageLibraryPath)
Adds
languageLibraryPath to the first language libraries folder
to make the language library it contains available to supported languages. |
void |
addTexturesLibrary(java.lang.String texturesLibraryPath)
Adds the file
texturesLibraryPath to the first textures libraries folder
to make the textures library available to catalog. |
void |
deleteLibraries(java.util.List<Library> libraries)
Deletes the given
libraries and updates user preferences. |
boolean |
furnitureLibraryExists(java.lang.String location)
Returns
true if the furniture library at the given location exists
in the first furniture libraries folder. |
java.io.File |
getApplicationFolder()
Returns the first Sweet Home 3D application folder.
|
java.io.File[] |
getApplicationFolders()
Returns Sweet Home 3D application folders.
|
java.io.File[] |
getApplicationSubfolders(java.lang.String subfolder)
Returns subfolders of Sweet Home 3D application folders of a given name.
|
java.util.List<Library> |
getLibraries()
Returns the libraries available in user preferences.
|
protected java.util.prefs.Preferences |
getPreferences()
Returns default Java preferences for current system user.
|
java.util.List<java.lang.ClassLoader> |
getResourceClassLoaders()
Returns the default class loader of user preferences and the class loaders that
give access to resources in language libraries plugin folder.
|
boolean |
isActionTipIgnored(java.lang.String actionKey)
Returns whether an action tip should be ignored or not.
|
boolean |
isLibraryDeletable(Library library)
Returns
true if the given file library can be deleted. |
boolean |
languageLibraryExists(java.lang.String location)
Returns
true if the language library at the given location exists
in the first language libraries folder. |
void |
resetIgnoredActionTips()
Resets the display flag of action tips.
|
void |
setActionTipIgnored(java.lang.String actionKey)
Sets which action tip should be ignored.
|
boolean |
texturesLibraryExists(java.lang.String location)
Returns
true if the textures library at the given location exists
in the first textures libraries folder. |
void |
write()
Writes user preferences in current user preferences in system.
|
addAutoCompletionString, addPropertyChangeListener, getAutoCompletedProperties, getAutoCompletionStrings, getAutoSaveDelayForRecovery, getCurrency, getDefaultSupportedLanguages, getDefaultTextStyle, getFurnitureCatalog, getLanguage, getLengthUnit, getLocalizedString, getLocalizedString, getNewFloorThickness, getNewWallHeight, getNewWallPattern, getNewWallThickness, getPatternsCatalog, getRecentColors, getRecentHomes, getRecentHomesMaxCount, getSupportedLanguages, getTexturesCatalog, getUpdatesMinimumDate, getWallPattern, isAerialViewCenteredOnSelectionEnabled, isCheckUpdatesEnabled, isFurnitureCatalogViewedInTree, isFurnitureViewedFromTop, isGridVisible, isLanguageEditable, isMagnetismEnabled, isNavigationPanelVisible, isRoomFloorColoredOrTextured, isRulersVisible, removePropertyChangeListener, setAerialViewCenteredOnSelectionEnabled, setAutoCompletionStrings, setAutoSaveDelayForRecovery, setCheckUpdatesEnabled, setCurrency, setFloorColoredOrTextured, setFurnitureCatalog, setFurnitureCatalogViewedInTree, setFurnitureViewedFromTop, setGridVisible, setLanguage, setMagnetismEnabled, setNavigationPanelVisible, setNewFloorThickness, setNewWallHeight, setNewWallPattern, setNewWallThickness, setPatternsCatalog, setRecentColors, setRecentHomes, setRulersVisible, setSupportedLanguages, setTexturesCatalog, setUnit, setUpdatesMinimumDate, setWallPattern
public static final java.lang.String PLUGIN_LANGUAGE_LIBRARY_FAMILY
public FileUserPreferences()
public FileUserPreferences(java.io.File preferencesFolder, java.io.File[] applicationFolders)
preferencesFolder
- the folder where preferences files are stored
or null
if this folder is the default one.applicationFolders
- the folders where application private files are stored
or null
if it's the default one. As the first application folder
is used as the folder where plug-ins files are imported by the user, it should
have write access otherwise the user won't be able to import them.public FileUserPreferences(java.io.File preferencesFolder, java.io.File[] applicationFolders, java.util.concurrent.Executor updater)
preferencesFolder
- the folder where preferences files are stored
or null
if this folder is the default one.applicationFolders
- the folders where application private files are stored
or null
if it's the default one. As the first application folder
is used as the folder where plug-ins files are imported by the user, it should
have write access otherwise the user won't be able to import them.updater
- an executor that will be used to update user preferences for lengthy
operations. If null
, then these operations and
updates will be executed in the current thread.public java.util.List<java.lang.ClassLoader> getResourceClassLoaders()
getResourceClassLoaders
in class UserPreferences
public void write() throws RecorderException
write
in class UserPreferences
RecorderException
- if user preferences couldn'y be saved.public java.io.File getApplicationFolder() throws java.io.IOException
java.io.IOException
public java.io.File[] getApplicationFolders() throws java.io.IOException
java.io.IOException
public java.io.File[] getApplicationSubfolders(java.lang.String subfolder) throws java.io.IOException
java.io.IOException
protected java.util.prefs.Preferences getPreferences()
public void setActionTipIgnored(java.lang.String actionKey)
setActionTipIgnored
in class UserPreferences
public boolean isActionTipIgnored(java.lang.String actionKey)
isActionTipIgnored
in class UserPreferences
public void resetIgnoredActionTips()
resetIgnoredActionTips
in class UserPreferences
public boolean languageLibraryExists(java.lang.String location) throws RecorderException
true
if the language library at the given location exists
in the first language libraries folder.languageLibraryExists
in class UserPreferences
location
- the file path of the resource to checkRecorderException
public void addLanguageLibrary(java.lang.String languageLibraryPath) throws RecorderException
languageLibraryPath
to the first language libraries folder
to make the language library it contains available to supported languages.addLanguageLibrary
in class UserPreferences
languageLibraryPath
- the location where the library can be found.RecorderException
public boolean furnitureLibraryExists(java.lang.String location) throws RecorderException
true
if the furniture library at the given location
exists
in the first furniture libraries folder.furnitureLibraryExists
in class UserPreferences
location
- the file path of the resource to checkRecorderException
public void addFurnitureLibrary(java.lang.String furnitureLibraryPath) throws RecorderException
furnitureLibraryPath
to the first furniture libraries folder
to make the furniture library available to catalog.addFurnitureLibrary
in class UserPreferences
furnitureLibraryPath
- the location where the library can be found.RecorderException
public boolean texturesLibraryExists(java.lang.String location) throws RecorderException
true
if the textures library at the given location
exists
in the first textures libraries folder.texturesLibraryExists
in class UserPreferences
location
- the file path of the resource to checkRecorderException
public void addTexturesLibrary(java.lang.String texturesLibraryPath) throws RecorderException
texturesLibraryPath
to the first textures libraries folder
to make the textures library available to catalog.addTexturesLibrary
in class UserPreferences
texturesLibraryPath
- the location where the library can be found.RecorderException
public java.util.List<Library> getLibraries()
getLibraries
in class UserPreferences
public void deleteLibraries(java.util.List<Library> libraries) throws RecorderException
libraries
and updates user preferences.RecorderException
public boolean isLibraryDeletable(Library library)
true
if the given file library
can be deleted.
© Copyrights 2006-2014 eTeks - All rights reserved
Distributed under GNU General Public License