org.carewebframework.shell.plugins

Class PluginEvent

java.lang.Object

org.fujion.event.Event

org.carewebframework.shell.plugins.PluginEvent

public class PluginEvent
extends org.fujion.event.Event

Event for all plugin-related actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginEvent.PluginAction Actions that may be performed on the container.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
PluginEvent(ElementPlugin plugin, PluginEvent.PluginAction action) Creates an event to encapsulate an action on the specified plugin.
PluginEvent(ElementPlugin plugin, PluginEvent.PluginAction action, Object data) Creates an event to encapsulate an action on the specified plugin.

Method Summary

Modifier and Type	Method and Description
PluginEvent.PluginAction	getAction() Returns the action performed.
ElementPlugin	getPlugin() Returns the plugin upon which the action is performed.

Methods inherited from class org.fujion.event.Event

getCurrentTarget, getData, getPage, getRelatedTarget, getTarget, getTargetId, getType, isStopped, stopPropagation

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

PluginEvent

public PluginEvent(ElementPlugin plugin,
                   PluginEvent.PluginAction action)

Creates an event to encapsulate an action on the specified plugin.

Parameters:

plugin - Plugin receiving the action.

action - The action performed.

PluginEvent

public PluginEvent(ElementPlugin plugin,
                   PluginEvent.PluginAction action,
                   Object data)

Creates an event to encapsulate an action on the specified plugin.

Parameters:

plugin - Plugin receiving the action.

action - The action performed.

data - Arbitrary data to attach.

Method Detail

getAction

public PluginEvent.PluginAction getAction()

Returns the action performed.

Returns:

The plugin action.

getPlugin

public ElementPlugin getPlugin()

Returns the plugin upon which the action is performed.

Returns:

The plugin.