Kanzi  3.9.6
Java API
NavigationManipulatorMetadata.KeyNavigationMessageArguments Class Reference

Metadata definitions for KeyNavigationMessageArguments. More...

Inheritance diagram for NavigationManipulatorMetadata.KeyNavigationMessageArguments:
[legend]

Public Member Functions

 KeyNavigationMessageArguments ()
 Construct a new messageArgumentsClassName instance.
 
 KeyNavigationMessageArguments (long nativeObject)
 Wrap a native instance. More...
 
Integer getNavigationDirectionProperty ()
 Getter for NavigationDirectionProperty.
 
void setNavigationDirectionProperty (Integer value)
 Setter for NavigationDirectionProperty.
 
- Public Member Functions inherited from KeyManipulatorMetadata.KeyPressedMessageArguments
 KeyPressedMessageArguments ()
 Construct a new messageArgumentsClassName instance.
 
 KeyPressedMessageArguments (long nativeObject)
 Wrap a native instance. More...
 
Boolean getIsRepeatProperty ()
 Getter for IsRepeatProperty.
 
void setIsRepeatProperty (Boolean value)
 Setter for IsRepeatProperty.
 
- Public Member Functions inherited from InputManipulatorMetadata.KeyInputMessageArguments
 KeyInputMessageArguments ()
 Construct a new messageArgumentsClassName instance.
 
 KeyInputMessageArguments (long nativeObject)
 Wrap a native instance. More...
 
Boolean getCapsLockProperty ()
 Getter for CapsLockProperty.
 
Integer getKeyModifiersProperty ()
 Getter for KeyModifiersProperty.
 
Integer getKeyProperty ()
 Getter for KeyProperty.
 
void setCapsLockProperty (Boolean value)
 Setter for CapsLockProperty.
 
void setKeyModifiersProperty (Integer value)
 Setter for KeyModifiersProperty.
 
void setKeyProperty (Integer value)
 Setter for KeyProperty.
 
- Public Member Functions inherited from MessageArguments
 MessageArguments ()
 Constructs a new MessageArguments object. More...
 
TDataType getArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument. More...
 
TDataType getOptionalArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument, but does not use the default value if there are no inputs to the argument value. More...
 
TNodeType getSource ()
 Returns the source node for a message. More...
 
boolean isHandled ()
 Returns whether the message is handled. More...
 
void setArgument (PropertyType< TDataType > propertyType, TDataType value)
 Sets the value of an argument. More...
 
void setArgument (PropertyType< Integer > propertyType, EnumType value)
 Sets the value of an integer argument using a constant from an enumeration. More...
 
void setHandled (boolean handled)
 Sets the handling status for a message. More...
 

Static Public Attributes

static final AbstractMetaclass metaclass
 Metaclass for KeyNavigationMessageArguments. More...
 
static final DynamicPropertyType< Integer > NavigationDirectionProperty
 The navigation direction. More...
 
- Static Public Attributes inherited from KeyManipulatorMetadata.KeyPressedMessageArguments
static final DynamicPropertyType< Boolean > IsRepeatProperty
 Whether the key press is a repeat caused by the user holding down a keyboard key. More...
 
static final AbstractMetaclass metaclass
 Metaclass for KeyPressedMessageArguments. More...
 
- Static Public Attributes inherited from InputManipulatorMetadata.KeyInputMessageArguments
static final DynamicPropertyType< Boolean > CapsLockProperty
 Sets whether Caps Lock is on during the key event. More...
 
static final DynamicPropertyType< Integer > KeyModifiersProperty
 Sets the target key modifiers to handle. More...
 
static final DynamicPropertyType< Integer > KeyProperty
 Sets the target logical key to handle. More...
 
static final AbstractMetaclass metaclass
 Metaclass for KeyInputMessageArguments. More...
 

Additional Inherited Members

- Protected Member Functions inherited from MessageArguments
 MessageArguments (long nativeObject)
 Wraps a native message argument. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ KeyNavigationMessageArguments()

KeyNavigationMessageArguments ( long  nativeObject)

Wrap a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

◆ metaclass

final AbstractMetaclass metaclass
static
Initial value:
=
new AbstractMetaclass("Kanzi.NavigationManipulator.KeyNavigationMessageArguments")

Metaclass for KeyNavigationMessageArguments.

◆ NavigationDirectionProperty

final DynamicPropertyType<Integer> NavigationDirectionProperty
static
Initial value:
=
new DynamicPropertyType<>("Input.MessageArgument.NavigationDirection", Integer.class)

The navigation direction.