Class AbstractActionPlugin
java.lang.Object
org.jfree.report.modules.gui.swing.common.AbstractActionPlugin
- All Implemented Interfaces:
ActionPlugin
- Direct Known Subclasses:
AboutActionPlugin
,AbstractExportActionPlugin
,ExitActionPlugin
,GoToActionPlugin
,GoToFirstPageActionPlugin
,GoToLastPageActionPlugin
,GoToNextPageActionPlugin
,GoToPreviousPageActionPlugin
,PrintActionPlugin
,ZoomCustomActionPlugin
,ZoomInActionPlugin
,ZoomListActionPlugin
,ZoomOutActionPlugin
The AbstractExportPlugin provides a basic implementation of the ExportPlugin
interface.
- Author:
- Thomas Morgner
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addPropertyChangeListener
(String property, PropertyChangeListener l) protected ReportProgressDialog
Creates a progress dialog, and tries to assign a parent based on the given preview proxy.org.pentaho.reporting.libraries.base.config.ExtendedConfiguration
protected abstract String
Returns an error description for the last operation.int
A sort key used to enforce a certain order within the actions.protected PropertyChangeSupport
getRole()
int
int
boolean
initialize
(SwingGuiContext context) boolean
Returns true if the action should be added to the menu, and false otherwise.boolean
Returns true if the action should be added to the toolbar, and false otherwise.boolean
boolean
Returns true if the action is separated, and false otherwise.void
void
setEnabled
(boolean enabled) void
setStatusText
(String statusText) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jfree.report.modules.gui.swing.common.ActionPlugin
getAcceleratorKey, getDisplayName, getLargeIcon, getMnemonicKey, getShortDescription, getSmallIcon
-
Field Details
-
BASE_RESOURCE_CLASS
The base resource class.- See Also:
-
-
Constructor Details
-
AbstractActionPlugin
protected AbstractActionPlugin()
-
-
Method Details
-
initialize
- Specified by:
initialize
in interfaceActionPlugin
-
getPropertyChangeSupport
-
getContext
-
getConfig
public org.pentaho.reporting.libraries.base.config.ExtendedConfiguration getConfig() -
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 interfaceActionPlugin
- Returns:
- true, if the action should be separated from previous actions, false otherwise.
-
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.
-
getStatusText
-
setStatusText
-
isAddToToolbar
public boolean isAddToToolbar()Returns true if the action should be added to the toolbar, and false otherwise.- Specified by:
isAddToToolbar
in interfaceActionPlugin
- Returns:
- true, if the plugin should be added to the toolbar, false otherwise.
-
isAddToMenu
public boolean isAddToMenu()Returns true if the action should be added to the menu, and false otherwise.- Specified by:
isAddToMenu
in interfaceActionPlugin
- Returns:
- A boolean.
-
createProgressDialog
Creates a progress dialog, and tries to assign a parent based on the given preview proxy.- Returns:
- the progress dialog.
-
addPropertyChangeListener
- Specified by:
addPropertyChangeListener
in interfaceActionPlugin
-
addPropertyChangeListener
- Specified by:
addPropertyChangeListener
in interfaceActionPlugin
-
removePropertyChangeListener
- Specified by:
removePropertyChangeListener
in interfaceActionPlugin
-
setEnabled
public void setEnabled(boolean enabled) -
isEnabled
public boolean isEnabled() -
getIconTheme
-
getConfigurationPrefix
-
getMenuOrder
public int getMenuOrder()A sort key used to enforce a certain order within the actions.- Specified by:
getMenuOrder
in interfaceActionPlugin
- Returns:
-
getToolbarOrder
public int getToolbarOrder()- Specified by:
getToolbarOrder
in interfaceActionPlugin
-
getRole
- Specified by:
getRole
in interfaceActionPlugin
-
getRolePreference
public int getRolePreference()- Specified by:
getRolePreference
in interfaceActionPlugin
-