Class AbstractActionListener

Abstract class for 'ActionListener' classes.

Build Information

Author Fred McGuirk
Date Feb 9, 2007
Outputfile AbstractActionListener.pvc
Forcelinenumbers false

Constructor

This is an abstract class for all event manager observers.

ParameterDescription
init_pvxConstants A reference to [ProvideX Class:pvxConstants] object
initViewManager A reference to [Java Class:views/UIManager] object

Properties

No Properties

Methods

FUNCTION actionPerformed(inActionEventID)

This method will be called when the 'Run' action is triggered from the contributed tools menu. The code associated with this observer must be executed by this method; this code can be the logic for this method or can be in an external program that is accessable in the environment where this observer will be used.


ParameterDescription
inActionEventID This is a reference to [Java Class:eventmanager/ExtCommand]
FUNCTION configPerformed(inActionEventID)

This method will be called when the 'Configure' action is triggered from the contributed tools menu. The code required to implement the configuration action is normally implemented as one or more NOMADS panels that this method will execute.


ParameterDescription
inActionEventID This is a reference to [Java Class:eventmanager/ExtCommand]
FUNCTION getDescription$()

This method is used to describe the purpose of this observer. The text will be placed on the observers preference page to describe the purpose of this observer. This description should be limited to no more than 80 characters.

FUNCTION getEventNotificationFlag()

Get the flag that will be used to trigger the 'update()' method during execution of the built-in events for the plug-in.


If this observer is not a Post-process observer, the return value of this method should be set to one of the following values:

ValueDescription
_pvxConstants'_ideNone Do not register as an observer
_pvxConstants'_idePreProcess Register as a Pre-Process observer
_pvxConstants'_idePrePostProcess Register as both a Pre-Process and Post-Process observer.
_pvxConstants'_idePostProcess Register as a Post-Process observer
FUNCTION init()

Register this class as an event listener and add it to the list of contributed tools under the ProvideX menu item.