com.teamdev.jxbrowser.ui.event

Class MousePressed.Builder

java.lang.Object

com.teamdev.jxbrowser.ui.event.MousePressed.Builder

Enclosing interface:

MousePressed

public static final class MousePressed.Builder
extends java.lang.Object

A builder of MousePressed.

Builders are created by invoking MousePressed.newBuilder(Point). Each of the setter methods modifies the state of the builder and returns the same instance. Builders are not thread-safe and should not be used concurrently from multiple threads without external synchronization.

Method Summary

Modifier and Type	Method and Description
MousePressed	build() Returns a new MousePressed instance built from the current state of this builder.
MousePressed.Builder	button(MouseButton mouseButton) Sets the button that is pressed.
MousePressed.Builder	clickCount(int clickCount) Sets the count of consecutive clicks that happened in a short amount of time.
MousePressed.Builder	keyModifiers(KeyModifiers keyModifiers) Sets the keyboard modifiers applied.
MousePressed.Builder	locationOnScreen(Point locationOnScreen) Sets the mouse position relative to the bounds of the screen.
MousePressed.Builder	mouseModifiers(MouseModifiers mouseModifiers) Sets the mouse modifiers applied.

Methods inherited from class java.lang.Object

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

Method Detail

locationOnScreen

public MousePressed.Builder locationOnScreen(Point locationOnScreen)

Sets the mouse position relative to the bounds of the screen.

Parameters:

locationOnScreen - the mouse position

Returns:

this builder

button

public MousePressed.Builder button(MouseButton mouseButton)

Sets the button that is pressed.

Parameters:

mouseButton - the pressed button

Returns:

this builder

keyModifiers

public MousePressed.Builder keyModifiers(KeyModifiers keyModifiers)

Sets the keyboard modifiers applied.

Parameters:

keyModifiers - the keyboard modifiers

Returns:

this builder

mouseModifiers

public MousePressed.Builder mouseModifiers(MouseModifiers mouseModifiers)

Sets the mouse modifiers applied.

Parameters:

mouseModifiers - the mouse modifiers

Returns:

this builder

clickCount

public MousePressed.Builder clickCount(int clickCount)

Sets the count of consecutive clicks that happened in a short amount of time.

Parameters:

clickCount - the count of clicks

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - when clickCount is negative

build

public MousePressed build()

Returns a new MousePressed instance built from the current state of this builder.

Returns:

a new MousePressed instance