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 Description ParameterReportController()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.protected ParameterReportControllerPane
getControllerPane()
JComponent
getControlPanel()
Returns the graphical representation of the controller.JMenu[]
getMenus()
Returns the menus that should be inserted into the menubar.protected PreviewPane
getPreviewPane()
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.
-
-
-
Method Detail
-
getPreviewPane
protected PreviewPane getPreviewPane()
-
getControllerPane
protected ParameterReportControllerPane getControllerPane()
-
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 interfaceReportController
- 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 interfaceReportController
- 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 interfaceReportController
- 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 interfaceReportController
- 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 interfaceReportController
-
deinitialize
public void deinitialize(PreviewPane pane)
Called when the report controller gets removed.- Specified by:
deinitialize
in interfaceReportController
- Parameters:
pane
-
-
-