Class AbstractActionPlugin

    • Field Detail

      • BASE_RESOURCE_CLASS

        public static final java.lang.String BASE_RESOURCE_CLASS
        The base resource class.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractActionPlugin

        protected AbstractActionPlugin()
    • Method Detail

      • getPropertyChangeSupport

        protected java.beans.PropertyChangeSupport getPropertyChangeSupport()
      • 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 java.lang.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 java.lang.String getStatusText()
      • setStatusText

        public void setStatusText​(java.lang.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​(java.lang.String property,
                                              java.beans.PropertyChangeListener l)
        Specified by:
        addPropertyChangeListener in interface ActionPlugin
      • setEnabled

        public void setEnabled​(boolean enabled)
      • isEnabled

        public boolean isEnabled()
      • getIconTheme

        public IconTheme getIconTheme()
      • getConfigurationPrefix

        protected abstract java.lang.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:
      • getRole

        public java.lang.String getRole()
        Specified by:
        getRole in interface ActionPlugin