org.pentaho.reporting.engine.classic.core.modules.gui.base

Class ParameterReportController

java.lang.Object

org.pentaho.reporting.engine.classic.core.modules.gui.base.ParameterReportController

All Implemented Interfaces:

ReportController

public class ParameterReportController
extends Object
implements ReportController

The default controller for all reports (unless redefined by the user). This controller is responsible for providing a parameter-UI for the reports.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
ParameterReportController()

Method Summary

Modifier and Type	Method and Description
void	deinitialize(PreviewPane pane) Called when the report controller gets removed.
String	getControllerLocation() Returns the location for the report controller, one of BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST or BorderLayout.WEST.
JComponent	getControlPanel() Returns the graphical representation of the controller.
JMenu[]	getMenus() Returns the menus that should be inserted into the menubar.
void	initialize(PreviewPane pane) Called to initialize the report controller and to connect it to the preview pane.
boolean	isInnerComponent() Defines, whether the controller component is placed between the preview pane and the toolbar.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterReportController

public ParameterReportController()

Method Detail

getControlPanel

public JComponent getControlPanel()

Returns the graphical representation of the controller. This component will be added between the menu bar and the toolbar.

Changes to this property are not detected automatically, you have to call "refreshController" whenever you want to display a completely new control panel.

Specified by:

getControlPanel in interface ReportController

Returns:

the controller component.

getMenus

public JMenu[] getMenus()

Returns the menus that should be inserted into the menubar.

Changes to this property are not detected automatically, you have to call "refreshControler" whenever the contents of the menu array changed.

Specified by:

getMenus in interface ReportController

Returns:

the menus as array, never null.

isInnerComponent

public boolean isInnerComponent()

Defines, whether the controller component is placed between the preview pane and the toolbar.

Specified by:

isInnerComponent in interface ReportController

Returns:

true, if this is a inner component.

getControllerLocation

public String getControllerLocation()

Returns the location for the report controller, one of BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST or BorderLayout.WEST.

Specified by:

getControllerLocation in interface ReportController

Returns:

the location;

initialize

public void initialize(PreviewPane pane)

Description copied from interface: ReportController

Called to initialize the report controller and to connect it to the preview pane.

Specified by:

initialize in interface ReportController

deinitialize

public void deinitialize(PreviewPane pane)

Called when the report controller gets removed.

Specified by:

deinitialize in interface ReportController

Parameters:

pane -