Package org.gnome.gtk

Class EventControllerScroll.Builder<B extends EventControllerScroll.Builder<B>>

java.lang.Object

org.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gtk.EventController.Builder<B>

org.gnome.gtk.EventControllerScroll.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

EventControllerScroll

public static class EventControllerScroll.Builder<B extends EventControllerScroll.Builder<B>>
extends EventController.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
EventControllerScroll	build()	Finish building the EventControllerScroll object.
B	onDecelerate(EventControllerScroll.DecelerateCallback handler)	Emitted after scroll is finished if the EventControllerScrollFlags.KINETIC flag is set.
B	onScroll(EventControllerScroll.ScrollCallback handler)	Signals that the widget should scroll by the amount specified by dx and dy.
B	onScrollBegin(EventControllerScroll.ScrollBeginCallback handler)	Signals that a new scrolling operation has begun.
B	onScrollEnd(EventControllerScroll.ScrollEndCallback handler)	Signals that a scrolling operation has finished.
B	setFlags(Set<EventControllerScrollFlags> flags)	The flags affecting event controller behavior.
B	setFlags(EventControllerScrollFlags... flags)	The flags affecting event controller behavior.

Methods inherited from class org.gnome.gtk.EventController.Builder

setName, setPropagationLimit, setPropagationPhase

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class org.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public EventControllerScroll build()

Finish building the EventControllerScroll object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to EventControllerScroll.

Overrides:

build in class EventController.Builder<B extends EventControllerScroll.Builder<B>>

Returns:

a new instance of EventControllerScroll with the properties that were set in the Builder object.

setFlags

public B setFlags(Set<EventControllerScrollFlags> flags)

The flags affecting event controller behavior.

Parameters:

flags - the value for the flags property

Returns:

the Builder instance is returned, to allow method chaining

setFlags

public B setFlags(EventControllerScrollFlags... flags)

The flags affecting event controller behavior.

Parameters:

flags - the value for the flags property

Returns:

the Builder instance is returned, to allow method chaining

onDecelerate

public B onDecelerate(EventControllerScroll.DecelerateCallback handler)

Emitted after scroll is finished if the EventControllerScrollFlags.KINETIC flag is set.

velX and velY express the initial velocity that was imprinted by the scroll events. velX and velY are expressed in pixels/ms.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• EventControllerScroll.DecelerateCallback.run(double, double)

onScroll

public B onScroll(EventControllerScroll.ScrollCallback handler)

Signals that the widget should scroll by the amount specified by dx and dy.

For the representation unit of the deltas, see EventControllerScroll.getUnit().

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• EventControllerScroll.ScrollCallback.run(double, double)

onScrollBegin

public B onScrollBegin(EventControllerScroll.ScrollBeginCallback handler)

Signals that a new scrolling operation has begun.

It will only be emitted on devices capable of it.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• EventControllerScroll.ScrollBeginCallback.run()

onScrollEnd

public B onScrollEnd(EventControllerScroll.ScrollEndCallback handler)

Signals that a scrolling operation has finished.

It will only be emitted on devices capable of it.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• EventControllerScroll.ScrollEndCallback.run()