Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.gui » config » model » [javadoc | source]
org.jfree.report.modules.gui.config.model
public class: ConfigTreeModel [javadoc | source]
java.lang.Object
   org.jfree.report.modules.gui.config.model.ConfigTreeModel

All Implemented Interfaces:
    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.
Constructor:
 public ConfigTreeModel(InputStream specs) throws ConfigTreeModelException 
    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:
    specs - the specifications.
    Throws:
    ConfigTreeModelException - if an error occured while reading the sprecifications and building the model.
 public ConfigTreeModel(InputStream specs,
    boolean includeGlobals) throws ConfigTreeModelException 
Method from org.jfree.report.modules.gui.config.model.ConfigTreeModel Summary:
addTreeModelListener,   getChild,   getChildCount,   getEntryForKey,   getIndexOfChild,   getRoot,   init,   init,   isLeaf,   removeTreeModelListener,   valueForPathChanged
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.modules.gui.config.model.ConfigTreeModel Detail:
 public  void addTreeModelListener(TreeModelListener l) 
    Adds a listener for the TreeModelEvent posted after the tree changes.
 public Object getChild(Object parent,
    int index) 
    Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).
 public int getChildCount(Object parent) 
    Returns the number of children of parent. 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.
 public ConfigDescriptionEntry getEntryForKey(String key) 
    Returns the entry for the given key or null, if the key has no metadata.
 public int getIndexOfChild(Object parent,
    Object child) 
    Returns the index of child in parent. If parent is null or child is null, returns -1.
 public Object getRoot() 
    Returns the root of the tree. Returns null only if the tree has no nodes.
 public  void init(HierarchicalConfiguration config) throws ConfigTreeModelException 
    Initializes the tree from the given report configuration.
 public  void init(HierarchicalConfiguration config,
    boolean includeGlobals) throws ConfigTreeModelException 
 public boolean isLeaf(Object node) 
    Returns true if node is a leaf. It is possible for this method to return false even if node 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.
 public  void removeTreeModelListener(TreeModelListener l) 
    Removes a listener previously added with addTreeModelListener.
 public  void valueForPathChanged(TreePath path,
    Object newValue) 
    Messaged when the user has altered the value for the item identified by path to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.