All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Components |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sas.actionprovider
Class ActionProviderEvent

    com.sas.actionprovider.ActionProviderEvent

All Implemented Interfaces:
  java.io.Serializable, java.lang.Cloneable

    public class ActionProviderEvent

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 Samples Site.

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 java.util.Map` | `eventInfo` The map containing information about the operation that was performed on the event's source.

Constructor Summary
`ActionProviderEvent(java.lang.Object source)` Source Constructor
`ActionProviderEvent(java.lang.Object source, java.util.Map eventInfo)` Source and eventInfo Constructor

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

Field Detail

### eventInfo

    protected java.util.Map eventInfo

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

Constructor Detail

### ActionProviderEvent

    public ActionProviderEvent(java.lang.Object source)

  Source Constructor

  Parameters:
    `source` - The object on which the operation took place.

### ActionProviderEvent

    public ActionProviderEvent(java.lang.Object source,
                               java.util.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 java.util.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(java.util.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()`

All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Components |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2009 SAS Institute Inc. All Rights Reserved.