Package org.gnome.gtk

Class DragSource.Builder<B extends DragSource.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>

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

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

DragSource

public static class DragSource.Builder<B extends DragSource.Builder<B>>
extends GestureSingle.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
DragSource	build()	Finish building the DragSource object.
B	onDragBegin(DragSource.DragBeginCallback handler)	Emitted on the drag source when a drag is started.
B	onDragCancel(DragSource.DragCancelCallback handler)	Emitted on the drag source when a drag has failed.
B	onDragEnd(DragSource.DragEndCallback handler)	Emitted on the drag source when a drag is finished.
B	onPrepare(DragSource.PrepareCallback handler)	Emitted when a drag is about to be initiated.
B	setActions(Set<DragAction> actions)	The actions that are supported by drag operations from the source.
B	setActions(DragAction... actions)	The actions that are supported by drag operations from the source.
B	setContent(ContentProvider content)	The data that is offered by drag operations from this source.

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

setButton, setExclusive, setTouchOnly

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

onBegin, onCancel, onEnd, onSequenceStateChanged, onUpdate, setNPoints

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 DragSource build()

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

Overrides:

build in class GestureSingle.Builder<B extends DragSource.Builder<B>>

Returns:

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

setActions

public B setActions(Set<DragAction> actions)

The actions that are supported by drag operations from the source.

Note that you must handle the Gtk.DragSource::drag-end signal if the actions include DragAction.MOVE.

Parameters:

actions - the value for the actions property

Returns:

the Builder instance is returned, to allow method chaining

setContent

public B setContent(ContentProvider content)

The data that is offered by drag operations from this source.

Parameters:

content - the value for the content property

Returns:

the Builder instance is returned, to allow method chaining

setActions

public B setActions(DragAction... actions)

The actions that are supported by drag operations from the source.

Note that you must handle the Gtk.DragSource::drag-end signal if the actions include DragAction.MOVE.

Parameters:

actions - the value for the actions property

Returns:

the Builder instance is returned, to allow method chaining

onDragBegin

public B onDragBegin(DragSource.DragBeginCallback handler)

Emitted on the drag source when a drag is started.

It can be used to e.g. set a custom drag icon with DragSource.setIcon(org.gnome.gdk.Paintable, int, int).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DragSource.DragBeginCallback.run(org.gnome.gdk.Drag)

onDragCancel

public B onDragCancel(DragSource.DragCancelCallback handler)

Emitted on the drag source when a drag has failed.

The signal handler may handle a failed drag operation based on the type of error. It should return true if the failure has been handled and the default "drag operation failed" animation should not be shown.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DragSource.DragCancelCallback.run(org.gnome.gdk.Drag, org.gnome.gdk.DragCancelReason)

onDragEnd

public B onDragEnd(DragSource.DragEndCallback handler)

Emitted on the drag source when a drag is finished.

A typical reason to connect to this signal is to undo things done in Gtk.DragSource::prepare or Gtk.DragSource::drag-begin handlers.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DragSource.DragEndCallback.run(org.gnome.gdk.Drag, boolean)

onPrepare

public B onPrepare(DragSource.PrepareCallback handler)

Emitted when a drag is about to be initiated.

It returns the GdkContentProvider to use for the drag that is about to start. The default handler for this signal returns the value of the Gtk.DragSource:content property, so if you set up that property ahead of time, you don't need to connect to this signal.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DragSource.PrepareCallback.run(double, double)