|
Sweet Home 3D 4.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.eteks.sweethome3d.model.UserPreferences
com.eteks.sweethome3d.io.FileUserPreferences
public class FileUserPreferences
User preferences initialized from
default user preferences
and stored in user preferences on local file system.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.eteks.sweethome3d.model.UserPreferences |
---|
UserPreferences.Property |
Field Summary | |
---|---|
static String |
PLUGIN_LANGUAGE_LIBRARY_FAMILY
|
Fields inherited from class com.eteks.sweethome3d.model.UserPreferences |
---|
FURNITURE_LIBRARY_TYPE, LANGUAGE_LIBRARY_TYPE, TEXTURES_LIBRARY_TYPE |
Constructor Summary | |
---|---|
FileUserPreferences()
Creates user preferences read from user preferences in file system, and from resource files. |
|
FileUserPreferences(File preferencesFolder,
File[] applicationFolders)
Creates user preferences stored in the folders given in parameter. |
|
FileUserPreferences(File preferencesFolder,
File[] applicationFolders,
Executor updater)
Creates user preferences stored in the folders given in parameter. |
Method Summary | |
---|---|
void |
addFurnitureLibrary(String furnitureLibraryPath)
Adds the file furnitureLibraryPath to the first furniture libraries folder
to make the furniture library available to catalog. |
void |
addLanguageLibrary(String languageLibraryPath)
Adds languageLibraryPath to the first language libraries folder
to make the language library it contains available to supported languages. |
void |
addTexturesLibrary(String texturesLibraryPath)
Adds the file texturesLibraryPath to the first textures libraries folder
to make the textures library available to catalog. |
void |
deleteLibraries(List<Library> libraries)
Deletes the given file libraries and updates user preferences. |
boolean |
furnitureLibraryExists(String location)
Returns true if the furniture library at the given location exists
in the first furniture libraries folder. |
File |
getApplicationFolder()
Returns the first Sweet Home 3D application folder. |
File[] |
getApplicationFolders()
Returns Sweet Home 3D application folders. |
File[] |
getApplicationSubfolders(String subfolder)
Returns subfolders of Sweet Home 3D application folders of a given name. |
List<Library> |
getLibraries()
Returns the libraries available in user preferences. |
protected Preferences |
getPreferences()
Returns default Java preferences for current system user. |
List<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(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(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(String actionKey)
Sets which action tip should be ignored. |
boolean |
texturesLibraryExists(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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String PLUGIN_LANGUAGE_LIBRARY_FAMILY
Constructor Detail |
---|
public FileUserPreferences()
public FileUserPreferences(File preferencesFolder, 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(File preferencesFolder, File[] applicationFolders, 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.Method Detail |
---|
public List<ClassLoader> getResourceClassLoaders()
getResourceClassLoaders
in class UserPreferences
public void write() throws RecorderException
write
in class UserPreferences
RecorderException
- if user preferences couldn'y be saved.public File getApplicationFolder() throws IOException
IOException
public File[] getApplicationFolders() throws IOException
IOException
public File[] getApplicationSubfolders(String subfolder) throws IOException
IOException
protected Preferences getPreferences()
public void setActionTipIgnored(String actionKey)
setActionTipIgnored
in class UserPreferences
public boolean isActionTipIgnored(String actionKey)
isActionTipIgnored
in class UserPreferences
public void resetIgnoredActionTips()
resetIgnoredActionTips
in class UserPreferences
public boolean languageLibraryExists(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 check
RecorderException
public void addLanguageLibrary(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(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 check
RecorderException
public void addFurnitureLibrary(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(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 check
RecorderException
public void addTexturesLibrary(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 List<Library> getLibraries()
getLibraries
in class UserPreferences
public void deleteLibraries(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.
|
Sweet Home 3D 4.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
![]() |
© Copyrights 2006-2013 eTeks - All rights reserved
Distributed under GNU General Public License |