Kanzi  3.9.6
Java API
InputManipulatorMetadata.KeyInputMessageArguments Class Reference

Metadata definitions for KeyInputMessageArguments. More...

Inheritance diagram for InputManipulatorMetadata.KeyInputMessageArguments:
[legend]

Public Member Functions

 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 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

◆ KeyInputMessageArguments()

KeyInputMessageArguments ( long  nativeObject)

Wrap a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

◆ CapsLockProperty

final DynamicPropertyType<Boolean> CapsLockProperty
static
Initial value:
=
new DynamicPropertyType<>("Input.MessageArgument.CapsLock", Boolean.class)

Sets whether Caps Lock is on during the key event.

◆ KeyModifiersProperty

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

Sets the target key modifiers to handle.

◆ KeyProperty

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

Sets the target logical key to handle.

◆ metaclass

final AbstractMetaclass metaclass
static
Initial value:
=
new AbstractMetaclass("Kanzi.InputManipulator.KeyInputMessageArguments")

Metaclass for KeyInputMessageArguments.