org.openbp.jaspira.gui.interaction
Class BreakoutEvent

java.lang.Object
  java.util.EventObject
      org.openbp.jaspira.event.JaspiraEvent
          org.openbp.jaspira.gui.interaction.BreakoutEvent

All Implemented Interfaces:

java.io.Serializable

public class BreakoutEvent
extends JaspiraEvent

The event is sent if a break out menu has to be shown and a provider is needed. Any event receiver that feels responsible for the given break out key should set the provider accordingly.

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

BreakoutEvent(Plugin source, int key)
Constructor.

Method Summary

int	getKey() Returns the key that was pressed.
BreakoutProvider	getProvider() Returns the provider.
void	setProvider(BreakoutProvider bop) Sets the provider.

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

BreakoutEvent

public BreakoutEvent(Plugin source,
                     int key)

Constructor.

Parameters:

source - Source plugin of the event

key - Key that was pressed to initiate the break out mode

Method Detail

getKey

public int getKey()

Returns the key that was pressed.

setProvider

public void setProvider(BreakoutProvider bop)

Sets the provider. This will also consume the event since the job is done here.

Parameters:

bop - Provider that is suitable of the given key

getProvider

public BreakoutProvider getProvider()

Returns the provider.

Returns:

The provider or null if no event listener has set a provider