Kanzi  3.9.9
Kanzi Engine Java API
InputManipulatorMetadata.KeyInputMessageArguments Class Reference

Metadata definitions for KeyInputMessageArguments. More...

Inheritance diagram for InputManipulatorMetadata.KeyInputMessageArguments:
[legend]

Public Member Functions

 KeyInputMessageArguments ()
 Constructs a new messageArgumentsClassName instance.
 
 KeyInputMessageArguments (long nativeObject)
 Wraps a native instance. More...
 
Boolean getCapsLockProperty ()
 Gets the value of CapsLock.
 
Integer getKeyModifiersProperty ()
 Gets the value of KeyModifiers.
 
Integer getKeyProperty ()
 Gets the value of Key.
 
void setCapsLockProperty (Boolean value)
 Sets the value of CapsLock.
 
void setKeyModifiersProperty (Integer value)
 Sets the value of KeyModifiers.
 
void setKeyProperty (Integer value)
 Sets the value of Key.
 
- 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...
 
MessageArgumentsWrapper getWrapper ()
 Gets a wrapper for this MessageArguments. 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

- Static Public Member Functions inherited from MessageArguments
static MessageArgumentsWrapper getWrapper (MessageArguments messageArguments)
 Gets a wrapper for a MessageArguments object. More...
 
- Protected Member Functions inherited from MessageArguments
 MessageArguments (MessageArgumentsWrapper wrapper)
 Wraps a native message argument. More...
 
 MessageArguments (long nativeObject)
 Wraps a native message argument. More...
 

Detailed Description

Constructor & Destructor Documentation

KeyInputMessageArguments ( long  nativeObject)

Wraps a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

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

Sets whether Caps Lock is on during the key event.

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

Sets the target key modifiers to handle.

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

Sets the target logical key to handle.

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

Metaclass for KeyInputMessageArguments.