Trigger is the base class for defining events, conditions and actions for content-driven logic programming. More...

Inheritance diagram for Trigger:

Collaboration diagram for Trigger:

Public Member Functions
void	addAction (Action action)
	Adds an action to the trigger. More...

void	addCondition (Condition condition)
	Adds an condition to the trigger. More...

boolean	checkConditions ()
	Checks against all conditions in the trigger.

void	close ()
	Immediately releases the ownership of the backing native object, as opposed to deferring to garbage collection.

void	invokeActions ()
	Invokes actions in the trigger.

Iterable< Action >	iterateActions ()
	Gets an Iterable object used to iterate the Actions. More...

Iterable< Condition >	iterateConditions ()
	Gets an Iterable object used to iterate the Conditions. More...

Public Member Functions inherited from NodeComponent
String	getName ()
	Gets the value of #NameProperty. More...

Node	getNode ()
	Returns the node the node component is attached to or null if node component is not attached to a node. More...

NodeComponentState	getState ()
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...

boolean	isAttached ()
	Indicates whether node component is attached to a node. More...

boolean	isAttaching ()
	Indicates whether node component is in the process of attaching to a node. More...

boolean	isAttachingOrAttached ()
	Indicates whether node component is in the process of attaching to a node or already attached. More...

boolean	isDetached ()
	Indicates whether node component is detached from any node. More...

boolean	isDetaching ()
	Indicates whether node component currently detaching from the node. More...

boolean	isDetachingOrDetached ()
	Indicates whether node component is in the process of detaching from the node or already detached. More...

void	setName (String value)
	Sets the value of #NameProperty. 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 NodeComponent
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
	Trigger (Domain domain, String name, Metaclass metaclass)
	Creates a new trigger of a type derived from Trigger. More...

void	attachOverride ()
	Called when the Trigger is attached to a node.

void	detachOverride ()
	Called when a Trigger is detached from a Node.

Protected Member Functions inherited from NodeComponent
	NodeComponent (Domain domain, String name, Metaclass metaclass)
	Creates a new nodeComponent of a type derived from NodeComponent. More...

Node.MessageSubscriptionToken	addNodeComponentMessageHandler (MessageType messageType, Node.MessageSubscriptionFunction messageHandlerFunction)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...

void	attachOverride ()
	Called when the Trigger is attached to a node.

void	detachOverride ()
	Called when a Trigger is detached from a Node.

void	dispatchMessage (MessageType messageType, MessageArguments arguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...

void	removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token)
	Removes message handler added via NodeComponent#addNodeComponentMessageHandler function. More...

Additional Inherited Members
Public Attributes inherited from NodeComponent
DynamicPropertyType< String >	NameProperty

AbstractMetaclass	NodeComponentMetaclass = new AbstractMetaclass("Kanzi.NodeComponent")

Public Attributes inherited from Trigger
AbstractMetaclass	TriggerMetaclass = new AbstractMetaclass("Kanzi.Trigger")

Detailed Description

Trigger is the base class for defining events, conditions and actions for content-driven logic programming.

Constructor & Destructor Documentation

Trigger	(	Domain	domain,
		String	name,
		Metaclass	metaclass
	)

protected

Creates a new trigger of a type derived from Trigger.

Call this from constructor of your custom Trigger derivation.

Parameters

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

Member Function Documentation

void addAction ( Action action )

Adds an action to the trigger.

Parameters

action The Action to add.

void addCondition ( Condition condition )

Adds an condition to the trigger.

Parameters

condition The Condition to add.

static Metaclass getStaticMetaclass ( )

static

Returns the metaclass of this class.

Returns: Static instance of metaclass of this Trigger.

Iterable<Action> iterateActions ( )

Gets an Iterable object used to iterate the Actions.

Returns: An iterable of Actions.

Iterable<Condition> iterateConditions ( )

Gets an Iterable object used to iterate the Conditions.

Returns: An iterable of Conditions.


Kanzi Java API

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation