org.jfree.report.modules.gui.swing.common

Class AbstractActionPlugin

Implemented Interfaces:
ActionPlugin
Known Direct Subclasses:
AboutActionPlugin, AbstractExportActionPlugin, ExitActionPlugin, GoToActionPlugin, GoToFirstPageActionPlugin, GoToLastPageActionPlugin, GoToNextPageActionPlugin, GoToPreviousPageActionPlugin, PrintActionPlugin, ZoomCustomActionPlugin, ZoomInActionPlugin, ZoomListActionPlugin, ZoomOutActionPlugin

public abstract class AbstractActionPlugin
extends java.lang.Object
implements ActionPlugin

The AbstractExportPlugin provides a basic implementation of the ExportPlugin interface.
Author:
Thomas Morgner

Field Summary

static String
BASE_RESOURCE_CLASS
The base resource class.

Constructor Summary

AbstractActionPlugin()

Method Summary

void
addPropertyChangeListener(PropertyChangeListener l)
void
addPropertyChangeListener(String property, PropertyChangeListener l)
protected ReportProgressDialog
createProgressDialog()
Creates a progress dialog, and tries to assign a parent based on the given preview proxy.
ExtendedConfiguration
getConfig()
protected abstract String
getConfigurationPrefix()
SwingGuiContext
getContext()
String
getFailureDescription()
Returns an error description for the last operation.
IconTheme
getIconTheme()
int
getMenuOrder()
A sort key used to enforce a certain order within the actions.
protected PropertyChangeSupport
getPropertyChangeSupport()
String
getRole()
int
getRolePreference()
String
getStatusText()
int
getToolbarOrder()
boolean
initialize(SwingGuiContext context)
boolean
isAddToMenu()
Returns true if the action should be added to the menu, and false otherwise.
boolean
isAddToToolbar()
Returns true if the action should be added to the toolbar, and false otherwise.
boolean
isEnabled()
boolean
isSeparated()
Returns true if the action is separated, and false otherwise.
void
removePropertyChangeListener(PropertyChangeListener l)
void
setEnabled(boolean enabled)
void
setStatusText(String statusText)

Field Details

BASE_RESOURCE_CLASS

public static final String BASE_RESOURCE_CLASS
The base resource class.

Constructor Details

AbstractActionPlugin

protected AbstractActionPlugin()

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)
Specified by:
addPropertyChangeListener in interface ActionPlugin

addPropertyChangeListener

public void addPropertyChangeListener(String property,
                                      PropertyChangeListener l)
Specified by:
addPropertyChangeListener in interface ActionPlugin

createProgressDialog

protected ReportProgressDialog createProgressDialog()
Creates a progress dialog, and tries to assign a parent based on the given preview proxy.
Returns:
the progress dialog.

getConfig

public ExtendedConfiguration getConfig()

getConfigurationPrefix

protected abstract String getConfigurationPrefix()

getContext

public SwingGuiContext getContext()

getFailureDescription

public String getFailureDescription()
Returns an error description for the last operation. This implementation provides a basic default failure description text and should be overriden to give a more detailed explaination.
Returns:
returns a error description.

getIconTheme

public IconTheme getIconTheme()

getMenuOrder

public int getMenuOrder()
A sort key used to enforce a certain order within the actions.
Specified by:
getMenuOrder in interface ActionPlugin
Returns:

getPropertyChangeSupport

protected PropertyChangeSupport getPropertyChangeSupport()

getRole

public String getRole()
Specified by:
getRole in interface ActionPlugin

getRolePreference

public int getRolePreference()
Specified by:
getRolePreference in interface ActionPlugin

getStatusText

public String getStatusText()

getToolbarOrder

public int getToolbarOrder()
Specified by:
getToolbarOrder in interface ActionPlugin

initialize

public boolean initialize(SwingGuiContext context)
Specified by:
initialize in interface ActionPlugin

isAddToMenu

public boolean isAddToMenu()
Returns true if the action should be added to the menu, and false otherwise.
Specified by:
isAddToMenu in interface ActionPlugin
Returns:
A boolean.

isAddToToolbar

public boolean isAddToToolbar()
Returns true if the action should be added to the toolbar, and false otherwise.
Specified by:
isAddToToolbar in interface ActionPlugin
Returns:
true, if the plugin should be added to the toolbar, false otherwise.

isEnabled

public boolean isEnabled()

isSeparated

public boolean isSeparated()
Returns true if the action is separated, and false otherwise. A separated action starts a new action group and will be spearated from previous actions on the menu and toolbar.
Specified by:
isSeparated in interface ActionPlugin
Returns:
true, if the action should be separated from previous actions, false otherwise.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)
Specified by:
removePropertyChangeListener in interface ActionPlugin

setEnabled

public void setEnabled(boolean enabled)

setStatusText

public void setStatusText(String statusText)