org.assertj.swing.input

Class InputState

java.lang.Object

org.assertj.swing.input.InputState

@ThreadSafe
public class InputState
extends Object

Keeps track of a given input state. Includes mouse/pointer position and keyboard modifier key state.

Synchronization assumes that any given instance might be called from more than one event dispatch thread (EDT.)

Constructor Summary

Constructors

Constructor and Description
InputState(Toolkit toolkit)

Method Summary

Methods

Modifier and Type	Method and Description
int	buttons()
static Component	childAt(Component parent, Point where) Returns the AWT or Swing Component under the given coordinates in the given parent component.
void	clear()
int	clickCount()
Component	deepestComponentUnderMousePointer()
void	dispose()
boolean	dragInProgress() Indicates there is a drag operation in progress.
Point	dragOrigin()
Component	dragSource()
boolean	isNativeDragActive() Indicates whether there is a native drag/drop operation in progress.
int	keyModifiers()
long	lastEventTime()
int	modifiers()
Component	mouseComponent() Returns the last known AWT or Swing Component to contain the pointer, or null if none.
Point	mouseLocation()
Point	mouseLocationOnScreen()
void	update(AWTEvent event) Explicitly update the internal state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputState

public InputState(@Nonnull
          Toolkit toolkit)

Method Detail

clear

public void clear()

dispose

public void dispose()

update

public void update(@Nonnull
          AWTEvent event)

Explicitly update the internal state.

Parameters:

event - the event to use to update the internal state.

deepestComponentUnderMousePointer

@Nullable
public Component deepestComponentUnderMousePointer()

Returns:

the most deeply nested AWT or Swing Component which currently contains the pointer.

mouseComponent

@Nullable
public Component mouseComponent()

Returns the last known AWT or Swing Component to contain the pointer, or null if none. Note that this may not correspond to the Component that actually shows up in AWTEvents.

Returns:

the last known Component to contain the pointer, or null if none.

childAt

public static Component childAt(@Nonnull
                Component parent,
                @Nonnull
                Point where)

Returns the AWT or Swing Component under the given coordinates in the given parent component. Events are often generated only for the outermost Container, so we have to determine if the pointer is actually within a child. Basically the same as Component.getComponentAt, but recurses to the lowest-level Component instead of only one level. Point is in Component coordinates.

The default Component.getComponentAt can return invisible Components (JRootPane has an invisible JPanel (glass pane?) which will otherwise swallow everything).

NOTE: childAt grabs the TreeLock, so this should *only* be invoked on the event dispatch thread, preferably with no other locks held. Use it elsewhere at your own risk.

Parameters:

parent - the given parent.

where - the given coordinates.

Returns:

the Component under the given coordinates in the given parent Component.

dragInProgress

public boolean dragInProgress()

Indicates there is a drag operation in progress.

Returns:

true if there is a drag operation in progress, false otherwise.

dragSource

public Component dragSource()

Returns:

the AWT or Swing Component where a drag operation started.

dragOrigin

public Point dragOrigin()

Returns:

the coordinates where a drag operation started.

clickCount

public int clickCount()

Returns:

the number of times a mouse button was clicked.

lastEventTime

public long lastEventTime()

Returns:

the time when the last input event occurred.

modifiers

public int modifiers()

Returns:

all currently active modifiers.

keyModifiers

public int keyModifiers()

Returns:

the currently pressed key modifiers.

buttons

public int buttons()

Returns:

the mouse buttons used in the last input event.

mouseLocation

@Nullable
public Point mouseLocation()

Returns:

the mouse location relative to the component that currently contains the pointer, or null if outside all components.

mouseLocationOnScreen

@Nullable
public Point mouseLocationOnScreen()

Returns:

the last known mouse location.

isNativeDragActive

public boolean isNativeDragActive()

Indicates whether there is a native drag/drop operation in progress.

Returns:

true if there is a native drag/drop operation in progress, false otherwise.