|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.extension.gui.dock.preference.AbstractPreferenceModel bibliothek.extension.gui.dock.preference.PreferenceTreeModel
public class PreferenceTreeModel
A PreferenceModel
that is also a TreeModel
. It contains
other PreferenceModel
s and organizes them in a tree. The nodes
of this TreeModel
are of the type PreferenceTreeModel.Node
.
The root of this model never has a name nor a model.
Nested Class Summary | |
---|---|
static interface |
PreferenceTreeModel.Node
A single node of a PreferenceTreeModel . |
Constructor Summary | |
---|---|
PreferenceTreeModel()
Creates a new empty model. |
|
PreferenceTreeModel(PathCombiner combiner)
Creates a new empty model. |
Method Summary | |
---|---|
void |
addPreferenceModelListener(PreferenceModelListener listener)
Adds a listener to this model. |
void |
addTreeModelListener(TreeModelListener l)
|
void |
delete(Path path)
Deletes the node at path and all its children from the
tree. |
void |
doOperation(int index,
PreferenceOperation operation)
Executes the enabled operation operation . |
PreferenceTreeModel.Node |
getChild(Object parent,
int index)
|
int |
getChildCount(Object parent)
|
String |
getDescription(int index)
Gets a description of the index 'th object. |
int |
getIndexOfChild(Object parent,
Object child)
|
String |
getLabel(int index)
Gets a short label that can be presented to the user for the index 'th object. |
PreferenceOperation[] |
getOperations(int index)
Gets all operations for which this model has a definition for the preference at location index . |
Path |
getPath(int index)
Gets the unique identifier of the index 'th preference of
this model. |
PreferenceTreeModel.Node |
getRoot()
|
int |
getSize()
Gets the number of preferences stored in this model. |
protected TreeModelListener[] |
getTreeModelListeners()
Gets all the listeners currently known to this model. |
Path |
getTypePath(int index)
Tells what kind of type the index 'th value is. |
Object |
getValue(int index)
Gets the index 'th preference. |
Object |
getValueInfo(int index)
Gets information about how the index 'th value can
be modified. |
boolean |
isEnabled(int index,
PreferenceOperation operation)
Tells whether the operation operation is enabled for
the preference at location index . |
boolean |
isLeaf(Object node)
|
boolean |
isNatural(int index)
Tells whether the index 'th preference is natural or
artificial. |
void |
put(Path path,
String name,
PreferenceModel model)
Sets name and model of a given node. |
void |
putModel(Path path,
PreferenceModel model)
Sets the model of the node at path . |
void |
putNode(Path path,
String name)
Sets the name of the node at path . |
void |
read()
Uses an unknown source to update this model and load all the preferences that are currently available. |
void |
removePreferenceModelListener(PreferenceModelListener listener)
Removes a listener from this model. |
void |
removeTreeModelListener(TreeModelListener l)
|
void |
setValue(int index,
Object value)
Sets the value of the index 'th preference. |
void |
setValueNatural(int index)
Like PreferenceModel.setValue(int, Object) this method changes the value of the index 'th
preference. |
void |
valueForPathChanged(TreePath path,
Object newValue)
|
void |
write()
Writes the current preferences to the location where they are used. |
Methods inherited from class bibliothek.extension.gui.dock.preference.AbstractPreferenceModel |
---|
firePreferenceAdded, firePreferenceChanged, firePreferenceRemoved, hasListeners, listeners |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PreferenceTreeModel()
public PreferenceTreeModel(PathCombiner combiner)
combiner
- tells how to combine the Path
of a model with
the preferences of a model. Used in getPath(int)
. Not null
.MergedPreferenceModel.MergedPreferenceModel(PathCombiner)
Method Detail |
---|
public void addTreeModelListener(TreeModelListener l)
addTreeModelListener
in interface TreeModel
public void addPreferenceModelListener(PreferenceModelListener listener)
PreferenceModel
addPreferenceModelListener
in interface PreferenceModel
addPreferenceModelListener
in class AbstractPreferenceModel
listener
- the new listenerpublic void removeTreeModelListener(TreeModelListener l)
removeTreeModelListener
in interface TreeModel
public void removePreferenceModelListener(PreferenceModelListener listener)
PreferenceModel
removePreferenceModelListener
in interface PreferenceModel
removePreferenceModelListener
in class AbstractPreferenceModel
listener
- the listener to remove.protected TreeModelListener[] getTreeModelListeners()
public PreferenceTreeModel.Node getChild(Object parent, int index)
getChild
in interface TreeModel
public int getChildCount(Object parent)
getChildCount
in interface TreeModel
public int getIndexOfChild(Object parent, Object child)
getIndexOfChild
in interface TreeModel
public PreferenceTreeModel.Node getRoot()
getRoot
in interface TreeModel
public boolean isLeaf(Object node)
isLeaf
in interface TreeModel
public void valueForPathChanged(TreePath path, Object newValue)
valueForPathChanged
in interface TreeModel
public String getDescription(int index)
PreferenceModel
index
'th object. The description
is a longer text that will be presented to the user.
getDescription
in interface PreferenceModel
getDescription
in class AbstractPreferenceModel
index
- the number of the preference
null
, might be formated
in HTMLpublic boolean isNatural(int index)
PreferenceModel
index
'th preference is natural or
artificial.
isNatural
in interface PreferenceModel
isNatural
in class AbstractPreferenceModel
index
- the index of the preference
true
if the preference is natural, false
if it is artificialpublic void setValueNatural(int index)
PreferenceModel
PreferenceModel.setValue(int, Object)
this method changes the value of the index
'th
preference. But this time the natural preference has to extract the value from
its underlying property.
setValueNatural
in interface PreferenceModel
setValueNatural
in class AbstractPreferenceModel
index
- the index of the preference to updatepublic PreferenceOperation[] getOperations(int index)
PreferenceModel
index
. Note: a PreferenceEditor
has operations as well, if the editor and the model share an operation,
then the operation is considered to belong to the editor.
getOperations
in interface PreferenceModel
getOperations
in class AbstractPreferenceModel
index
- the location of a preference
null
public boolean isEnabled(int index, PreferenceOperation operation)
PreferenceModel
operation
is enabled for
the preference at location index
.
isEnabled
in interface PreferenceModel
isEnabled
in class AbstractPreferenceModel
index
- some locationoperation
- an operation from PreferenceModel.getOperations(int)
true
if the operation is enabled, false
if notpublic void doOperation(int index, PreferenceOperation operation)
PreferenceModel
operation
.
doOperation
in interface PreferenceModel
doOperation
in class AbstractPreferenceModel
index
- the location of the affected preferenceoperation
- the operation to executepublic void read()
PreferenceModel
read
in interface PreferenceModel
read
in class AbstractPreferenceModel
public void write()
PreferenceModel
write
in interface PreferenceModel
write
in class AbstractPreferenceModel
public String getLabel(int index)
PreferenceModel
index
'th object.
getLabel
in interface PreferenceModel
index
- the number the preference
public Path getPath(int index)
PreferenceModel
index
'th preference of
this model.
getPath
in interface PreferenceModel
index
- the index of the preference
public int getSize()
PreferenceModel
getSize
in interface PreferenceModel
public Path getTypePath(int index)
PreferenceModel
index
'th value is. The type
is represented as a path. Most times the path would equal the name of
some class. Note: there is a set of standard paths defined in Path
.
getTypePath
in interface PreferenceModel
index
- the number of the value
public Object getValueInfo(int index)
PreferenceModel
index
'th value can
be modified. For an integer that might be its upper and lower boundaries.
The type of this objects depends on PreferenceModel.getTypePath(int)
.
getValueInfo
in interface PreferenceModel
index
- the index of the info
null
if no information is
availablepublic Object getValue(int index)
PreferenceModel
index
'th preference. The type path
determines how the value is to be presented on the screen.
getValue
in interface PreferenceModel
index
- the number of the preference
null
, has to be immutablepublic void setValue(int index, Object value)
PreferenceModel
index
'th preference.
setValue
in interface PreferenceModel
index
- the number of the preferencevalue
- the new value, may be null
public void putNode(Path path, String name)
path
. If there is no
such node, then the node and all its parents are created. Otherwise
just the name gets exchanged.
path
- the path to the nodename
- the new name of the nodepublic void putModel(Path path, PreferenceModel model)
path
. If there is
no such node, then the node and all its parents are created. Otherwise
just the model gets exchanged.
path
- the path to changemodel
- the new modelpublic void put(Path path, String name, PreferenceModel model)
path
- the path to the nodename
- the new namemodel
- the new model, can be null
putNode(Path, String)
,
putModel(Path, PreferenceModel)
public void delete(Path path)
path
and all its children from the
tree. This also removes any PreferenceModel
of the subtree. If
there is no node at path
, then nothing happens
path
- the path to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |