Kanzi 3.9.10
TextInputManipulator Class Reference

The text input manipulator handles key gestures used with TextBox nodes to move the cursor, select text, and delete text, and provides the basics of text editing capabilities in Kanzi. More...

Inheritance diagram for TextInputManipulator:
[legend]

Static Public Member Functions

static ObjectRef< TextInputManipulatorcreate (Domain domain, String name)
 Creates a TextInputManipulator 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 setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type.
 
ObjectRef< TTypetryCreateObjectRef (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 TextInputManipulatorMetadata
DynamicMessageType< TextInputConceptMetadata.TextCompositionStateMessageArguments > CompositionTextChangedMessage
 
DynamicMessageType< TextInputConceptMetadata.TextCompositionStateMessageArguments > CompositionTextCommittedMessage
 
DynamicMessageType< TextInputConceptMetadata.CursorMovedMessageArguments > CursorMovedMessage
 
DynamicMessageType< TextInputConceptMetadata.InputMethodActionMessageArguments > InputMethodActionMessage
 
DynamicMessageType< TextInputConceptMetadata.InputMethodAvailableChangedMessageArguments > InputMethodAvailableChangedMessage
 
DynamicMessageType< TextInputConceptMetadata.InputMethodsDisconnectedMessageArguments > InputMethodsDisconnectedMessage
 
DynamicMessageType< TextInputConceptMetadata.InputTypeChangedMessageArguments > InputTypeChangedMessage
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TextInputManipulator")
 Metaclass for TextInputManipulator.
 
DynamicMessageType< TextInputConceptMetadata.ReadOnlyStateChangedMessageArguments > ReadOnlyStateChangedMessage
 
DynamicMessageType< TextInputConceptMetadata.SelectionChangedMessageArguments > SelectionChangedMessage
 
DynamicMessageType< TextInputConceptMetadata.TextChangedMessageArguments > TextChangedMessage
 
DynamicMessageType< TextInputConceptMetadata.TextCompositionStateMessageArguments > TextCompositionCanceledMessage
 

Detailed Description

The text input manipulator handles key gestures used with TextBox nodes to move the cursor, select text, and delete text, and provides the basics of text editing capabilities in Kanzi.

For example, you can enable the application user to:

Member Function Documentation

◆ create()

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

Creates a TextInputManipulator instance.

Parameters
domainThe domain to which the TextInputManipulator instance belongs.
nameThe name of the input manipulator.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.TextInputManipulatorMetadata.metaclass

The Metaclass for the class.