NavigationManipulatorComponent Class Reference
The NavigationManipulatorComponent node component installs a NavigationManipulator to a node, and configures the navigation key gestures of the manipulator. More...
Inheritance diagram for NavigationManipulatorComponent:
Static Public Member Functions | |
| static ObjectRef< NavigationManipulatorComponent > | create (Domain domain, String name) |
| Creates an instance of a NavigationManipulatorComponent node component. | |
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. | |
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. | |
| 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. | |
| Public Attributes inherited from NodeComponentMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.NodeComponent") |
| Metaclass for NodeComponent. | |
| DynamicPropertyType< String > | NameProperty |
| Name. | |
| Public Attributes inherited from NavigationManipulatorComponentMetadata | |
| DynamicPropertyType< KeyModifier > | DownNavigationKeyModifierProperty |
| Sets the key modifiers of the down navigation. | |
| DynamicPropertyType< LogicalKey > | DownNavigationKeyProperty |
| Sets the logical key value of the down navigation. | |
| DynamicPropertyType< KeyModifier > | EndNavigationKeyModifierProperty |
| Sets the key modifiers of the end navigation. | |
| DynamicPropertyType< LogicalKey > | EndNavigationKeyProperty |
| Sets the logical key value of the end navigation. | |
| DynamicPropertyType< KeyModifier > | HomeNavigationKeyModifierProperty |
| Sets the key modifiers of the home navigation. | |
| DynamicPropertyType< LogicalKey > | HomeNavigationKeyProperty |
| Sets the logical key value of the home navigation. | |
| DynamicPropertyType< KeyModifier > | LeftNavigationKeyModifierProperty |
| Sets the key modifiers of the left direction navigation. | |
| DynamicPropertyType< LogicalKey > | LeftNavigationKeyProperty |
| Sets the logical key value of the left direction navigation. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.NavigationManipulatorComponent") |
| Metaclass for NavigationManipulatorComponent. | |
| DynamicPropertyType< KeyModifier > | PageDownNavigationKeyModifierProperty |
| Sets the key modifiers of the page-down navigation. | |
| DynamicPropertyType< LogicalKey > | PageDownNavigationKeyProperty |
| Sets the logical key value of the page-down navigation. | |
| DynamicPropertyType< KeyModifier > | PageUpNavigationKeyModifierProperty |
| Sets the key modifiers of the page-up navigation. | |
| DynamicPropertyType< LogicalKey > | PageUpNavigationKeyProperty |
| Sets the logical key value of the page-up navigation. | |
| DynamicPropertyType< KeyModifier > | RightNavigationKeyModifierProperty |
| Sets the key modifiers of the right direction navigation. | |
| DynamicPropertyType< LogicalKey > | RightNavigationKeyProperty |
| Sets the logical key value of the right direction navigation. | |
| DynamicPropertyType< KeyModifier > | UpNavigationKeyModifierProperty |
| Sets the key modifiers of the up navigation. | |
| DynamicPropertyType< LogicalKey > | UpNavigationKeyProperty |
| Sets the logical key value of the up navigation. | |
| Protected Member Functions inherited from NodeComponent | |
| NodeComponent (Domain domain, long handle, Metaclass metaclass) | |
| Wraps a given native Node Component. | |
| 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 com.rightware.kanzi.NodeComponent#addNodeComponentMessageHandler function. | |
| 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. | |
Detailed Description
The NavigationManipulatorComponent node component installs a NavigationManipulator to a node, and configures the navigation key gestures of the manipulator.
Member Function Documentation
◆ create()
|
static |
Creates an instance of a NavigationManipulatorComponent node component.
- Parameters
-
domain The domain that holds the NavigationManipulatorComponent. name The name of the NavigationManipulatorComponent instance.
- Returns
- The created NavigationManipulatorComponent.