com.eteks.sweethome3d.applet
Class AppletUserPreferences

java.lang.Object
  com.eteks.sweethome3d.model.UserPreferences
      com.eteks.sweethome3d.applet.AppletUserPreferences

public class AppletUserPreferences
extends UserPreferences

Applet user preferences.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested classes/interfaces inherited from class com.eteks.sweethome3d.model.UserPreferences

UserPreferences.Property

Constructor Summary

AppletUserPreferences(URL[] pluginFurnitureCatalogURLs, URL[] pluginTexturesCatalogURLs)
Creates default user preferences read from resource files and catalogs urls given in parameter.

AppletUserPreferences(URL[] pluginFurnitureCatalogURLs, URL[] pluginTexturesCatalogURLs, URL writePreferencesURL, URL readPreferencesURL)
Creates default user preferences read from resource files and catalogs urls given in parameter, then reads saved user preferences from the XML content returned by readPreferencesURL, if URL isn't null or empty.

AppletUserPreferences(URL[] pluginFurnitureCatalogURLs, URL[] pluginTexturesCatalogURLs, URL writePreferencesURL, URL readPreferencesURL, String userLanguage)
Creates default user preferences read from resource files and catalogs urls given in parameter, then reads saved user preferences from the XML content returned by readPreferencesURL, if URL isn't null or empty.

AppletUserPreferences(URL[] pluginFurnitureCatalogURLs, URL furnitureResourcesUrlBase, URL[] pluginTexturesCatalogURLs, URL texturesResourcesUrlBase, URL writePreferencesURL, URL readPreferencesURL, String userLanguage)
Creates default user preferences read from resource files and catalogs urls given in parameter, then reads saved user preferences from the XML content returned by readPreferencesURL, if URL isn't null or empty.

Method Summary

void	addFurnitureLibrary(String name) Throws an exception because applet user preferences can't manage additional furniture libraries.
void	addLanguageLibrary(String languageLibraryName) Throws an exception because applet user preferences can't manage language libraries.
void	addTexturesLibrary(String name) Throws an exception because applet user preferences can't manage additional textures libraries.
boolean	furnitureLibraryExists(String name) Throws an exception because applet user preferences can't manage furniture libraries.
boolean	isActionTipIgnored(String actionKey) Returns whether an action tip should be ignored or not.
boolean	languageLibraryExists(String languageLibraryName) Throws an exception because applet user preferences can't manage additional language libraries.
void	resetIgnoredActionTips() Resets the display flag of action tips.
void	setActionTipIgnored(String actionKey) Sets which action tip should be ignored.
boolean	texturesLibraryExists(String name) Throws an exception because applet user preferences can't manage textures libraries.
void	write() Writes user preferences.

Methods inherited from class com.eteks.sweethome3d.model.UserPreferences

addPropertyChangeListener, getCurrency, getDefaultTextStyle, getFurnitureCatalog, getLanguage, getLengthUnit, getLocalizedString, getLocalizedString, getNewWallHeight, getNewWallThickness, getPatternsCatalog, getRecentHomes, getResourceClassLoaders, getSupportedLanguages, getTexturesCatalog, getWallPattern, isFurnitureCatalogViewedInTree, isFurnitureViewedFromTop, isGridVisible, isMagnetismEnabled, isNavigationPanelVisible, isRoomFloorColoredOrTextured, isRulersVisible, removePropertyChangeListener, setCurrency, setFloorColoredOrTextured, setFurnitureCatalog, setFurnitureCatalogViewedInTree, setFurnitureViewedFromTop, setGridVisible, setLanguage, setMagnetismEnabled, setNavigationPanelVisible, setNewWallHeight, setNewWallThickness, setPatternsCatalog, setRecentHomes, setRulersVisible, setTexturesCatalog, setUnit, setWallPattern

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AppletUserPreferences

public AppletUserPreferences(URL[] pluginFurnitureCatalogURLs,
                             URL[] pluginTexturesCatalogURLs)

Creates default user preferences read from resource files and catalogs urls given in parameter.

AppletUserPreferences

public AppletUserPreferences(URL[] pluginFurnitureCatalogURLs,
                             URL[] pluginTexturesCatalogURLs,
                             URL writePreferencesURL,
                             URL readPreferencesURL)

Creates default user preferences read from resource files and catalogs urls given in parameter, then reads saved user preferences from the XML content returned by readPreferencesURL, if URL isn't null or empty. Preferences modifications will be notified to writePreferencesURL with an XML content describing preferences in a parameter named preferences, if URL isn't null or empty. The DTD of XML content is specified at http://java.sun.com/dtd/properties.dtd. Preferences written with this class don't include imported furniture and textures.

AppletUserPreferences

public AppletUserPreferences(URL[] pluginFurnitureCatalogURLs,
                             URL[] pluginTexturesCatalogURLs,
                             URL writePreferencesURL,
                             URL readPreferencesURL,
                             String userLanguage)

Creates default user preferences read from resource files and catalogs urls given in parameter, then reads saved user preferences from the XML content returned by readPreferencesURL, if URL isn't null or empty. Preferences modifications will be notified to writePreferencesURL with an XML content describing preferences in a parameter named preferences, if URL isn't null or empty. The DTD of XML content is specified at http://java.sun.com/dtd/properties.dtd. Preferences written with this class don't include imported furniture and textures.

AppletUserPreferences

public AppletUserPreferences(URL[] pluginFurnitureCatalogURLs,
                             URL furnitureResourcesUrlBase,
                             URL[] pluginTexturesCatalogURLs,
                             URL texturesResourcesUrlBase,
                             URL writePreferencesURL,
                             URL readPreferencesURL,
                             String userLanguage)

Creates default user preferences read from resource files and catalogs urls given in parameter, then reads saved user preferences from the XML content returned by readPreferencesURL, if URL isn't null or empty. Preferences modifications will be notified to writePreferencesURL with an XML content describing preferences in a parameter named preferences, if URL isn't null or empty. The DTD of XML content is specified at http://java.sun.com/dtd/properties.dtd. Preferences written with this class don't include imported furniture and textures.

Method Detail

write

public void write()
           throws RecorderException

Writes user preferences. This method sends to the writePreferencesURL given at the creation a XML content describing preferences in a parameter named preferences.

Specified by:

write in class UserPreferences

Throws:

RecorderException - if user preferences couldn'y be saved.

setActionTipIgnored

public void setActionTipIgnored(String actionKey)

Sets which action tip should be ignored.

Overrides:

setActionTipIgnored in class UserPreferences

isActionTipIgnored

public boolean isActionTipIgnored(String actionKey)

Returns whether an action tip should be ignored or not.

Overrides:

isActionTipIgnored in class UserPreferences

resetIgnoredActionTips

public void resetIgnoredActionTips()

Resets the display flag of action tips.

Overrides:

resetIgnoredActionTips in class UserPreferences

addLanguageLibrary

public void addLanguageLibrary(String languageLibraryName)
                        throws RecorderException

Throws an exception because applet user preferences can't manage language libraries.

Specified by:

addLanguageLibrary in class UserPreferences

Parameters:

languageLibraryName - the name of the resource in which the library will be written.

Throws:

RecorderException

languageLibraryExists

public boolean languageLibraryExists(String languageLibraryName)
                              throws RecorderException

Throws an exception because applet user preferences can't manage additional language libraries.

Specified by:

languageLibraryExists in class UserPreferences

Parameters:

languageLibraryName - the name of the resource to check

Throws:

RecorderException

furnitureLibraryExists

public boolean furnitureLibraryExists(String name)
                               throws RecorderException

Throws an exception because applet user preferences can't manage furniture libraries.

Specified by:

furnitureLibraryExists in class UserPreferences

Parameters:

name - the name of the resource to check

Throws:

RecorderException

addFurnitureLibrary

public void addFurnitureLibrary(String name)
                         throws RecorderException

Throws an exception because applet user preferences can't manage additional furniture libraries.

Specified by:

addFurnitureLibrary in class UserPreferences

Parameters:

name - the name of the resource in which the library will be written.

Throws:

RecorderException

texturesLibraryExists

public boolean texturesLibraryExists(String name)
                              throws RecorderException

Throws an exception because applet user preferences can't manage textures libraries.

Specified by:

texturesLibraryExists in class UserPreferences

Parameters:

name - the name of the resource to check

Throws:

RecorderException

addTexturesLibrary

public void addTexturesLibrary(String name)
                        throws RecorderException

Throws an exception because applet user preferences can't manage additional textures libraries.

Specified by:

addTexturesLibrary in class UserPreferences

Parameters:

name - the name of the resource in which the library will be written.

Throws:

RecorderException