org.openbp.jaspira.event
Class InteractionEvent

java.lang.Object
  java.util.EventObject
      org.openbp.jaspira.event.JaspiraEvent
          org.openbp.jaspira.event.InteractionEvent

All Implemented Interfaces:

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

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

Event that is sent before a popup menu is shown. Provides methods for plugins to add their own entries.

Author:

Stephan Moritz

See Also:

Serialized Form

Field Summary

static java.lang.String	EVENTBASE Event base name for interaction events
static java.lang.String	MENU Event name for menu events
static java.lang.String	POPUP Event name for popupevents
static java.lang.String	TOOLBAR Event name for toolbar events

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

InteractionEvent(Plugin source, java.lang.String type, java.lang.Object o)
Constructor.

InteractionEvent(Plugin source, java.lang.String type, java.awt.datatransfer.Transferable transferable)
Constructor.

Method Summary

void	add(JaspiraAction action) Adds a Jaspria action (which can be an actual action, a group or a submenu) to the popup menu.
JaspiraPopupMenu	createPopupMenu() Generates a menu from of the given entries.
JaspiraToolbar	createToolbar() Generates a toolbar from of the given entries.
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	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

Field Detail

EVENTBASE

public static final java.lang.String EVENTBASE

Event base name for interaction events

See Also:

Constant Field Values

POPUP

public static final java.lang.String POPUP

Event name for popupevents

See Also:

Constant Field Values

MENU

public static final java.lang.String MENU

Event name for menu events

See Also:

Constant Field Values

TOOLBAR

public static final java.lang.String TOOLBAR

Event name for toolbar events

See Also:

Constant Field Values

Constructor Detail

InteractionEvent

public InteractionEvent(Plugin source,
                        java.lang.String type,
                        java.awt.datatransfer.Transferable transferable)

Constructor.

Parameters:

source - Source plugin

type - POPUP/MENU/TOOLBAR

transferable - Transferable argument

InteractionEvent

public InteractionEvent(Plugin source,
                        java.lang.String type,
                        java.lang.Object o)

Constructor.

Parameters:

source - Source plugin

type - POPUP/MENU/TOOLBAR

o - Arbitrary event argument

Method Detail

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.

add

public void add(JaspiraAction action)

Adds a Jaspria action (which can be an actual action, a group or a submenu) to the popup menu.

Parameters:

action - Action to add

createPopupMenu

public JaspiraPopupMenu createPopupMenu()

Generates a menu from of the given entries.

Returns:

The menu or null if no entries have been added to the interaction event

createToolbar

public JaspiraToolbar createToolbar()

Generates a toolbar from of the given entries.

Returns:

The toolbar or null if no entries have been added to the interaction event