KeyManipulator Class Reference

KeyManipulator class is a key input manipulator that detects key gestures. More...

Inheritance diagram for KeyManipulator:

Static Public Member Functions
static ObjectRef< KeyManipulator >	create (Domain domain, LogicalKey key, KeyModifier modifier, String anonymous)
	Convenience function, creates a KeyManipulator with the logical key and key modifier.
static ObjectRef< KeyManipulator >	create (Domain domain, String anonymous)
	Creates a KeyManipulator instance.

Static Public Attributes
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from InputManipulator
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 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.
Public Attributes inherited from InputManipulatorMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.InputManipulator")
	Metaclass for InputManipulator.
Public Attributes inherited from KeyManipulatorMetadata
DynamicMessageType< KeyManipulatorMetadata.KeyCanceledMessageArguments >	KeyCanceledMessage
	Occurs when Kanzi recognizes a key-canceled gesture.
DynamicMessageType< KeyManipulatorMetadata.KeyPressedMessageArguments >	KeyPressedMessage
	Occurs when Kanzi recognizes a key-pressed gesture.
DynamicMessageType< KeyManipulatorMetadata.KeyReleasedMessageArguments >	KeyReleasedMessage
	Occurs when Kanzi recognizes a key-released gesture.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.KeyManipulator")
	Metaclass for KeyManipulator.

Detailed Description

KeyManipulator class is a key input manipulator that detects key gestures.

Kanzi recognizes a key gesture when it receives an event with a key code and an optional key modifier. When Kanzi recognizes a key gesture, an input manipulator: key modifiers.

Member Function Documentation

create() [1/2]

static ObjectRef< KeyManipulator > create ( Domain domain, LogicalKey key, KeyModifier modifier, String anonymous )

static

Convenience function, creates a KeyManipulator with the logical key and key modifier.

Parameters

domain	The domain to which the KeyManipulator instance belongs.
key	The logical key value to handle.
modifier	The key modifiers to handle. If no modifier is required, pass KeyModifier.Undefined.

create() [2/2]

static ObjectRef< KeyManipulator > create ( Domain domain, String anonymous )

static

Creates a KeyManipulator instance.

Parameters

domain

The domain to which the KeyManipulator instance belongs.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.KeyManipulatorMetadata.metaclass

The Metaclass for the class.