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

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
public abstract class AbstractActionPlugin extends Object implements ActionPlugin
The AbstractExportPlugin provides a basic implementation of the ExportPlugin interface.
Author:
Thomas Morgner

  • Field Details

  • Constructor Details

    • AbstractActionPlugin

      protected AbstractActionPlugin()

  • Method Details

    • initialize

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

    • getPropertyChangeSupport

      protected PropertyChangeSupport getPropertyChangeSupport()

    • getContext

      public SwingGuiContext 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 interface ActionPlugin
      Returns:
      true, if the action should be separated from previous actions, false otherwise.

    • 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.

    • getStatusText

      public String getStatusText()

    • setStatusText

      public void setStatusText(String statusText)

    • 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.

    • 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.

    • createProgressDialog

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

    • 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

    • removePropertyChangeListener

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

    • setEnabled

      public void setEnabled(boolean enabled)

    • isEnabled

      public boolean isEnabled()

    • getIconTheme

      public IconTheme getIconTheme()

    • getConfigurationPrefix

      protected abstract String getConfigurationPrefix()

    • getMenuOrder

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

    • getToolbarOrder

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

    • getRole

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

    • getRolePreference

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