com.tensegrity.gui.graphdocument
Class GraphDocumentSettingsProvider

java.lang.Object
  com.tensegrity.gui.document.DocumentSettingsProvider
      com.tensegrity.gui.graphdocument.GraphDocumentSettingsProvider

All Implemented Interfaces:

PreferenceDialogProvider

public class GraphDocumentSettingsProvider

extends DocumentSettingsProvider

GraphDocumentSettingsProvider

Author:

BurkhardWick

Nested Class Summary

Nested classes inherited from class com.tensegrity.gui.document.DocumentSettingsProvider

DocumentSettingsProvider.DocSetting

Constructor Summary

GraphDocumentSettingsProvider(Document gDoc, java.util.Map mapPref2Doc, java.lang.String preferenceFileName, java.lang.Class refClass)
Constructor

Method Summary

static java.util.Map

getDefaultPref2DocMap(Document gDoc) Returns a map containing all document settings provided by the framework.

Methods inherited from class com.tensegrity.gui.document.DocumentSettingsProvider

applyChanges, cancelChanges, flush, getAttributeList, getChangedPreferences, getDefaultAttributeSet, isRestorable, makeMap, newDocSetting, newDocSetting

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphDocumentSettingsProvider

public GraphDocumentSettingsProvider(Document gDoc,
                                     java.util.Map mapPref2Doc,
                                     java.lang.String preferenceFileName,
                                     java.lang.Class refClass)
                              throws ReadException,
                                     IllegalAttributeException,
                                     ConstraintViolationException,
                                     java.lang.CloneNotSupportedException,
                                     IllegalNameException,
                                     IllegalValueException

Constructor

Parameters:

gDoc - The document which properties are edited

mapPref2Doc - A map matching keys from the preferences to the corresponding keys in the document. The map should contain an DocSetting for each setting in the preferences.

preferenceFileName - The name of the preference file

refClass - The reference class for loading the preferences file

Throws:

ReadException - forward from DocumentSettingsProvider.DocumentSettingsProvider(Document, Map, String, Class)

java.lang.CloneNotSupportedException - forward from DocumentSettingsProvider.DocumentSettingsProvider(Document, Map, String, Class)

IllegalAttributeException

ConstraintViolationException

IllegalNameException

IllegalValueException

Method Detail

getDefaultPref2DocMap

public static java.util.Map getDefaultPref2DocMap(Document gDoc)

Returns a map containing all document settings provided by the framework. The map can be modified afterwards to add custom settings, as this method creates a new map every time it is called.

Parameters:

gDoc - The document that is edited

Returns:

a map containing all document settings provided by the framework