org.ocast.sdk.core.models

Class SendKeyEventCommandParams

OCastCommandParams

org.ocast.sdk.core.models.SendKeyEventCommandParams

public class SendKeyEventCommandParams
extends OCastCommandParams

Represents the parameters of a keyPressed command.

Constructor Summary

Constructors

Constructor and Description
SendKeyEventCommandParams(java.lang.String key, java.lang.String code, boolean ctrl, boolean alt, boolean shift, boolean meta, SendKeyEventCommandParams.DOMKeyLocation location) Creates an instance of class SendKeyEventCommandParams.

Method Summary

Modifier and Type	Method and Description
boolean	getAlt() Indicates if the
java.lang.String	getCode() A string that identifies the physical key being pressed.
boolean	getCtrl() Indicates if the
java.lang.String	getKey() The key attribute value corresponding to the key pressed.
SendKeyEventCommandParams.DOMKeyLocation	getLocation() The location of the key on the keyboard.
boolean	getMeta() Indicates if the
boolean	getShift() Indicates if the

Methods inherited from class org.ocast.sdk.core.models.OCastCommandParams

build, getName, options

Constructor Detail

SendKeyEventCommandParams

public SendKeyEventCommandParams(@NotNull
                                 java.lang.String key,
                                 @NotNull
                                 java.lang.String code,
                                 boolean ctrl,
                                 boolean alt,
                                 boolean shift,
                                 boolean meta,
                                 @NotNull
                                 SendKeyEventCommandParams.DOMKeyLocation location)

Creates an instance of class SendKeyEventCommandParams.

Parameters:

key - The key attribute value corresponding to the key pressed. Possible supported keys are defined by the W3C UI events KeyboardEvent interface.

code - A string that identifies the physical key being pressed.

ctrl - Indicates if the Control key is pressed.

alt - Indicates if the Alt key is pressed.

shift - Indicates if the Shift key is pressed.

meta - Indicates if the Meta key (OS specific) is pressed.

location - The location of the key on the keyboard. This is used to disambiguate between key values that can be generated by different physical keys on the keyboard, for example, the left and right Shift key.

See Also:

class SendKeyEventCommandParams

Method Detail

getKey

@NotNull
public java.lang.String getKey()

The key attribute value corresponding to the key pressed.

Possible supported keys are defined by the W3C UI events KeyboardEvent interface.

See Also:

W3C UI events KeyboardEvent interface

getCode

@NotNull
public java.lang.String getCode()

A string that identifies the physical key being pressed.

getCtrl

public boolean getCtrl()

Indicates if the

Control key is pressed.

getAlt

public boolean getAlt()

Indicates if the

Alt key is pressed.

getShift

public boolean getShift()

Indicates if the

Shift key is pressed.

getMeta

public boolean getMeta()

Indicates if the

Meta key (OS specific) is pressed.

getLocation

@NotNull
public SendKeyEventCommandParams.DOMKeyLocation getLocation()

The location of the key on the keyboard.

This is used to disambiguate between key values that can be generated by different physical keys on the keyboard, for example, the left and right Shift key.