org.jfree.report.modules.gui.swing.preview

Interface ReportController

public interface ReportController

A report controler. This provides some means of configuring the preview components.

The controler should use the propertyChange events provided by the PreviewProxyBase and the ReportPane to update its state.

To force a new repagination, use the refresh method of the PreviewProxyBase.

Author: Thomas Morgner

Method Summary
StringgetControllerLocation()
Returns the location for the report controler, one of BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST or BorderLayout.WEST.
JComponentgetControlPanel()
Returns the graphical representation of the controler.
JMenu[]getMenus()
Returns the menus that should be inserted into the menubar.
voidinitialize(PreviewPane pane)
booleanisInnerComponent()
Defines, whether the controler component is placed between the preview pane and the toolbar.

Method Detail

getControllerLocation

public String getControllerLocation()
Returns the location for the report controler, one of BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST or BorderLayout.WEST.

Returns: the location;

getControlPanel

public JComponent getControlPanel()
Returns the graphical representation of the controler. This component will be added between the menu bar and the toolbar.

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

Returns: the controler component.

getMenus

public JMenu[] getMenus()
Returns the menus that should be inserted into the menubar.

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

Returns: the menus as array, never null.

initialize

public void initialize(PreviewPane pane)

isInnerComponent

public boolean isInnerComponent()
Defines, whether the controler component is placed between the preview pane and the toolbar.

Returns: true, if this is a inner component.