com.sas.actionprovider
Class ActionProviderEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.beans.PropertyChangeEvent
              |
              +--com.sas.collection.ContentsChangedEvent
                    |
                    +--com.sas.actionprovider.ActionProviderEvent

All Implemented Interfaces:

public class ActionProviderEvent

extends ContentsChangedEvent

ActionProviderEvent is fired by HttpActionProvider or SwingActionProvider whenever a command is executed that implements the ContentsChangedInterface and its isContentsChanged() method returns true.

If provided by the command, the eventInfo Map contains information about the commands's previous operation that is specific to the event's source.

A basic understanding of the ActionProvider Framework, of which this class is a part, is recommended before attempting to use this class.

• For general information on the ActionProvider Framework, including an overview of how the primary classes of the framework work together, refer to the com.sas.actionprovider package documentation.

• For examples demonstrating how to use the ActionProvider Framework, including how to override default Actions or add new custom Actions, refer to the ActionProvider Framework Examples Site. You will initially see a subset of examples relating to this framework. You can search for other types of examples as needed.

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

Since:

3.0

See Also:

HttpActionProvider.fireContentsChanged(com.sas.actionprovider.ActionProviderEvent), SwingActionProvider.fireContentsChanged(com.sas.actionprovider.ActionProviderEvent), ContentsChangedInterface, Serialized Form

Field Summary

protected Map

eventInfo The map containing information about the operation that was performed on the event's source.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ActionProviderEvent(Object source)
Source Constructor

ActionProviderEvent(Object source, Map eventInfo)
Source and eventInfo Constructor

Method Summary

Map	getEventInfo() Returns the map containing information about the operation that was performed on the event's source.
void	setEventInfo(Map eventInfo) Sets the the map containing information about the operation that was performed on the event's source.

Methods inherited from class com.sas.collection.ContentsChangedEvent

clone

Methods inherited from class java.beans.PropertyChangeEvent

getNewValue, getOldValue, getPropagationId, getPropertyName, setPropagationId

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

eventInfo

protected Map eventInfo

The map containing information about the operation that was performed on the event's source.

Constructor Detail

ActionProviderEvent

public ActionProviderEvent(Object source)

Source Constructor

Parameters:

source - The object on which the operation took place.

ActionProviderEvent

public ActionProviderEvent(Object source,
                           Map eventInfo)

Source and eventInfo Constructor

Parameters:

source - The object on which the operation took place.

eventInfo - The map containing information about the operation that was performed on the event's source.

Method Detail

getEventInfo

public Map getEventInfo()

Returns the map containing information about the operation that was performed on the event's source.

The map contains information from the executed command.

Returns:

The map containing information about the operation that was performed on the event's source.

See Also:

setEventInfo(java.util.Map)

setEventInfo

public void setEventInfo(Map eventInfo)

Sets the the map containing information about the operation that was performed on the event's source.

Parameters:

eventInfo - The map containing information about the operation that was performed on the event's source.

See Also:

getEventInfo()