metadone.client.grasyla2.actions.GAction Class Reference

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

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

List of all members.

Public Member Functions
	GAction (GrasylaEngine engine, String name)
final String	getActionName ()
boolean	fire (UserEvent event)
boolean	cancel (UserEvent event)
Static Public Attributes
static final String	VAR_EVENT = "event"
Package Functions
void	setOnlyThis (boolean b)
Private Member Functions
GrasylaEngine	getEngine (UserEvent event)
GrasylaContext	getContext (GrasylaEngine engine, UserEvent event)
String	execute (GrasylaEngine engine, GrasylaContext context, ConcreteObject next) throws BadPreCondition, ScriptException
Private Attributes
final String	name
final WeakReference < GrasylaEngine >	engine
boolean	onlyThis
Static Private Attributes
static final Logger	logger = Logger.getLogger(GAction.class)

---

Detailed Description

A Grasyla action.

Author:

kma

---

Constructor & Destructor Documentation

metadone.client.grasyla2.actions.GAction.GAction	(	GrasylaEngine	engine,
		String	name
	)

Initializes this action.

Parameters:

engine	The engine
name	The name of the action

References metadone.client.grasyla2.actions.GAction.engine, and metadone.client.grasyla2.actions.GAction.name.

---

Member Function Documentation

boolean metadone.client.grasyla2.actions.GAction.cancel

(

UserEvent

event

)

Checks for cancelling the event.

Parameters:

event

The event

Returns:

true if the event should be cancelled

References metadone.client.grasyla2.actions.GAction.engine, metadone.client.grasyla2.actions.GAction.execute(), metadone.client.grasyla2.GrasylaEngine.getAttributes(), metadone.client.grasyla2.actions.GAction.getContext(), metadone.client.grasyla2.actions.GAction.getEngine(), and metadone.client.grasyla2.actions.GAction.logger.

String metadone.client.grasyla2.actions.GAction.execute	(	GrasylaEngine	engine,
		GrasylaContext	context,
		ConcreteObject	next
	)		throws BadPreCondition, ScriptException [private]

References metadone.client.grasyla2.GrasylaEngine.buildComponent(), metadone.util.Objects.cast(), metadone.client.grasyla2.GrasylaEngine.dispose(), metadone.client.grasyla2.actions.GAction.engine, and metadone.metabusiness.events.Notification.error().

Referenced by metadone.client.grasyla2.actions.GAction.cancel(), and metadone.client.grasyla2.actions.GAction.fire().

boolean metadone.client.grasyla2.actions.GAction.fire

(

UserEvent

event

)

Fires the action for some concrete object.

Parameters:

event

The event

Returns:

Boolean indicating whether the event has been consumed

Implements metadone.client.grasyla2.actions.MetaAction.

References metadone.client.grasyla2.actions.GAction.engine, metadone.client.grasyla2.actions.GAction.execute(), metadone.client.grasyla2.GrasylaEngine.getContainedExpressions(), metadone.client.grasyla2.actions.GAction.getContext(), metadone.client.grasyla2.actions.GAction.getEngine(), and metadone.client.grasyla2.actions.GAction.logger.

final String metadone.client.grasyla2.actions.GAction.getActionName

(

)

Gets the name of the action.

Returns:

The name of the action

References metadone.client.grasyla2.actions.GAction.name.

GrasylaContext metadone.client.grasyla2.actions.GAction.getContext	(	GrasylaEngine	engine,
		UserEvent	event
	)		[private]

References metadone.util.Objects.cast(), metadone.client.grasyla2.GrasylaEngine.getContext(), and metadone.client.grasyla2.actions.GrasylaActionEngine.ActionContext.setEvent().

Referenced by metadone.client.grasyla2.actions.GAction.cancel(), and metadone.client.grasyla2.actions.GAction.fire().

GrasylaEngine metadone.client.grasyla2.actions.GAction.getEngine

(

UserEvent

event

)

[private]

References metadone.client.grasyla2.actions.GAction.engine, metadone.client.grasyla2.actions.UserEvent.getEngine(), metadone.client.grasyla2.GrasylaEngine.getParent(), and metadone.client.grasyla2.actions.GAction.onlyThis.

Referenced by metadone.client.grasyla2.actions.GAction.cancel(), and metadone.client.grasyla2.actions.GAction.fire().

void metadone.client.grasyla2.actions.GAction.setOnlyThis

(

boolean

b

)

[package]

Sets a property telling that only the linked engine can be used.

Parameters:

b	The new value

References metadone.client.grasyla2.actions.GAction.onlyThis.

---

Member Data Documentation

final WeakReference<GrasylaEngine> metadone.client.grasyla2.actions.GAction.engine [private]

Referenced by metadone.client.grasyla2.actions.GAction.cancel(), metadone.client.grasyla2.actions.GAction.execute(), metadone.client.grasyla2.actions.GAction.fire(), metadone.client.grasyla2.actions.GAction.GAction(), and metadone.client.grasyla2.actions.GAction.getEngine().

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

Referenced by metadone.client.grasyla2.actions.GAction.cancel(), and metadone.client.grasyla2.actions.GAction.fire().

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

Referenced by metadone.client.grasyla2.actions.GAction.GAction(), and metadone.client.grasyla2.actions.GAction.getActionName().

boolean metadone.client.grasyla2.actions.GAction.onlyThis [private]

Referenced by metadone.client.grasyla2.actions.GAction.getEngine(), and metadone.client.grasyla2.actions.GAction.setOnlyThis().

final String metadone.client.grasyla2.actions.GAction.VAR_EVENT = "event" [static]

The name of the event variable.

Referenced by metadone.client.grasyla2.value.UpdaterEngine.abortEvaluate(), metadone.client.grasyla2.swing.JMenuValueAdaptor.adapt(), metadone.client.grasyla2.actions.GrasylaActionEngine.ActionContext.getVariable(), metadone.client.grasyla2.actions.GrasylaActionEngine.ActionContext.getVariableContext(), metadone.client.grasyla2.actions.GrasylaActionEngine.ActionContext.initScriptEvaluatorGlobal(), metadone.client.grasyla2.actions.GrasylaActionEngine.ActionContext.setVariable(), metadone.client.grasyla2.value.UpdaterEngine.updateValue(), and metadone.client.grasyla2.value.ValueScriptEngine.ValueScriptEngine().

---

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

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