UserInput (XMLmind XML Editor Java[tm] API)

java.lang.Object
- com.xmlmind.xmledit.control.UserInput

```
public final class UserInput
extends Object
```
Specifies a user input event: mouse click or key stroke.
This class is thread-safe.

See Also:

InputEvent, KeyEvent, MouseEvent

Field Summary

Fields
Modifier and Type Field and Description

static int NOT_A_MOUSE_EVENT
Value returned by getMouseEventId() when this input is not a mouse input but is a keyboard input.

Fields
Modifier and Type	Field and Description
`static int`	`NOT_A_MOUSE_EVENT` Value returned by `getMouseEventId()` when this input is not a mouse input but is a keyboard input.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`static UserInput`	`get(char keyChar)` Returns specified ``character typed'' input.
`static UserInput`	`get(int keyCode, int modifiers)` Returns specified ``key pressed'' input.
`static UserInput`	`get(int mouseButton, int modifiers, int mouseEventId)` Returns specified mouse input.
`static UserInput`	`get(int mouseButton, int modifiers, int mouseEventId, int mouseClickCount)` Returns specified mouse input.
`char`	`getKeyChar()` Returns character typed by user.
`int`	`getKeyCode()` Returns code of key pressed by user: KeyEvent.A, KeyEvent.F1, etc.
`int`	`getModifiers()` Returns keyboard modifiers used for mouse or keyboard input: KeyEvent.SHIFT_MASK, KeyEvent.CTRL_MASK, etc.
`int`	`getMouseButton()` Returns mouse button pressed by user: MouseEvent.BUTTON1_MASK, MouseEvent.BUTTON2_MASK, etc.
`int`	`getMouseClickCount()` Returns number of mouse clicks.
`int`	`getMouseEventId()` Returns type of mouse input: MouseEvent.MOUSE_CLICKED, MouseEvent.MOUSE_PRESSED, etc.
`int`	`hashCode()`
`String`	`toString()` Returns a string representing this user input.
`void`	`toString(StringBuilder buffer)` Formats this user input as a string.

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

- Field Detail
  - NOT_A_MOUSE_EVENT
```
public static final int NOT_A_MOUSE_EVENT
```
    Value returned by getMouseEventId() when this input is not a mouse input but is a keyboard input.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - get
```
public static UserInput get(int mouseButton,
                            int modifiers,
                            int mouseEventId)
```
    Returns specified mouse input.
    
    Parameters:
    
    mouseButton - mouse button: MouseEvent.BUTTON1_MASK, MouseEvent.BUTTON2_MASK, etc
    
    modifiers - keyboard modifiers: KeyEvent.SHIFT_MASK, KeyEvent.CTRL_MASK, etc
    
    mouseEventId - type of mouse input: MouseEvent.MOUSE_CLICKED, MouseEvent.MOUSE_PRESSED, etc
  - get
```
public static UserInput get(int mouseButton,
                            int modifiers,
                            int mouseEventId,
                            int mouseClickCount)
```
    Returns specified mouse input.
    
    Parameters:
    
    mouseButton - mouse button: MouseEvent.BUTTON1_MASK, MouseEvent.BUTTON2_MASK, etc
    
    modifiers - keyboard modifiers: KeyEvent.SHIFT_MASK, KeyEvent.CTRL_MASK, etc
    
    mouseEventId - type of mouse input: MouseEvent.MOUSE_CLICKED, MouseEvent.MOUSE_PRESSED, etc
    
    mouseClickCount - if input type is MouseEvent.MOUSE_CLICKED, number of mouse clicks
  - get
```
public static UserInput get(int keyCode,
                            int modifiers)
```
    Returns specified ``key pressed'' input.
    
    Parameters:
    
    keyCode - code of key pressed by user: KeyEvent.A, KeyEvent.F1, etc
    
    modifiers - keyboard modifiers: KeyEvent.SHIFT_MASK, KeyEvent.CTRL_MASK, etc
  - get
```
public static UserInput get(char keyChar)
```
    Returns specified ``character typed'' input.
    
    Parameters:
    
    keyChar - character typed by user
  - getMouseButton
```
public int getMouseButton()
```
    Returns mouse button pressed by user: MouseEvent.BUTTON1_MASK, MouseEvent.BUTTON2_MASK, etc. Returns -1 if not applicable to this user input.
  - getModifiers
```
public int getModifiers()
```
    Returns keyboard modifiers used for mouse or keyboard input: KeyEvent.SHIFT_MASK, KeyEvent.CTRL_MASK, etc.
  - getMouseEventId
```
public int getMouseEventId()
```
    Returns type of mouse input: MouseEvent.MOUSE_CLICKED, MouseEvent.MOUSE_PRESSED, etc. Returns NOT_A_MOUSE_EVENT if not applicable to this user input.
  - getMouseClickCount
```
public int getMouseClickCount()
```
    Returns number of mouse clicks. Returns -1 if not applicable to this user input.
  - getKeyChar
```
public char getKeyChar()
```
    Returns character typed by user. Returns KeyEvent.CHAR_UNDEFINED if not applicable to this user input.
  - getKeyCode
```
public int getKeyCode()
```
    Returns code of key pressed by user: KeyEvent.A, KeyEvent.F1, etc. Returns KeyEvent.VK_UNDEFINED if not applicable to this user input.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns a string representing this user input. This string can be used as a label in a GUI.
    
    Overrides:
    
    toString in class Object
  - toString
```
public void toString(StringBuilder buffer)
```
    Formats this user input as a string. This localized string can be used as a label in a GUI.
    
    Parameters:
    
    buffer - string representation is appended to this buffer

Class UserInput

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOT_A_MOUSE_EVENT

Method Detail

get

get

get

get

getMouseButton

getModifiers

getMouseEventId

getMouseClickCount

getKeyChar

getKeyCode

hashCode

equals

toString

toString