org.openbp.jaspira.action
Class JaspiraActionEvent

java.lang.Object
  java.util.EventObject
      org.openbp.jaspira.event.JaspiraEvent
          org.openbp.jaspira.action.JaspiraActionEvent

All Implemented Interfaces:

java.awt.datatransfer.Transferable, java.io.Serializable

public class JaspiraActionEvent
extends JaspiraEvent
implements java.awt.datatransfer.Transferable

Event fired by JaspiraAction objects.

Author:

Stephan Moritz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openbp.jaspira.event.JaspiraEvent

CONSUMED, HANDELED, STACKABLE, TYPE_BOTTOM_UP, TYPE_DIRECT, TYPE_FLOOD, TYPE_GLOBAL, UNCONSUMABLE

Fields inherited from class java.util.EventObject

source

Constructor Summary

JaspiraActionEvent(Plugin source, java.lang.String eventName, java.awt.event.ActionEvent actionEvent, int level)
Constructor.

JaspiraActionEvent(Plugin source, java.lang.String eventName, int level)
Constructor.

JaspiraActionEvent(Plugin source, java.lang.String eventName, java.awt.datatransfer.Transferable transferable, int level, java.awt.event.ActionEvent actionEvent)
Constructor.

Method Summary

java.awt.event.ActionEvent	getActionEvent() Gets the underylying original action event.
java.lang.Object	getSafeTransferData(java.awt.datatransfer.DataFlavor flavor) Gets the transfer data in the desired format (convenience method that supresses exceptions).
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor)
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors()
boolean	hasTransferable() Returns true if this event carries a transferable.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Methods inherited from class org.openbp.jaspira.event.JaspiraEvent

brand, getBrand, getEventGroup, getEventName, getFlags, getLevel, getObject, getOriginalEvent, getSourcePlugin, getTargetClassName, getTargetPluginId, getType, isConsumed, isStackable, isUnconsumable, setObject, setTargetClassName, setTargetPluginId, toString, updateFlags, updateFlags

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

JaspiraActionEvent

public JaspiraActionEvent(Plugin source,
                          java.lang.String eventName,
                          java.awt.datatransfer.Transferable transferable,
                          int level,
                          java.awt.event.ActionEvent actionEvent)

Constructor.

Parameters:

source - Plugin the event originated from

eventName - Name of the event

transferable - Optional transferable this event refers to

level - Event level (see JaspiraEvent.getLevel())

actionEvent - Underylying original action event

JaspiraActionEvent

public JaspiraActionEvent(Plugin source,
                          java.lang.String eventName,
                          java.awt.event.ActionEvent actionEvent,
                          int level)

Constructor.

Parameters:

source - Plugin the event originated from

eventName - Name of the event

actionEvent - Underylying original action event

level - Event level (see JaspiraEvent.getLevel())

JaspiraActionEvent

public JaspiraActionEvent(Plugin source,
                          java.lang.String eventName,
                          int level)

Constructor.

Parameters:

source - Plugin the event originated from

eventName - Name of the event

level - Event level (see JaspiraEvent.getLevel())

Method Detail

getActionEvent

public java.awt.event.ActionEvent getActionEvent()

Gets the underylying original action event.

hasTransferable

public boolean hasTransferable()

Returns true if this event carries a transferable.

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Throws:

java.awt.datatransfer.UnsupportedFlavorException

java.io.IOException

See Also:

Transferable.getTransferData(DataFlavor)

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

See Also:

Transferable.getTransferDataFlavors()

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

See Also:

Transferable.isDataFlavorSupported(DataFlavor)

getSafeTransferData

public java.lang.Object getSafeTransferData(java.awt.datatransfer.DataFlavor flavor)

Gets the transfer data in the desired format (convenience method that supresses exceptions). You should call this method only if have previously checked if the flavor is supported by calling isDataFlavorSupported(java.awt.datatransfer.DataFlavor).

Parameters:

flavor - Flavor to get

Returns:

The desired object or null if the flavor is not supported or an i/o error has occurred. In the latter case, the method prints a stack trace to stderr.