Action Class Reference

Actions are small operations that Kanzi executes when the trigger event that contains that action occurs and the trigger conditions are met. More...

Inheritance diagram for Action:

Collaboration diagram for Action:

Public Member Functions
void	close ()
	Immediately releases the ownership of the backing native object, as opposed to deferring to garbage collection.
Duration	getDelay ()
	Returns the delay that Kanzi waits before it invokes an action. More...
Trigger	getTrigger ()
	Returns the pointer to a trigger to which an action is attached. More...
void	invoke ()
	Invokes the action.
void	setDelay (Duration duration)
	Sets the delay that Kanzi waits before it invokes an action. More...
Public Member Functions inherited from ActionBase
String	getName ()
	Gets the name of an action. More...
Public Member Functions inherited from KanziObject
boolean	equals (Object object)
Domain	getDomain ()
	Returns the domain the object belongs to. More...
Metaclass	getDynamicMetaclass ()
	Returns the metaclass of the dynamic type of the object. More...
boolean	isStale ()
	Test if the object is stale i.e. More...
void	releaseOwnership ()
	Release ownership of the backing native object from this object. More...
void	removeLocalValue (PropertyType propertyType)
	Removes the local value associated with the property. More...
boolean	takeOwnership ()
	Take ownership of the backing native object in this object. More...

Static Public Member Functions
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...
Static Public Member Functions inherited from ActionBase
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...
Static Public Member Functions inherited from KanziObject
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...

Protected Member Functions
	Action (Domain domain, String name, Metaclass metaclass)
	Creates a new action of a type derived from Action. More...
void	onAttach ()
	Callback called by Kanzi during attach.
void	onDelayedInvoke ()
	Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires. More...
void	onDetach ()
	Callback called by Kanzi during detach.
void	onInvoke ()
	Callback called by Kanzi when the action is invoked by its trigger without delay. More...
void	onPrepareDelayedInvoke ()
	Callback called by Kanzi when the action is invoked by its trigger with delay. More...
void	onUnprepareDelayedInvoke ()
	Kanzi calls this callback when an action is invoked by trigger with delay, after Action#onDelayedInvoke() callback, or when it cancels a delayed execution. More...

Additional Inherited Members
Public Attributes inherited from ActionBase
AbstractMetaclass	ActionBaseMetaclass = new AbstractMetaclass("Kanzi.ActionBase")
Public Attributes inherited from Action
AbstractMetaclass	ActionMetaclass = new AbstractMetaclass("Kanzi.Action")
DynamicPropertyType< Integer >	DelayProperty

Detailed Description

Actions are small operations that Kanzi executes when the trigger event that contains that action occurs and the trigger conditions are met.

Action is the base class for actions. For example, if you want to perform a simple operation, such as set a value of a property, you can use a trigger with the SetPropertyAction action.

Kanzi provides a number of built-in action classes, such as SetPropertyAction that you can use to set the value of a property of a target node, and DispatchMessageAction that you can use to dispatch a message of specified type to a specified target. However, Kanzi also enables you to define your own actions by deriving from the Action class.

When you want to create an action that receives arguments of its triggering message or properties of a node, derive that action from the ForwardingAction class, which provides generic functionality for this purpose.

You can delay the invocation of an action by the amount of time that you set in the com.rightware.kanzi.metadata.Action#DelayProperty

Constructor & Destructor Documentation

Action ( Domain  domain, String  name, Metaclass  metaclass  )

protected

Creates a new action of a type derived from Action.

Call this from constructor of your custom Action derivation.

Parameters

domain	UI Domain where this action belongs.
name	Name of the action.
metaclass	Metaclass data for this action.

Member Function Documentation

Duration getDelay

(

)

Returns the delay that Kanzi waits before it invokes an action.

You can set the delay in milliseconds with the Action#DelayProperty.

Returns

Delay for the action

static Metaclass getStaticMetaclass ( )

static

Returns the metaclass of this class.

Returns

Static instance of metaclass of this Action.

Trigger getTrigger

(

)

Returns the pointer to a trigger to which an action is attached.

Returns

The attached trigger.

void onDelayedInvoke ( )

protected

Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires.

Use this to execute an action with delay.

void onInvoke ( )

protected

Callback called by Kanzi when the action is invoked by its trigger without delay.

Use this to execute an action without delay.

void onPrepareDelayedInvoke ( )

protected

Callback called by Kanzi when the action is invoked by its trigger with delay.

Use this to prepare for delayed execution.

void onUnprepareDelayedInvoke ( )

protected

Kanzi calls this callback when an action is invoked by trigger with delay, after Action#onDelayedInvoke() callback, or when it cancels a delayed execution.

An example of cancellation of delayed execution is when you detach the action before the execution is done. Use this function to roll back any preparations made for a delayed execution.

void setDelay

(

Duration

duration

)

Sets the delay that Kanzi waits before it invokes an action.

Parameters

duration

The delay for invoking the action.