ActionPlugin

All Known Subinterfaces:

ControlActionPlugin, ExportActionPlugin

All Known Implementing Classes:

AboutActionPlugin, AbstractActionPlugin, AbstractExportActionPlugin, CSVDataExportPlugin, CSVTableExportPlugin, ExcelExportPlugin, ExitActionPlugin, GoToActionPlugin, GoToFirstPageActionPlugin, GoToLastPageActionPlugin, GoToNextPageActionPlugin, GoToPreviousPageActionPlugin, HtmlDirExportPlugin, HtmlStreamExportPlugin, HtmlZipExportPlugin, PageSetupPlugin, PdfExportPlugin, PlainTextExportPlugin, PrintingPlugin, RTFExportPlugin, XSSFExcelExportPlugin, ZoomCustomActionPlugin, ZoomInActionPlugin, ZoomListActionPlugin, ZoomOutActionPlugin
```
public interface ActionPlugin
```
The Action-Plugin interface defines the common properties for the Control and Export-Plugins. Implementing just this interface will not make sense, you have to use either the Control- or ExportActionPlugin interface instead.

Author:

Thomas Morgner

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener l)`
`void`	`addPropertyChangeListener(String property, PropertyChangeListener l)`
`void`	`deinitialize(SwingGuiContext swingGuiContext)`
`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`	`isEnabled()`
`boolean`	`isSeparated()` Returns true if the action is separated, and false otherwise.
`void`	`removePropertyChangeListener(PropertyChangeListener l)`

- Method Detail
  - getDisplayName
```
String getDisplayName()
```
    Returns the display name for the export action.
    
    Returns:
    
    The display name.
  - getShortDescription
```
String getShortDescription()
```
    Returns the short description for the export action.
    
    Returns:
    
    The short description.
  - getSmallIcon
```
Icon getSmallIcon()
```
    Returns the small icon for the export action.
    
    Returns:
    
    The icon.
  - getLargeIcon
```
Icon getLargeIcon()
```
    Returns the large icon for the export action.
    
    Returns:
    
    The icon.
  - getAcceleratorKey
```
KeyStroke getAcceleratorKey()
```
    Returns the accelerator key for the export action.
    
    Returns:
    
    The accelerator key.
  - getMnemonicKey
```
Integer getMnemonicKey()
```
    Returns the mnemonic key code.
    
    Returns:
    
    The code.
  - isSeparated
```
boolean isSeparated()
```
    Returns true if the action is separated, and false otherwise.
    
    Returns:
    
    A boolean.
  - isAddToToolbar
```
boolean isAddToToolbar()
```
    Returns true if the action should be added to the toolbar, and false otherwise.
    
    Returns:
    
    A boolean.
  - isAddToMenu
```
boolean isAddToMenu()
```
    Returns true if the action should be added to the menu, and false otherwise.
    
    Returns:
    
    A boolean.
  - isEnabled
```
boolean isEnabled()
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener l)
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(String property,
                               PropertyChangeListener l)
```
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener l)
```
  - getMenuOrder
```
int getMenuOrder()
```
    A sort key used to enforce a certain order within the actions.
    
    Returns:
  - getToolbarOrder
```
int getToolbarOrder()
```
  - getRole
```
String getRole()
```
  - getRolePreference
```
int getRolePreference()
```
  - initialize
```
boolean initialize(SwingGuiContext context)
```
  - deinitialize
```
void deinitialize(SwingGuiContext swingGuiContext)
```

Interface ActionPlugin

Method Summary

Method Detail

getDisplayName

getShortDescription

getSmallIcon

getLargeIcon

getAcceleratorKey

getMnemonicKey

isSeparated

isAddToToolbar

isAddToMenu

isEnabled

addPropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

getMenuOrder

getToolbarOrder

getRole

getRolePreference

initialize

deinitialize