Trigger Class Reference

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

Inheritance diagram for Trigger:

Public Member Functions
void	addAction (Action action)
	Adds an action to the trigger.
void	addCondition (Condition condition)
	Adds an condition to the trigger.
boolean	checkConditions ()
	Checks against all conditions in the trigger.
void	close ()
	Close the object, and release native resources.
void	invokeActions ()
	Invokes actions in the trigger.
Iterable< Action >	iterateActions ()
	Gets an Iterable object used to iterate the Actions.
Iterable< Condition >	iterateConditions ()
	Gets an Iterable object used to iterate the Conditions.
Public Member Functions inherited from NodeComponent
String	getName ()
	Gets the value of #NameProperty.
Node	getNode ()
	Returns the node the node component is attached to or null if node component is not attached to a node.
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.
boolean	isAttached ()
	Indicates whether node component is attached to a node.
boolean	isAttaching ()
	Indicates whether node component is in the process of attaching to a node.
boolean	isAttachingOrAttached ()
	Indicates whether node component is in the process of attaching to a node or already attached.
boolean	isDetached ()
	Indicates whether node component is detached from any node.
boolean	isDetaching ()
	Indicates whether node component currently detaching from the node.
boolean	isDetachingOrDetached ()
	Indicates whether node component is in the process of detaching from the node or already detached.
void	setName (String value)
	Sets the value of #NameProperty.
Public Member Functions inherited from KanziObject
boolean	equals (Object object)
Domain	getDomain ()
	Returns the domain the object belongs to.
Metaclass	getDynamicMetaclass ()
	Returns the metaclass of the dynamic type of the object.
long	getNative ()
	Gets a pointer to the backing C++ instance.
TDataType	getOptionalProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.
TDataType	getProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type.
int	hashCode ()
boolean	hasValue (PropertyType< TDataType > propertyType)
	Evaluates whether there are any inputs into the property value.
boolean	isStale ()
	Test if the object is stale i.e.
void	removeLocalValue (PropertyType< TDataType > propertyType)
	Removes the local value associated with the property.
void	setFlagKeepDuringPatching (PropertyType< TDataType > propertyType)
	Sets the flag to indicate that the property was loaded from KZB.
void	setProperty (PropertyType< TDataType > propertyType, TDataType value)
	Sets the local value of a property type.
ObjectRef< TType >	tryCreateObjectRef (Class< TType > clazz)
	Tries to create an owning ObjectRef instance to this KanziObject.

Static Public Attributes
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from NodeComponent
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from KanziObject
static final Metaclass	metaclass = new AbstractMetaclass("Kanzi.Object")
	The Metaclass for the class.

Protected Member Functions
	Trigger (Domain domain, long handle, Metaclass metaclass)
	Wraps a given native Trigger.
void	attachOverride ()
	Called when the Trigger is attached to a node.
void	detachOverride ()
	Called when a Trigger is detached from a Node.
void	initialize ()
	Initializes the Trigger.
Protected Member Functions inherited from NodeComponent
	NodeComponent (Domain domain, long handle, Metaclass metaclass)
	Wraps a given native Node Component.
void	removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token)
	Removes message handler added via com.rightware.kanzi.NodeComponent#addNodeComponentMessageHandler function.

Static Protected Member Functions
static< Derived extends NodeComponent > ObjectRef< Derived >	createDerived (Domain domain, String name, Metaclass metaclass)
	Creates a derived class instance.

Additional Inherited Members
Public Attributes inherited from NodeComponentMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.NodeComponent")
	Metaclass for NodeComponent.
DynamicPropertyType< String >	NameProperty
	Name.
Public Attributes inherited from TriggerMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.Trigger")
	Metaclass for Trigger.

Detailed Description

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

Constructor & Destructor Documentation

Trigger()

Trigger ( Domain domain, long handle, Metaclass metaclass )

protected

Wraps a given native Trigger.

Called by KanziObject.connectObject(ObjectWrapper) when connecting to a native trigger.

Parameters

domain	UI Domain where this trigger belongs.
handle	Native object that is backing this trigger.
metaclass	Metaclass data for this trigger.

Member Function Documentation

addAction()

void addAction

(

Action

action

)

Adds an action to the trigger.

Parameters

action

The Action to add.

addCondition()

void addCondition

(

Condition

condition

)

Adds an condition to the trigger.

Parameters

condition

The Condition to add.

attachOverride()

void attachOverride ( )

protected

Called when the Trigger is attached to a node.

Reimplemented from NodeComponent.

close()

void close

(

)

Close the object, and release native resources.

Reimplemented from NodeComponent.

createDerived()

static< Derived extends NodeComponent > ObjectRef< Derived > createDerived ( Domain domain, String name, Metaclass metaclass )

staticprotected

Creates a derived class instance.

Call this method as part of the create method for a derived class.

Parameters

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

Returns

An ObjectRef that holds the created instance.

Reimplemented from NodeComponent.

detachOverride()

void detachOverride ( )

protected

Called when a Trigger is detached from a Node.

Reimplemented from NodeComponent.

initialize()

void initialize ( )

protected

Initializes the Trigger.

Reimplemented from NodeComponent.

iterateActions()

Iterable< Action > iterateActions

(

)

Gets an Iterable object used to iterate the Actions.

Returns

An iterable of Actions.

iterateConditions()

Iterable< Condition > iterateConditions

(

)

Gets an Iterable object used to iterate the Conditions.

Returns

An iterable of Conditions.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.TriggerMetadata.metaclass

The Metaclass for the class.