MouseModifiers (HCL OneTest UI)

java.lang.Object
- com.rational.test.ft.script.MouseModifiers

```
public class MouseModifiers
extends java.lang.Object
```
Enables the MouseModifiers to be passed across processes. This is a value class. This class is necessary as a flag informing the script generator to treat MouseModifiers as descriptive expressions rather than as integer values.

Since:

RFT1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KEY_ALT` Exposes the `KEY_ALT` bitmap literal.
`static int`	`KEY_COMMAND` Exposes the `KEY_COMMAND` bitmap literal.
`static int`	`KEY_CTRL` Exposes the `KEY_CTRL` bitmap literal.
`static int`	`KEY_LEFT_ALT` Exposes the `KEY_LEFT_ALT` bitmap literal.
`static int`	`KEY_LEFT_CTRL` Exposes the `KEY_LEFT_CTRL` bitmap literal.
`static int`	`KEY_LEFT_SHIFT` Exposes the `KEY_LEFT_SHIFT` bitmap literal.
`static int`	`KEY_RIGHT_ALT` Exposes the `KEY_RIGHT_ALT` bitmap literal.
`static int`	`KEY_RIGHT_CTRL` Exposes the `KEY_RIGHT_CTRL` bitmap literal.
`static int`	`KEY_RIGHT_SHIFT` Exposes the `KEY_RIGHT_SHIFT` bitmap literal.
`static int`	`KEY_SHIFT` Exposes the `KEY_SHIFT` bitmap literal.
`static int`	`MOUSE_LEFT` Exposes the `MOUSE_LEFT` bitmap literal.
`static int`	`MOUSE_MIDDLE` Exposes the `MOUSE_MIDDLE` bitmap literal.
`static int`	`MOUSE_RIGHT` Exposes the `MOUSE_RIGHT` bitmap literal.

Constructor Summary

Constructors
Constructor and Description

MouseModifiers(int bitmap)
Constructs a MouseModifier class from an existing bitmap.

Constructors
Constructor and Description
`MouseModifiers(int bitmap)` Constructs a `MouseModifier` class from an existing bitmap.

Method Summary

Methods
Modifier and Type	Method and Description
`static MouseModifiers`	`create(int bitmap)` Creates a `MouseModifiers` object quickly.
`boolean`	`equals(java.lang.Object other)` Overloads the equals method so that only the bitmap is compared.
`int`	`getBitmap()` Accesses the modifier bitmap.
`java.lang.String`	`getModifiersText()` Returns the text of the modifiers
`boolean`	`isAlt()` Returns `true` if the Alt key is selected.
`boolean`	`isCommand()` Returns `true` if the Command key is selected.
`boolean`	`isCtrl()` Returns `true` if the Ctrl key is selected.
`boolean`	`isLeft()` Returns `true` if the left mouse button is selected.
`boolean`	`isMiddle()` Returns `true` if the middle mouse button is selected.
`boolean`	`isRight()` Returns `true` if the right mouse button is selected.
`boolean`	`isShift()` Returns `true` if the Shift key is selected.
`static MouseModifiers`	`left()` Creates a `MOUSE_LEFT` object quickly.
`void`	`setAlt()` Sets the Alt key as selected.
`void`	`setCommand()` Sets the Command key as selected.
`void`	`setCtrl()` Sets the Ctrl key as selected.
`void`	`setLeft()` Sets the left mouse button as selected.
`void`	`setLeftAlt()` Sets the Left Alt key as selected.
`void`	`setLeftCtrl()` Sets the Left Ctrl key as selected.
`void`	`setLeftShift()` Sets the Left Shift key as selected.
`void`	`setMiddle()` Sets the middle mouse button as selected.
`void`	`setRight()` Sets the right mouse button as selected.
`void`	`setRightAlt()` Sets the Right Alt key as selected.
`void`	`setRightCtrl()` Sets the Right Ctrl key as selected.
`void`	`setRightShift()` Sets the Right Shift key as selected.
`void`	`setShift()` Sets the Shift key as selected.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MOUSE_LEFT
```
public static final int MOUSE_LEFT
```
    Exposes the MOUSE_LEFT bitmap literal.
    
    See Also:
    Constant Field Values
  - MOUSE_MIDDLE
```
public static final int MOUSE_MIDDLE
```
    Exposes the MOUSE_MIDDLE bitmap literal.
    
    See Also:
    Constant Field Values
  - MOUSE_RIGHT
```
public static final int MOUSE_RIGHT
```
    Exposes the MOUSE_RIGHT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_SHIFT
```
public static final int KEY_SHIFT
```
    Exposes the KEY_SHIFT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_CTRL
```
public static final int KEY_CTRL
```
    Exposes the KEY_CTRL bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_ALT
```
public static final int KEY_ALT
```
    Exposes the KEY_ALT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_RIGHT_SHIFT
```
public static final int KEY_RIGHT_SHIFT
```
    Exposes the KEY_RIGHT_SHIFT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_RIGHT_CTRL
```
public static final int KEY_RIGHT_CTRL
```
    Exposes the KEY_RIGHT_CTRL bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_RIGHT_ALT
```
public static final int KEY_RIGHT_ALT
```
    Exposes the KEY_RIGHT_ALT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_LEFT_SHIFT
```
public static final int KEY_LEFT_SHIFT
```
    Exposes the KEY_LEFT_SHIFT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_LEFT_CTRL
```
public static final int KEY_LEFT_CTRL
```
    Exposes the KEY_LEFT_CTRL bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_LEFT_ALT
```
public static final int KEY_LEFT_ALT
```
    Exposes the KEY_LEFT_ALT bitmap literal.
    
    See Also:
    Constant Field Values
  - KEY_COMMAND
```
public static final int KEY_COMMAND
```
    Exposes the KEY_COMMAND bitmap literal.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MouseModifiers
```
public MouseModifiers(int bitmap)
```
    Constructs a MouseModifier class from an existing bitmap.
    
    Since:
    
    RFT1.0
- Method Detail
  - getBitmap
```
public int getBitmap()
```
    Accesses the modifier bitmap.
    
    Since:
    
    RFT1.0
  - isLeft
```
public boolean isLeft()
```
    Returns true if the left mouse button is selected.
    
    Since:
    
    RFT1.0
  - setLeft
```
public void setLeft()
```
    Sets the left mouse button as selected.
    
    Since:
    
    RFT1.0
  - isMiddle
```
public boolean isMiddle()
```
    Returns true if the middle mouse button is selected.
    
    Since:
    
    RFT1.0
  - setMiddle
```
public void setMiddle()
```
    Sets the middle mouse button as selected.
    
    Since:
    
    RFT1.0
  - isRight
```
public boolean isRight()
```
    Returns true if the right mouse button is selected.
    
    Since:
    
    RFT1.0
  - setRight
```
public void setRight()
```
    Sets the right mouse button as selected.
    
    Since:
    
    RFT1.0
  - isCtrl
```
public boolean isCtrl()
```
    Returns true if the Ctrl key is selected.
    
    Since:
    
    RFT1.0
  - setCtrl
```
public void setCtrl()
```
    Sets the Ctrl key as selected.
    
    Since:
    
    RFT1.0
  - setLeftCtrl
```
public void setLeftCtrl()
```
    Sets the Left Ctrl key as selected.
    
    Since:
    
    RFT7.0
  - setRightCtrl
```
public void setRightCtrl()
```
    Sets the Right Ctrl key as selected.
    
    Since:
    
    RFT7.0
  - isAlt
```
public boolean isAlt()
```
    Returns true if the Alt key is selected.
    
    Since:
    
    RFT1.0
  - setAlt
```
public void setAlt()
```
    Sets the Alt key as selected.
    
    Since:
    
    RFT1.0
  - setRightAlt
```
public void setRightAlt()
```
    Sets the Right Alt key as selected.
    
    Since:
    
    RFT7.0
  - setLeftAlt
```
public void setLeftAlt()
```
    Sets the Left Alt key as selected.
    
    Since:
    
    RFT7.0
  - isShift
```
public boolean isShift()
```
    Returns true if the Shift key is selected.
    
    Since:
    
    RFT1.0
  - setShift
```
public void setShift()
```
    Sets the Shift key as selected.
    
    Since:
    
    RFT1.0
  - setLeftShift
```
public void setLeftShift()
```
    Sets the Left Shift key as selected.
    
    Since:
    
    RFT7.0
  - setRightShift
```
public void setRightShift()
```
    Sets the Right Shift key as selected.
    
    Since:
    
    RFT7.0
  - getModifiersText
```
public java.lang.String getModifiersText()
```
    Returns the text of the modifiers
    
    Since:
    
    RFT1.1
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overloads the equals method so that only the bitmap is compared.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Since:
    
    RFT1.0
  - left
```
public static MouseModifiers left()
```
    Creates a MOUSE_LEFT object quickly.
    
    Since:
    
    RFT1.0
  - create
```
public static MouseModifiers create(int bitmap)
```
    Creates a MouseModifiers object quickly.
    
    Since:
    
    RFT1.0
  - isCommand
```
public boolean isCommand()
```
    Returns true if the Command key is selected. Mac only
    
    Since:
    
    RFT1.0
  - setCommand
```
public void setCommand()
```
    Sets the Command key as selected. Mac only
    
    Since:
    
    RFT1.0

Class MouseModifiers

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MOUSE_LEFT

MOUSE_MIDDLE

MOUSE_RIGHT

KEY_SHIFT

KEY_CTRL

KEY_ALT

KEY_RIGHT_SHIFT

KEY_RIGHT_CTRL

KEY_RIGHT_ALT

KEY_LEFT_SHIFT

KEY_LEFT_CTRL

KEY_LEFT_ALT

KEY_COMMAND

Constructor Detail

MouseModifiers

Method Detail

getBitmap

isLeft

setLeft

isMiddle

setMiddle

isRight

setRight

isCtrl

setCtrl

setLeftCtrl

setRightCtrl

isAlt

setAlt

setRightAlt

setLeftAlt

isShift

setShift

setLeftShift

setRightShift

getModifiersText

equals

left

create

isCommand

setCommand