metadone.client.grasyla2.actions.UserEvent Class Reference

Inheritance diagram for metadone.client.grasyla2.actions.UserEvent:

Collaboration diagram for metadone.client.grasyla2.actions.UserEvent:

List of all members.

Public Member Functions
	UserEvent (GrasylaEngine engine, Object source, String name)
final GrasylaEngine	getEngine ()
Object	getSource ()
final String	getName ()
final boolean	hasName (String name)
void	cancel ()
boolean	isCancelled ()
final MetaActionChain	getActions ()
final boolean	trigger (boolean fire)
boolean	fire ()
String	toString ()
Static Public Attributes
static final MapFct< UserEvent, String >	getEventName
Private Attributes
final Object	source
final String	name
boolean	cancelled
MetaActionChain	chain
Static Private Attributes
static final Logger	logger = Logger.getLogger(UserEvent.class)

---

Detailed Description

A user event.

Author:

kma

---

Constructor & Destructor Documentation

metadone.client.grasyla2.actions.UserEvent.UserEvent	(	GrasylaEngine	engine,
		Object	source,
		String	name
	)

Initializes this event.

Parameters:

engine	The engine
source	The source
name	The name

Exceptions:

IllegalArgumentException

if there is no name

References metadone.client.grasyla2.actions.UserEvent.name, and metadone.client.grasyla2.actions.UserEvent.source.

---

Member Function Documentation

void metadone.client.grasyla2.actions.UserEvent.cancel

(

)

Cancels the event.

References metadone.client.grasyla2.actions.UserEvent.cancelled.

Referenced by metadone.client.grasyla2.actions.UserEvent.fire().

boolean metadone.client.grasyla2.actions.UserEvent.fire

(

)

Fires the user event.

Returns:

true if the event was consumed

References metadone.client.grasyla2.actions.UserEvent.cancel(), metadone.client.grasyla2.actions.UserEvent.chain, metadone.client.grasyla2.actions.MetaActionChain.fire(), metadone.client.grasyla2.actions.UserEvent.isCancelled(), and metadone.client.grasyla2.actions.UserEvent.logger.

Referenced by metadone.client.grasyla2.visuallibrary.GrasylaScene.MyConnectProvider.createConnection(), metadone.client.grasyla2.swing.GrasylaSwingHelper.GrasylaMouseListener.popupCheck(), and metadone.client.grasyla2.actions.UserEvent.trigger().

final MetaActionChain metadone.client.grasyla2.actions.UserEvent.getActions

(

)

Gets the chain of actions.

Returns:

The chain of actions

References metadone.client.grasyla2.actions.UserEvent.chain.

final GrasylaEngine metadone.client.grasyla2.actions.UserEvent.getEngine

(

)

Returns the engine.

Returns:

The engine

Reimplemented from metadone.client.display.EngineEvent.

Referenced by metadone.client.grasyla2.actions.GAction.getEngine(), metadone.client.grasyla2.actions.UserConnectEvent.getSourceEngine(), metadone.client.grasyla2.actions.UserEvent.toString(), metadone.client.MetadoneDesktopPane.ContextMenuSubscriber.trigger(), metadone.client.grasyla2.visuallibrary.GraphEngine.trigger(), and metadone.client.grasyla2.actions.UserEvent.trigger().

final String metadone.client.grasyla2.actions.UserEvent.getName

(

)

Gets the name.

Returns:

The name

References metadone.client.grasyla2.actions.UserEvent.name.

Referenced by metadone.client.grasyla2.actions.GrasylaActionAttributeHandler.handle(), and metadone.client.grasyla2.actions.UserEvent.toString().

Object metadone.client.grasyla2.actions.UserEvent.getSource

(

)

Implements metadone.publish_subscribe.Event.

Reimplemented in metadone.client.grasyla2.actions.UserConnectEvent.

References metadone.client.grasyla2.actions.UserEvent.source.

Referenced by metadone.client.grasyla2.visuallibrary.GraphEngine.trigger().

final boolean metadone.client.grasyla2.actions.UserEvent.hasName

(

String

name

)

Checks whether the event has a given name.

Parameters:

name

The name

Returns:

true iff the event has a name

References metadone.util.Objects.equal().

boolean metadone.client.grasyla2.actions.UserEvent.isCancelled

(

)

Indicates whether the event is cancelled.

Returns:

true iff the event is cancelled

References metadone.client.grasyla2.actions.UserEvent.cancelled.

Referenced by metadone.client.grasyla2.actions.UserEvent.fire(), metadone.client.grasyla2.actions.UserEvent.toString(), and metadone.client.grasyla2.GrasylaEngine.trigger().

String metadone.client.grasyla2.actions.UserEvent.toString

(

)

References metadone.client.grasyla2.actions.UserEvent.getEngine(), metadone.client.grasyla2.actions.UserEvent.getName(), and metadone.client.grasyla2.actions.UserEvent.isCancelled().

final boolean metadone.client.grasyla2.actions.UserEvent.trigger

(

boolean

fire

)

Triggers this event.

Parameters:

fire	Whether to fire the event

Returns:

If fire is true, it is result of fire(), otherwise the result is false

References metadone.client.grasyla2.actions.UserEvent.fire(), metadone.client.grasyla2.actions.UserEvent.getEngine(), and metadone.client.grasyla2.GrasylaEngine.trigger().

Referenced by metadone.client.grasyla2.swing.JButtonEngine.evaluateComponent(), metadone.client.grasyla2.visuallibrary.GrasylaScene.MyPopupProvider.getPopupMenu(), metadone.client.grasyla2.visuallibrary.GrasylaScene.MyClickAction.mouseClicked(), metadone.client.grasyla2.swing.GrasylaSwingHelper.GrasylaMouseListener.mouseClicked(), and metadone.client.grasyla2.swing.JMenuItemEngine.registerEventHandler().

---

Member Data Documentation

boolean metadone.client.grasyla2.actions.UserEvent.cancelled [private]

Referenced by metadone.client.grasyla2.actions.UserEvent.cancel(), and metadone.client.grasyla2.actions.UserEvent.isCancelled().

MetaActionChain metadone.client.grasyla2.actions.UserEvent.chain [private]

Referenced by metadone.client.grasyla2.actions.UserEvent.fire(), and metadone.client.grasyla2.actions.UserEvent.getActions().

final MapFct<UserEvent, String> metadone.client.grasyla2.actions.UserEvent.getEventName [static]

Initial value:

 new MapFct<UserEvent, String>() {
        @Override
        public String map(UserEvent a) {
            return a.getName();
        }
    }

Gets the first name of an event.

final Logger metadone.client.grasyla2.actions.UserEvent.logger = Logger.getLogger(UserEvent.class) [static, private]

Referenced by metadone.client.grasyla2.actions.UserEvent.fire().

final String metadone.client.grasyla2.actions.UserEvent.name [private]

Referenced by metadone.client.grasyla2.actions.UserEvent.getName(), and metadone.client.grasyla2.actions.UserEvent.UserEvent().

final Object metadone.client.grasyla2.actions.UserEvent.source [private]

Referenced by metadone.client.grasyla2.actions.ContextMenuEvent.ContextMenuEvent(), metadone.client.grasyla2.actions.UserEvent.getSource(), metadone.client.grasyla2.actions.UserConnectEvent.initRoles(), metadone.client.grasyla2.actions.UserConnectEvent.UserConnectEvent(), and metadone.client.grasyla2.actions.UserEvent.UserEvent().

---

The documentation for this class was generated from the following file:

• metadone_bundle_client/src/metadone/client/grasyla2/actions/UserEvent.java