org.pentaho.reporting.tools.configeditor.editor

Class DefaultModuleEditor

java.lang.Object

org.pentaho.reporting.tools.configeditor.editor.DefaultModuleEditor

All Implemented Interfaces:

ModuleEditor

public class DefaultModuleEditor
extends Object
implements ModuleEditor

The default module editor provides a simple default implementation to edit all configuration keys for a given module.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
DefaultModuleEditor() Creates a new, uninitialized module editor.

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, initialized instance of the default 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultModuleEditor

public DefaultModuleEditor()

Creates a new, uninitialized module editor.

Method Detail

createInstance

public ModuleEditor createInstance(org.pentaho.reporting.libraries.base.boot.Module module,
                                   org.pentaho.reporting.libraries.base.config.HierarchicalConfiguration config,
                                   ConfigDescriptionEntry[] keyNames)

Creates a new, initialized instance of the default module editor.

Specified by:

createInstance in interface ModuleEditor

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.

See Also:

ModuleEditor.createInstance(Module, HierarchicalConfiguration, ConfigDescriptionEntry[])

canHandle

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

Checks whether this module editor can handle the given module.

Specified by:

canHandle in interface ModuleEditor

Parameters:

module - the module to be edited.

Returns:

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

See Also:

ModuleEditor.canHandle(Module)

getComponent

public JComponent getComponent()

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

Specified by:

getComponent in interface ModuleEditor

Returns:

the editor component for the GUI.

reset

public void reset()

Resets all keys to the values from the report configuration.

Specified by:

reset in interface ModuleEditor

store

public void store()

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

Specified by:

store in interface ModuleEditor