com.teamdev.jxbrowser.ui.event

Class MouseWheel.Builder

java.lang.Object

com.teamdev.jxbrowser.ui.event.MouseWheel.Builder

Enclosing interface:

MouseWheel

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

A builder of MouseWheel.

Builders are created by invoking MouseWheel.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
MouseWheel	build() Returns a new MouseWheel instance built from the current state of this builder.
MouseWheel.Builder	horizontalScroll(boolean horizontalScroll) Specifies whether it is a horizontal scroll.
MouseWheel.Builder	keyModifiers(KeyModifiers keyModifiers) Sets the keyboard modifiers applied.
MouseWheel.Builder	locationOnScreen(Point locationOnScreen) Sets the mouse position relative to the bounds of the screen.
MouseWheel.Builder	scrollbarPixelsPerLine(int scrollbarPixelsPerLine) Sets the number of pixels per line for scrolling.
MouseWheel.Builder	scrollType(ScrollType scrollType) Sets the scroll type of the event.
MouseWheel.Builder	unitsToScroll(int unitsToScroll) Sets the number of units to scroll.

Methods inherited from class java.lang.Object

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

Method Detail

locationOnScreen

public MouseWheel.Builder locationOnScreen(Point locationOnScreen)

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

Parameters:

locationOnScreen - the mouse position

Returns:

this builder

keyModifiers

public MouseWheel.Builder keyModifiers(KeyModifiers keyModifiers)

Sets the keyboard modifiers applied.

Parameters:

keyModifiers - the keyboard modifiers

Returns:

this builder

scrollType

public MouseWheel.Builder scrollType(ScrollType scrollType)

Sets the scroll type of the event.

Parameters:

scrollType - the scroll type

Returns:

this builder

unitsToScroll

public MouseWheel.Builder unitsToScroll(int unitsToScroll)

Sets the number of units to scroll.

Parameters:

unitsToScroll - the number of units

Returns:

this builder

scrollbarPixelsPerLine

public MouseWheel.Builder scrollbarPixelsPerLine(int scrollbarPixelsPerLine)

Sets the number of pixels per line for scrolling.

Parameters:

scrollbarPixelsPerLine - the number of pixels per line

Returns:

this builder

horizontalScroll

public MouseWheel.Builder horizontalScroll(boolean horizontalScroll)

Specifies whether it is a horizontal scroll.

Parameters:

horizontalScroll - the flag value

Returns:

this builder

build

public MouseWheel build()

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

Returns:

a new MouseWheel instance