org.jfree.report.modules.gui.base
Interface ReportControler

All Known Implementing Classes:

DefaultReportControler

public interface ReportControler

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

java.lang.String	getControlerLocation() Returns the location for the report controler, one of BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST or BorderLayout.WEST.
javax.swing.JComponent	getControlPanel() Returns the graphical representation of the controler.
javax.swing.JMenu[]	getMenus() Returns the menus that should be inserted into the menubar.
PreviewProxyBase	getPreviewBase() Returns the assigned preview proxy base or null if the controler is not connected yet.
boolean	isInnerComponent() Defines, whether the controler component is placed between the report pane and the toolbar.
void	setPreviewBase(PreviewProxyBase proxyBase) Assigns the preview base to this controler.

Method Detail

getControlPanel

public javax.swing.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 "refreshControler" whenever you want to display a completly new control panel.

Returns:

the controler component.

getMenus

public javax.swing.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.

setPreviewBase

public void setPreviewBase(PreviewProxyBase proxyBase)

Assigns the preview base to this controler. This is done automaticy by the PreviewProxyBase itself.

The proxyBase parameter will be null, if the report controler has been removed.

Parameters:

proxyBase - the proxy base.

getPreviewBase

public PreviewProxyBase getPreviewBase()

Returns the assigned preview proxy base or null if the controler is not connected yet.

Returns:

the proxy base.

isInnerComponent

public boolean isInnerComponent()

Defines, whether the controler component is placed between the report pane and the toolbar.

Returns:

true, if this is a inne component.

getControlerLocation

public java.lang.String getControlerLocation()

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

Returns:

the location;