Package org.gnome.gtk

Class Gesture.Builder<B extends Gesture.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

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

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

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Direct Known Subclasses:

GestureRotate.Builder, GestureSingle.Builder, GestureZoom.Builder

Enclosing class:

Gesture

public static class Gesture.Builder<B extends Gesture.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
Gesture	build()	Finish building the Gesture object.
B	onBegin(Gesture.BeginCallback handler)	Emitted when the gesture is recognized.
B	onCancel(Gesture.CancelCallback handler)	Emitted whenever a sequence is cancelled.
B	onEnd(Gesture.EndCallback handler)	Emitted when gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than Gtk.Gesture:n-points.
B	onSequenceStateChanged(Gesture.SequenceStateChangedCallback handler)	Emitted whenever a sequence state changes.
B	onUpdate(Gesture.UpdateCallback handler)	Emitted whenever an event is handled while the gesture is recognized.
B	setNPoints(int nPoints)	The number of touch points that trigger recognition on this gesture.

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 io.github.jwharm.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 Gesture build()

Finish building the Gesture 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 Gesture.

Overrides:

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

Returns:

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

setNPoints

public B setNPoints(int nPoints)

The number of touch points that trigger recognition on this gesture.

Parameters:

nPoints - the value for the n-points property

Returns:

the Builder instance is returned, to allow method chaining

onBegin

public B onBegin(Gesture.BeginCallback handler)

Emitted when the gesture is recognized.

This means the number of touch sequences matches Gtk.Gesture:n-points.

Note: These conditions may also happen when an extra touch (eg. a third touch on a 2-touches gesture) is lifted, in that situation sequence won't pertain to the current set of active touches, so don't rely on this being true.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Gesture.BeginCallback.run(org.gnome.gdk.EventSequence)

onCancel

public B onCancel(Gesture.CancelCallback handler)

Emitted whenever a sequence is cancelled.

This usually happens on active touches when EventController.reset() is called on gesture (manually, due to grabs...), or the individual sequence was claimed by parent widgets' controllers (see Gesture.setSequenceState(org.gnome.gdk.EventSequence, org.gnome.gtk.EventSequenceState)).

gesture must forget everything about sequence as in response to this signal.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Gesture.CancelCallback.run(org.gnome.gdk.EventSequence)

onEnd

public B onEnd(Gesture.EndCallback handler)

Emitted when gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than Gtk.Gesture:n-points.

Note: sequence might not pertain to the group of sequences that were previously triggering recognition on gesture (ie. a just pressed touch sequence that exceeds Gtk.Gesture:n-points). This situation may be detected by checking through Gesture.handlesSequence(org.gnome.gdk.EventSequence).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Gesture.EndCallback.run(org.gnome.gdk.EventSequence)

onSequenceStateChanged

public B onSequenceStateChanged(Gesture.SequenceStateChangedCallback handler)

Emitted whenever a sequence state changes.

See Gesture.setSequenceState(org.gnome.gdk.EventSequence, org.gnome.gtk.EventSequenceState) to know more about the expectable sequence lifetimes.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Gesture.SequenceStateChangedCallback.run(org.gnome.gdk.EventSequence, org.gnome.gtk.EventSequenceState)

onUpdate

public B onUpdate(Gesture.UpdateCallback handler)

Emitted whenever an event is handled while the gesture is recognized.

sequence is guaranteed to pertain to the set of active touches.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• Gesture.UpdateCallback.run(org.gnome.gdk.EventSequence)