org.pentaho.reporting.tools.configeditor.editor

Interface ModuleEditor

All Known Implementing Classes:

DefaultModuleEditor

public interface ModuleEditor

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.

Author:

Thomas Morgner

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(org.pentaho.reporting.libraries.base.boot.Module module) Checks whether this module editor can handle the given module.
ModuleEditor	createInstance(org.pentaho.reporting.libraries.base.boot.Module module, org.pentaho.reporting.libraries.base.config.HierarchicalConfiguration config, ConfigDescriptionEntry[] keyNames) Creates a new instance of the module editor.
JComponent	getComponent() Returns the editor component of the module.
void	reset() Resets all keys to the values from the report configuration.
void	store() Stores all values for the editor's keys into the report configuration.

Method Detail

createInstance

ModuleEditor createInstance(org.pentaho.reporting.libraries.base.boot.Module module,
                            org.pentaho.reporting.libraries.base.config.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.

Parameters:

module - the module that should be edited.

config - the report configuration used to fill the values of the editors.

keyNames - the list of keynames this module editor should handle.

Returns:

the created new editor instance.

canHandle

boolean canHandle(org.pentaho.reporting.libraries.base.boot.Module module)

Checks whether this module editor can handle the given module.

Parameters:

module - the module to be edited.

Returns:

true, if this editor may be used to edit the module, false otherwise.

getComponent

JComponent getComponent()

Returns the editor component of the module. Calling this method is only valid on instances created with createInstance.

Returns:

the editor component for the GUI.

reset

void reset()

Resets all keys to the values from the report configuration.

store

void store()

Stores all values for the editor's keys into the report configuration.