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: ConfigTreeModuleNode [javadoc | source]
java.lang.Object
   org.jfree.report.modules.gui.config.model.AbstractConfigTreeNode
      org.jfree.report.modules.gui.config.model.ConfigTreeModuleNode

All Implemented Interfaces:
    ConfigTreeNode

The config tree module node is used to represent a module in the report configuration. Modules collect all task-specific configuration keys and represent a report module from the package manager.

It is assumed, that all modules define their keys within the namespace of their package.

Constructor:
 public ConfigTreeModuleNode(Module module,
    HierarchicalConfiguration config) 
    Creates a new module node for the given module object and report configuration.
    Parameters:
    module - the module for which to build a tree node.
    config - the report configuration from where to read the keys.
Method from org.jfree.report.modules.gui.config.model.ConfigTreeModuleNode Summary:
addAssignedKey,   getAllowsChildren,   getAssignedKeys,   getConfiguration,   getConfigurationPrefix,   getModule,   isLeaf,   removeAssignedKey,   toString
Methods from org.jfree.report.modules.gui.config.model.AbstractConfigTreeNode:
add,   children,   getAllowsChildren,   getChildAt,   getChildCount,   getIndex,   getName,   getParent,   isLeaf,   reset,   setParent
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.modules.gui.config.model.ConfigTreeModuleNode Detail:
 public  void addAssignedKey(ConfigDescriptionEntry key) 
    Adds the given key to the list of assigned keys, if not already added.
 public boolean getAllowsChildren() 
    Returns true if the receiver allows children.
 public ConfigDescriptionEntry[] getAssignedKeys() 
    Returns the list of assigned keys as object array.
 public HierarchicalConfiguration getConfiguration() 
    Returns the report configuration used to fill the values from this node.
 public String getConfigurationPrefix() 
    Returns the configuration prefix of this module.
 public Module getModule() 
    Returns the module represented by this node.
 public boolean isLeaf() 
    Returns true if the receiver is a leaf.
 public  void removeAssignedKey(ConfigDescriptionEntry key) 
    Removed the given key description from the list of assigned keys.
 public String toString() 
    Returns a string representation of this object.