Class XMItoPvxAction

This is an example of a listener for an external action.

Build Information

Author Jarett Smith
Date Feb 20, 2007
Outputfile XMItoPvxAction.pvc
Forcelinenumbers false

Properties

No Properties

Methods

FUNCTION actionPerformed(inActionEventID)

This method will be called when the action is triggered from the contributed tools menu.


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 and should be limited to 80 characters (at most).

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.

FUNCTION update(initPvxState)

The logic to be executed when the observer is triggered. This logic must check the major and minor codes to determine the current event and then decide what action is to be performed.


ParameterDescription
state A reference to an object of class [ProvideX Class:PvxState]

Methods inherited from: AbstractActionListener

actionPerformed(), configPerformed(), getDescription$(), getEventNotificationFlag(), init()

Methods inherited from: EventManagerObserver

getDescription$(), getEventNotificationFlag(), init(), update()