ApplyPropertyAction Class Reference

An ApplyPropertyAction sets a property to the requested value for as long as the condition is met in the DataTrigger that sets off this action. More...

Inheritance diagram for ApplyPropertyAction:

Static Public Member Functions
static ObjectRef< ApplyPropertyAction >	create (Domain domain, String name)
	Creates an instance of ApplyPropertyAction.

Static Public Attributes
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from ApplyAction
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from ActionBase
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.

Additional Inherited Members
Public Member Functions inherited from ActionBase
String	getName ()
	Gets the name of an action.
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	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.
Public Attributes inherited from ActionBaseMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.ActionBase")
	Metaclass for ActionBase.
Public Attributes inherited from ApplyActionMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.ApplyAction")
	Metaclass for ApplyAction.
Public Attributes inherited from ApplyPropertyActionMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.ApplyPropertyAction")
	Metaclass for ApplyPropertyAction.
DynamicPropertyType< String >	TargetPathProperty
	Sets the path to the Node or the Render Pass that contains the target property.

Detailed Description

An ApplyPropertyAction sets a property to the requested value for as long as the condition is met in the DataTrigger that sets off this action.

When the trigger condition is no longer met, Kanzi rolls back the value of that property to the value before the action was applied, or to the value set while Kanzi was applying an ApplyPropertyAction. Use the ApplyPropertyAction only with a DataTrigger.

Member Function Documentation

create()

static ObjectRef< ApplyPropertyAction > create ( Domain domain, String name )

static

Creates an instance of ApplyPropertyAction.

Parameters

domain	Pointer to domain.
name	Name of this action instance.

Returns

handle to the created ApplyPropertyAction instance.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.ApplyPropertyActionMetadata.metaclass

The Metaclass for the class.