Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.gui » config » editor » [javadoc | source]
org.jfree.report.modules.gui.config.editor
public interface: ModuleEditor [javadoc | source]

All Known Implementing Classes:
    DefaultModuleEditor

The module editor is used to provide a customizable editor component for a JfreeReport module.

At the moment, there is only one common module editor known, which provides an on-the-fly editor for all defined properties of the module. Specialized editors may be added in the future.

Method from org.jfree.report.modules.gui.config.editor.ModuleEditor Summary:
canHandle,   createInstance,   getComponent,   reset,   store
Method from org.jfree.report.modules.gui.config.editor.ModuleEditor Detail:
 public boolean canHandle(Module module)
    Checks whether this module editor can handle the given module.
 public ModuleEditor createInstance(Module module,
    HierarchicalConfiguration config,
    ConfigDescriptionEntry[] keyNames)
    Creates a new instance of the module editor. This instance will be used to edit the
specific module.

    
Editors are free to ignore the list of keys given as builder hints.
 public JComponent getComponent()
    Returns the editor component of the module. Calling this method is only valid on
instances created with createInstance.
 public  void reset()
    Resets all keys to the values from the report configuration.
 public  void store()
    Stores all values for the editor's keys into the report configuration.