Kanzi  3.9.6
Java API
NavigationManipulatorComponent Class Reference

Enables the node to react to navigation key input events. More...

Inheritance diagram for NavigationManipulatorComponent:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new NavigationManipulatorComponent. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from NodeComponent
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- 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 NodeComponent
void close ()
 Close the object, and release native resources.
 
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...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
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. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. More...
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject. More...
 
- Public Attributes inherited from NodeComponentMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NodeComponent")
 Metaclass for NodeComponent.
 
DynamicPropertyType< String > NameProperty
 Name. More...
 
- Public Attributes inherited from NavigationManipulatorComponentMetadata
DynamicPropertyType< Integer > DownNavigationKeyModifierProperty
 Sets the key modifiers of the down navigation. More...
 
DynamicPropertyType< Integer > DownNavigationKeyProperty
 Sets the logical key value of the down navigation. More...
 
DynamicPropertyType< Integer > EndNavigationKeyModifierProperty
 Sets the key modifiers of the end navigation. More...
 
DynamicPropertyType< Integer > EndNavigationKeyProperty
 Sets the logical key value of the end navigation. More...
 
DynamicPropertyType< Integer > HomeNavigationKeyModifierProperty
 Sets the key modifiers of the home navigation. More...
 
DynamicPropertyType< Integer > HomeNavigationKeyProperty
 Sets the logical key value of the home navigation. More...
 
DynamicPropertyType< Integer > LeftNavigationKeyModifierProperty
 Sets the key modifiers of the left direction navigation. More...
 
DynamicPropertyType< Integer > LeftNavigationKeyProperty
 Sets the logical key value of the left direction navigation. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NavigationManipulatorComponent")
 Metaclass for NavigationManipulatorComponent.
 
DynamicPropertyType< Integer > PageDownNavigationKeyModifierProperty
 Sets the key modifiers of the page-down navigation. More...
 
DynamicPropertyType< Integer > PageDownNavigationKeyProperty
 Sets the logical key value of the page-down navigation. More...
 
DynamicPropertyType< Integer > PageUpNavigationKeyModifierProperty
 Sets the key modifiers of the page-up navigation. More...
 
DynamicPropertyType< Integer > PageUpNavigationKeyProperty
 Sets the logical key value of the page-up navigation. More...
 
DynamicPropertyType< Integer > RightNavigationKeyModifierProperty
 Sets the key modifiers of the right direction navigation. More...
 
DynamicPropertyType< Integer > RightNavigationKeyProperty
 Sets the logical key value of the right direction navigation. More...
 
DynamicPropertyType< Integer > UpNavigationKeyModifierProperty
 Sets the key modifiers of the up navigation. More...
 
DynamicPropertyType< Integer > UpNavigationKeyProperty
 Sets the logical key value of the up navigation. More...
 
- Protected Member Functions inherited from NodeComponent
 NodeComponent (Domain domain, long handle, Metaclass metaclass)
 Wraps a given native Node Component. More...
 
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 Node Component.
 
void removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token)
 Removes message handler added via NodeComponent#addNodeComponentMessageHandler function. More...
 
- Static Protected Member Functions inherited from NodeComponent
static< Derived extends NodeComponent > ObjectRef< Derived > createDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance. More...
 

Detailed Description

Enables the node to react to navigation key input events.

Member Function Documentation

◆ create()

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

Constructs a new NavigationManipulatorComponent.

Parameters
domainUI Domain where this object belongs.
nameName of the object.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static