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

Interface ActionPlugin

Known Subinterfaces:
ControlActionPlugin, ExportActionPlugin
Known Implementing Classes:
AboutActionPlugin, AbstractActionPlugin, AbstractExportActionPlugin, ExitActionPlugin, GoToActionPlugin, GoToFirstPageActionPlugin, GoToLastPageActionPlugin, GoToNextPageActionPlugin, GoToPreviousPageActionPlugin, HtmlFileExportActionPlugin, HtmlZipExportActionPlugin, PdfExportActionPlugin, PrintActionPlugin, ZoomCustomActionPlugin, ZoomInActionPlugin, ZoomListActionPlugin, ZoomOutActionPlugin

public interface ActionPlugin

Creation-Date: 16.11.2006, 15:47:02
Author:
Thomas Morgner

Method Summary

void
addPropertyChangeListener(PropertyChangeListener l)
void
addPropertyChangeListener(String property, PropertyChangeListener l)
KeyStroke
getAcceleratorKey()
Returns the accelerator key for the export action.
String
getDisplayName()
Returns the display name for the export action.
Icon
getLargeIcon()
Returns the large icon for the export action.
int
getMenuOrder()
A sort key used to enforce a certain order within the actions.
Integer
getMnemonicKey()
Returns the mnemonic key code.
String
getRole()
int
getRolePreference()
String
getShortDescription()
Returns the short description for the export action.
Icon
getSmallIcon()
Returns the small icon for the export action.
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
isSeparated()
Returns true if the action is separated, and false otherwise.
void
removePropertyChangeListener(PropertyChangeListener l)

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

addPropertyChangeListener

public void addPropertyChangeListener(String property,
                                      PropertyChangeListener l)

getAcceleratorKey

public KeyStroke getAcceleratorKey()
Returns the accelerator key for the export action.
Returns:
The accelerator key.

getDisplayName

public String getDisplayName()
Returns the display name for the export action.
Returns:
The display name.

getLargeIcon

public Icon getLargeIcon()
Returns the large icon for the export action.
Returns:
The icon.

getMenuOrder

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

getMnemonicKey

public Integer getMnemonicKey()
Returns the mnemonic key code.
Returns:
The code.

getRole

public String getRole()

getRolePreference

public int getRolePreference()

getShortDescription

public String getShortDescription()
Returns the short description for the export action.
Returns:
The short description.

getSmallIcon

public Icon getSmallIcon()
Returns the small icon for the export action.
Returns:
The icon.

getToolbarOrder

public int getToolbarOrder()

initialize

public boolean initialize(SwingGuiContext context)

isAddToMenu

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

isAddToToolbar

public boolean isAddToToolbar()
Returns true if the action should be added to the toolbar, and false otherwise.
Returns:
A boolean.

isSeparated

public boolean isSeparated()
Returns true if the action is separated, and false otherwise.
Returns:
A boolean.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)