org.pf.tools.cda.ui.xpi
Class AActionPlugin

java.lang.Object
  extended by org.pf.tools.cda.xpi.APluginImplementation
      extended by org.pf.tools.cda.ui.xpi.AActionPlugin
All Implemented Interfaces:
IPluginActionInfo, IPluginInfo
Direct Known Subclasses:
AModelExporterUIPlugin, ASubWindowPlugin

public abstract class AActionPlugin
extends APluginImplementation
implements IPluginActionInfo

The purpose of this abstract plugin implementation is to provide default implementations of methods that may be overridden by subclasses. This is more stable in comparison to an interface, since adding new methods won't break already existing subclasses.

All subclasses must implement a public non-argument constructor!

Version:
1.0
Author:
M.Duchrow

Field Summary
 
Fields inherited from interface org.pf.tools.cda.ui.xpi.IPluginActionInfo
EMPTY_ARRAY
 
Constructor Summary
AActionPlugin()
           
 
Method Summary
 java.lang.String getDisabledIconFilename(IExplorationModelObject object)
          Returns the name of an icon file that should be shown in the UI when the plug-in cannot be used.
 java.lang.String getEnabledIconFilename(IExplorationModelObject object)
          Returns the filename of an icon image to that should be shown if the plug-in can be used.
 java.lang.String getToolTipText(java.util.Locale locale, IExplorationModelObject object)
          Returns the text that should be shown as tooltip for this plug-in.
 
Methods inherited from class org.pf.tools.cda.xpi.APluginImplementation
getPluginId, setPluginId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pf.tools.cda.ui.xpi.IPluginActionInfo
getActionText, getConfiguration
 
Methods inherited from interface org.pf.tools.cda.xpi.IPluginInfo
getPluginId, getPluginProvider, getPluginVersion
 

Constructor Detail

AActionPlugin

public AActionPlugin()
Method Detail

getToolTipText

public java.lang.String getToolTipText(java.util.Locale locale,
                                       IExplorationModelObject object)
Returns the text that should be shown as tooltip for this plug-in. Subclasses should override this method to provide a localized text for a short description of their plug-in functionality.
The default implementation returns null.

Specified by:
getToolTipText in interface IPluginActionInfo
Parameters:
locale - Represents the language the text is required for
object - An object from the data model CDA is working on
Returns:
A text or null to indicate that there is no tooltip text

getEnabledIconFilename

public java.lang.String getEnabledIconFilename(IExplorationModelObject object)
Returns the filename of an icon image to that should be shown if the plug-in can be used. The default implementation returns null.

Specified by:
getEnabledIconFilename in interface IPluginActionInfo
Parameters:
object - An object from the data model CDA is working on
Returns:
An filename of a graphics file or null

getDisabledIconFilename

public java.lang.String getDisabledIconFilename(IExplorationModelObject object)
Returns the name of an icon file that should be shown in the UI when the plug-in cannot be used. The default implementation returns null.

Specified by:
getDisabledIconFilename in interface IPluginActionInfo
Parameters:
object - An object from the data model CDA is working on
Returns:
An filename of a graphics file or null