Class ConfigTreeModel
- java.lang.Object
-
- org.pentaho.reporting.tools.configeditor.model.ConfigTreeModel
-
- All Implemented Interfaces:
TreeModel
public class ConfigTreeModel extends Object implements TreeModel
Provides a tree model view for an report configuration. The configuration will be separated into a local and a global part. The local nodes are read from the report's configuration instance, while the global nodes are always read from the global report configuration instance.- Author:
- Thomas Morgner
-
-
Constructor Summary
Constructors Constructor Description ConfigTreeModel(org.pentaho.reporting.libraries.base.boot.AbstractBoot packageManager, boolean includeGlobals)
Creates a new tree model from the given specifications.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTreeModelListener(TreeModelListener l)
Adds a listener for theTreeModelEvent
posted after the tree changes.Object
getChild(Object parent, int index)
Returns the child ofparent
at indexindex
in the parent's child array.int
getChildCount(Object parent)
Returns the number of children ofparent
.ConfigDescriptionEntry
getEntryForKey(String key)
Returns the entry for the given key or null, if the key has no metadata.int
getIndexOfChild(Object parent, Object child)
Returns the index of child in parent.Object
getRoot()
Returns the root of the tree.boolean
isLeaf(Object node)
Returnstrue
ifnode
is a leaf.void
load(boolean append)
void
load(InputStream in, boolean append)
void
removeTreeModelListener(TreeModelListener l)
Removes a listener previously added withaddTreeModelListener
.void
updateConfiguration()
Initializes the tree from the given report configuration.void
updateConfiguration(boolean includeGlobals)
void
valueForPathChanged(TreePath path, Object newValue)
Messaged when the user has altered the value for the item identified bypath
tonewValue
.
-
-
-
Constructor Detail
-
ConfigTreeModel
public ConfigTreeModel(org.pentaho.reporting.libraries.base.boot.AbstractBoot packageManager, boolean includeGlobals)
Creates a new tree model from the given specifications. These specifications contain the config description entry definitions used to describe the report configuration keys.- Parameters:
packageManager
- the specifications.includeGlobals
- true to show global and local nodes, false to only show local nodes.
-
-
Method Detail
-
load
public void load(InputStream in, boolean append) throws IOException
- Throws:
IOException
-
load
public void load(boolean append) throws IOException
- Throws:
IOException
-
updateConfiguration
public void updateConfiguration()
Initializes the tree from the given report configuration.
-
updateConfiguration
public void updateConfiguration(boolean includeGlobals)
-
getRoot
public Object getRoot()
Returns the root of the tree. Returnsnull
only if the tree has no nodes.
-
getChild
public Object getChild(Object parent, int index)
Returns the child ofparent
at indexindex
in the parent's child array.parent
must be a node previously obtained from this data source. This should not returnnull
ifindex
is a valid index forparent
(that isindex >= 0 && index < getChildCount(parent
)).
-
getChildCount
public int getChildCount(Object parent)
Returns the number of children ofparent
. Returns 0 if the node is a leaf or if it has no children.parent
must be a node previously obtained from this data source.- Specified by:
getChildCount
in interfaceTreeModel
- Parameters:
parent
- a node in the tree, obtained from this data source- Returns:
- the number of children of the node
parent
-
isLeaf
public boolean isLeaf(Object node)
Returnstrue
ifnode
is a leaf. It is possible for this method to returnfalse
even ifnode
has no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children.
-
valueForPathChanged
public void valueForPathChanged(TreePath path, Object newValue)
Messaged when the user has altered the value for the item identified bypath
tonewValue
. IfnewValue
signifies a truly new value the model should post atreeNodesChanged
event.- Specified by:
valueForPathChanged
in interfaceTreeModel
- Parameters:
path
- path to the node that the user has alterednewValue
- the new value from the TreeCellEditor
-
getIndexOfChild
public int getIndexOfChild(Object parent, Object child)
Returns the index of child in parent. Ifparent
isnull
orchild
isnull
, returns -1.- Specified by:
getIndexOfChild
in interfaceTreeModel
- Parameters:
parent
- a note in the tree, obtained from this data sourcechild
- the node we are interested in- Returns:
- the index of the child in the parent, or -1 if either
child
orparent
arenull
-
addTreeModelListener
public void addTreeModelListener(TreeModelListener l)
Adds a listener for theTreeModelEvent
posted after the tree changes.- Specified by:
addTreeModelListener
in interfaceTreeModel
- Parameters:
l
- the listener to add- See Also:
removeTreeModelListener(javax.swing.event.TreeModelListener)
-
removeTreeModelListener
public void removeTreeModelListener(TreeModelListener l)
Removes a listener previously added withaddTreeModelListener
.- Specified by:
removeTreeModelListener
in interfaceTreeModel
- Parameters:
l
- the listener to remove- See Also:
addTreeModelListener(javax.swing.event.TreeModelListener)
-
getEntryForKey
public ConfigDescriptionEntry getEntryForKey(String key)
Returns the entry for the given key or null, if the key has no metadata.- Parameters:
key
- the name of the key- Returns:
- the entry or null if not found.
-
-