Package org.gnome.gtk

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

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

DropTargetAsync

public static class DropTargetAsync.Builder<B extends DropTargetAsync.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
DropTargetAsync	build()	Finish building the DropTargetAsync object.
B	onAccept(DropTargetAsync.AcceptCallback handler)	Emitted on the drop site when a drop operation is about to begin.
B	onDragEnter(DropTargetAsync.DragEnterCallback handler)	Emitted on the drop site when the pointer enters the widget.
B	onDragLeave(DropTargetAsync.DragLeaveCallback handler)	Emitted on the drop site when the pointer leaves the widget.
B	onDragMotion(DropTargetAsync.DragMotionCallback handler)	Emitted while the pointer is moving over the drop target.
B	onDrop(DropTargetAsync.DropCallback handler)	Emitted on the drop site when the user drops the data onto the widget.
B	setActions(Set<DragAction> actions)	The GdkDragActions that this drop target supports.
B	setActions(DragAction... actions)	The GdkDragActions that this drop target supports.
B	setFormats(ContentFormats formats)	The GdkContentFormats that determines the supported data formats.

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

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

Overrides:

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

Returns:

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

setActions

public B setActions(Set<DragAction> actions)

The GdkDragActions that this drop target supports.

Parameters:

actions - the value for the actions property

Returns:

the Builder instance is returned, to allow method chaining

setFormats

public B setFormats(ContentFormats formats)

The GdkContentFormats that determines the supported data formats.

Parameters:

formats - the value for the formats property

Returns:

the Builder instance is returned, to allow method chaining

setActions

public B setActions(DragAction... actions)

The GdkDragActions that this drop target supports.

Parameters:

actions - the value for the actions property

Returns:

the Builder instance is returned, to allow method chaining

onAccept

public B onAccept(DropTargetAsync.AcceptCallback handler)

Emitted on the drop site when a drop operation is about to begin.

If the drop is not accepted, false will be returned and the drop target will ignore the drop. If true is returned, the drop is accepted for now but may be rejected later via a call to DropTargetAsync.rejectDrop(org.gnome.gdk.Drop) or ultimately by returning false from a Gtk.DropTargetAsync::drop handler.

The default handler for this signal decides whether to accept the drop based on the formats provided by the drop.

If the decision whether the drop will be accepted or rejected needs further processing, such as inspecting the data, this function should return true and proceed as is drop was accepted and if it decides to reject the drop later, it should call DropTargetAsync.rejectDrop(org.gnome.gdk.Drop).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DropTargetAsync.AcceptCallback.run(org.gnome.gdk.Drop)

onDragEnter

public B onDragEnter(DropTargetAsync.DragEnterCallback handler)

Emitted on the drop site when the pointer enters the widget.

It can be used to set up custom highlighting.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DropTargetAsync.DragEnterCallback.run(org.gnome.gdk.Drop, double, double)

onDragLeave

public B onDragLeave(DropTargetAsync.DragLeaveCallback handler)

Emitted on the drop site when the pointer leaves the widget.

Its main purpose it to undo things done in GtkDropTargetAsync::drag-enter.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DropTargetAsync.DragLeaveCallback.run(org.gnome.gdk.Drop)

onDragMotion

public B onDragMotion(DropTargetAsync.DragMotionCallback handler)

Emitted while the pointer is moving over the drop target.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DropTargetAsync.DragMotionCallback.run(org.gnome.gdk.Drop, double, double)

onDrop

public B onDrop(DropTargetAsync.DropCallback handler)

Emitted on the drop site when the user drops the data onto the widget.

The signal handler must determine whether the pointer position is in a drop zone or not. If it is not in a drop zone, it returns false and no further processing is necessary.

Otherwise, the handler returns true. In this case, this handler will accept the drop. The handler must ensure that Drop.finish(java.util.Set<org.gnome.gdk.DragAction>) is called to let the source know that the drop is done. The call to Drop.finish(java.util.Set<org.gnome.gdk.DragAction>) must only be done when all data has been received.

To receive the data, use one of the read functions provided by Drop such as Drop.readAsync(java.lang.String[], int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) or Drop.readValueAsync(org.gnome.glib.Type, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• DropTargetAsync.DropCallback.run(org.gnome.gdk.Drop, double, double)