ilog.views.appframe.plugin
Class PluginEvent

java.lang.Object
  java.util.EventObject
      ilog.views.appframe.plugin.PluginEvent

All Implemented Interfaces:

Serializable

public class PluginEvent
extends EventObject

The plug-in event emitted by the plug-in manager when a plug-in event occurs.

See Also:

Serialized Form

Field Summary

static int	PLUGIN_EXCEPTION_THROWN This event indicates that an exception was raised while installing or uninstalling a plug-in.
static int	PLUGIN_FIRST The first number in the range of IDs used for plug-in events.
static int	PLUGIN_INSTALLED This event indicates that a plug-in has been installed.
static int	PLUGIN_LAST The last number in the range of IDs used for plug-in events.
static int	PLUGIN_UNINSTALLED This event indicates that a plug-in has been uninstalled.

Fields inherited from class java.util.EventObject

source

Method Summary

IlvApplication	getApplication() Returns the host application to install the plug-in in.
IlvPluginException	getException() Returns the exception that was raised while installing or uninstalling the plugin associated with this event.
int	getID() Returns the event type.
IlvPlugin	getPlugin() Returns the plug-in originator of the event.

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

PLUGIN_FIRST

public static final int PLUGIN_FIRST

The first number in the range of IDs used for plug-in events.

See Also:

Constant Field Values

PLUGIN_EXCEPTION_THROWN

public static final int PLUGIN_EXCEPTION_THROWN

This event indicates that an exception was raised while installing or uninstalling a plug-in.

See Also:

getException(), Constant Field Values

PLUGIN_INSTALLED

public static final int PLUGIN_INSTALLED

This event indicates that a plug-in has been installed.

See Also:

Constant Field Values

PLUGIN_UNINSTALLED

public static final int PLUGIN_UNINSTALLED

This event indicates that a plug-in has been uninstalled.

See Also:

Constant Field Values

PLUGIN_LAST

public static final int PLUGIN_LAST

The last number in the range of IDs used for plug-in events.

See Also:

Constant Field Values

Method Detail

getPlugin

public IlvPlugin getPlugin()

Returns the plug-in originator of the event.

getID

public int getID()

Returns the event type.

getApplication

public IlvApplication getApplication()

Returns the host application to install the plug-in in.

Returns:

The application.

getException

public IlvPluginException getException()

Returns the exception that was raised while installing or uninstalling the plugin associated with this event. If the ID of this event equals PLUGIN_EXCEPTION_THROWN, this method returns a non null exception. Otherwise, this method returns null.