Modifier and Type	Class and Description
public static class	DragAndDrop.Payload The payload of a drag and drop operation.
public abstract static class	DragAndDrop.Source A source where a payload can be dragged from.
public abstract static class	DragAndDrop.Target A target where a payload can be dropped to.

Field Summary

Modifier and Type	Field and Description
pack-priv int	activePointer
private int	button
pack-priv boolean	cancelTouchFocus
pack-priv Actor	dragActor
pack-priv float	dragActorX
pack-priv float	dragActorY
pack-priv DragAndDrop.Source	dragSource
pack-priv int	dragTime
pack-priv long	dragValidTime
pack-priv boolean	isValidTarget
pack-priv boolean	keepWithinStage
pack-priv DragAndDrop.Payload	payload
pack-priv boolean	removeDragActor
pack-priv final ObjectMap<DragAndDrop.Source, DragListener>	sourceListeners
private float	tapSquareSize
pack-priv DragAndDrop.Target	target
pack-priv final Array<DragAndDrop.Target>	targets
pack-priv static final Vector2	tmpVector
pack-priv float	touchOffsetX
pack-priv float	touchOffsetY

Constructor Summary

Access	Constructor and Description
public	DragAndDrop()

Method Summary

Modifier and Type	Method and Description
public void	addSource(final DragAndDrop.Source source)
public void	addTarget(DragAndDrop.Target target)
public void	cancelTouchFocusExcept(DragAndDrop.Source except) Cancels the touch focus for everything except the specified source.
public void	clear() Removes all targets and sources.
public Actor	getDragActor() Returns the current drag actor, or null.
public DragAndDrop.Payload	getDragPayload() Returns the current drag payload, or null.
public DragAndDrop.Source	getDragSource() Returns the current drag source, or null.
public int	getDragTime()
public boolean	isDragging()
public boolean	isDragValid() Returns true if a drag is in progress and the `drag time` has elapsed since the drag started.
public void	removeSource(DragAndDrop.Source source)
public void	removeTarget(DragAndDrop.Target target)
public void	setButton(int button) Sets the button to listen for, all other buttons are ignored.
public void	setCancelTouchFocus(boolean cancelTouchFocus) When true (default), the `Stage#cancelTouchFocus()` touch focus} is cancelled if `dragStart` returns non-null.
public void	setDragActorPosition(float dragActorX, float dragActorY)
public void	setDragTime(int dragMillis) Time in milliseconds that a drag must take before a drop will be considered valid.
public void	setKeepWithinStage(boolean keepWithinStage)
public void	setTapSquareSize(float halfTapSquareSize) Sets the distance a touch must travel before being considered a drag.
public void	setTouchOffset(float touchOffsetX, float touchOffsetY) Sets an offset in stage coordinates from the touch position which is used to determine the drop location.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

activePointer	back to summary
pack-priv int activePointer

button	back to summary
private int button

cancelTouchFocus	back to summary
pack-priv boolean cancelTouchFocus

dragActor	back to summary
pack-priv Actor dragActor

dragActorX	back to summary
pack-priv float dragActorX

dragActorY	back to summary
pack-priv float dragActorY

dragSource	back to summary
pack-priv DragAndDrop.Source dragSource

dragTime	back to summary
pack-priv int dragTime

dragValidTime	back to summary
pack-priv long dragValidTime

isValidTarget	back to summary
pack-priv boolean isValidTarget

keepWithinStage	back to summary
pack-priv boolean keepWithinStage

payload	back to summary
pack-priv DragAndDrop.Payload payload

removeDragActor	back to summary
pack-priv boolean removeDragActor

sourceListeners	back to summary
pack-priv final ObjectMap<DragAndDrop.Source, DragListener> sourceListeners

tapSquareSize	back to summary
private float tapSquareSize

target	back to summary
pack-priv DragAndDrop.Target target

targets	back to summary
pack-priv final Array<DragAndDrop.Target> targets

tmpVector	back to summary
pack-priv static final Vector2 tmpVector

touchOffsetX	back to summary
pack-priv float touchOffsetX

touchOffsetY	back to summary
pack-priv float touchOffsetY

Constructor Detail

DragAndDrop	back to summary
public DragAndDrop()

Method Detail

addSource	back to summary
public void addSource(final DragAndDrop.Source source)

addTarget	back to summary
public void addTarget(DragAndDrop.Target target)

cancelTouchFocusExcept	back to summary
public void cancelTouchFocusExcept(DragAndDrop.Source except) Cancels the touch focus for everything except the specified source.

clear	back to summary
public void clear() Removes all targets and sources.

getDragActor	back to summary
public Actor getDragActor() Returns the current drag actor, or null. Annotations @Null

getDragActor

back to summary

public Actor getDragActor()

Returns the current drag actor, or null.

Annotations

@Null

getDragPayload	back to summary
public DragAndDrop.Payload getDragPayload() Returns the current drag payload, or null. Annotations @Null

getDragPayload

back to summary

public DragAndDrop.Payload getDragPayload()

Returns the current drag payload, or null.

Annotations

@Null

getDragSource	back to summary
public DragAndDrop.Source getDragSource() Returns the current drag source, or null. Annotations @Null

getDragSource

back to summary

public DragAndDrop.Source getDragSource()

Returns the current drag source, or null.

Annotations

@Null

getDragTime	back to summary
public int getDragTime()

isDragging	back to summary
public boolean isDragging()

isDragValid	back to summary
public boolean isDragValid() Returns true if a drag is in progress and the `drag time` has elapsed since the drag started.

removeSource	back to summary
public void removeSource(DragAndDrop.Source source)

removeTarget	back to summary
public void removeTarget(DragAndDrop.Target target)

setButton	back to summary
public void setButton(int button) Sets the button to listen for, all other buttons are ignored. Default is `Buttons#LEFT`. Use -1 for any button.

setCancelTouchFocus	back to summary
public void setCancelTouchFocus(boolean cancelTouchFocus) When true (default), the `Stage#cancelTouchFocus()` touch focus} is cancelled if `dragStart` returns non-null. This ensures the DragAndDrop is the only touch focus listener, eg when the source is inside a `ScrollPane` with flick scroll enabled.

setDragActorPosition	back to summary
public void setDragActorPosition(float dragActorX, float dragActorY)

setDragTime	back to summary
public void setDragTime(int dragMillis) Time in milliseconds that a drag must take before a drop will be considered valid. This ignores an accidental drag and drop that was meant to be a click. Default is 250.

setKeepWithinStage	back to summary
public void setKeepWithinStage(boolean keepWithinStage)

setTapSquareSize	back to summary
public void setTapSquareSize(float halfTapSquareSize) Sets the distance a touch must travel before being considered a drag.

setTouchOffset	back to summary
public void setTouchOffset(float touchOffsetX, float touchOffsetY) Sets an offset in stage coordinates from the touch position which is used to determine the drop location. Default is 0,0.

com.badlogic.gdx.scenes.scene2d.utils back to summary

public Class DragAndDrop.Payload

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.utils.DragAndDrop.Payload

The payload of a drag and drop operation. Actors can be optionally provided to follow the cursor and change when over a target. Such actors will be added the stage automatically during the drag operation as necessary and they will only be removed from the stage if they were added automatically. A source actor can be used as a payload drag actor.

Field Summary

Modifier and Type	Field and Description
pack-priv Actor	dragActor
pack-priv Actor	invalidDragActor
pack-priv Object	object
pack-priv Actor	validDragActor

Constructor Summary

Access	Constructor and Description
public	Payload()

Method Summary

Modifier and Type	Method and Description
public Actor	getDragActor()
public Actor	getInvalidDragActor()
public Object	getObject()
public Actor	getValidDragActor()
public void	setDragActor(Actor dragActor)
public void	setInvalidDragActor(Actor invalidDragActor)
public void	setObject(Object object)
public void	setValidDragActor(Actor validDragActor)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dragActor	back to summary
pack-priv Actor dragActor Annotations @Null

invalidDragActor	back to summary
pack-priv Actor invalidDragActor Annotations @Null

object	back to summary
pack-priv Object object Annotations @Null

validDragActor	back to summary
pack-priv Actor validDragActor Annotations @Null

Constructor Detail

Payload	back to summary
public Payload()

Method Detail

getDragActor	back to summary
public Actor getDragActor() Annotations @Null

getInvalidDragActor	back to summary
public Actor getInvalidDragActor() Annotations @Null

getObject	back to summary
public Object getObject() Annotations @Null

getValidDragActor	back to summary
public Actor getValidDragActor() Annotations @Null

setDragActor	back to summary
public void setDragActor(Actor dragActor)

setInvalidDragActor	back to summary
public void setInvalidDragActor(Actor invalidDragActor)

setObject	back to summary
public void setObject(Object object)

setValidDragActor	back to summary
public void setValidDragActor(Actor validDragActor)

com.badlogic.gdx.scenes.scene2d.utils back to summary

public abstract Class DragAndDrop.Source

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.utils.DragAndDrop.Source

A source where a payload can be dragged from.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv final Actor	actor

Constructor Summary

Access	Constructor and Description
public	Source(Actor actor)

Method Summary

Modifier and Type	Method and Description
public void	drag(InputEvent event, float x, float y, int pointer) Called repeatedly during a drag which started on this source.
public abstract DragAndDrop.Payload	Returns: If null the drag will not affect any targets. dragStart(InputEvent event, float x, float y, int pointer) Called when a drag is started on the source.
public void	dragStop(InputEvent event, float x, float y, int pointer, DragAndDrop.Payload null if dragStart returned null. payload, DragAndDrop.Target null if not dropped on a valid target. target) Called when a drag for the source is stopped.
public Actor	getActor()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

actor	back to summary
pack-priv final Actor actor

Constructor Detail

Source	back to summary
public Source(Actor actor)

Method Detail

drag	back to summary
public void drag(InputEvent event, float x, float y, int pointer) Called repeatedly during a drag which started on this source.

dragStart

back to summary

public abstract DragAndDrop.Payload dragStart(InputEvent event, float x, float y, int pointer)

Called when a drag is started on the source. The coordinates are in the source's local coordinate system.

Returns:DragAndDrop.Payload

If null the drag will not affect any targets.

Annotations

@Null

dragStop

back to summary

public void dragStop(InputEvent event, float x, float y, int pointer, DragAndDrop.Payload payload, DragAndDrop.Target target)

Called when a drag for the source is stopped. The coordinates are in the source's local coordinate system.

Parameters

payload:DragAndDrop.Payload: null if dragStart returned null.
target:DragAndDrop.Target: null if not dropped on a valid target.

getActor	back to summary
public Actor getActor()

com.badlogic.gdx.scenes.scene2d.utils back to summary

public abstract Class DragAndDrop.Target

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.utils.DragAndDrop.Target

A target where a payload can be dropped to.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv final Actor	actor

Constructor Summary

Access	Constructor and Description
public	Target(Actor actor)

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: true if this is a valid target for the payload. drag(DragAndDrop.Source source, DragAndDrop.Payload payload, float x, float y, int pointer) Called when the payload is dragged over the target.
public abstract void	drop(DragAndDrop.Source source, DragAndDrop.Payload payload, float x, float y, int pointer) Called when the payload is dropped on the target.
public Actor	getActor()
public void	reset(DragAndDrop.Source source, DragAndDrop.Payload payload) Called when the payload is no longer over the target, whether because the touch was moved or a drop occurred.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

actor	back to summary
pack-priv final Actor actor

Constructor Detail

Target	back to summary
public Target(Actor actor)

Method Detail

drag

back to summary

public abstract boolean drag(DragAndDrop.Source source, DragAndDrop.Payload payload, float x, float y, int pointer)

Called when the payload is dragged over the target. The coordinates are in the target's local coordinate system.

Returns:boolean: true if this is a valid target for the payload.

drop	back to summary
public abstract void drop(DragAndDrop.Source source, DragAndDrop.Payload payload, float x, float y, int pointer) Called when the payload is dropped on the target. The coordinates are in the target's local coordinate system. This is not called if `drag(Source, Payload, float, float, int)` returned false.

getActor	back to summary
public Actor getActor()

reset	back to summary
public void reset(DragAndDrop.Source source, DragAndDrop.Payload payload) Called when the payload is no longer over the target, whether because the touch was moved or a drop occurred. This is called even if `drag(Source, Payload, float, float, int)` returned false.

public Class DragAndDrop

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DragAndDrop.Payload

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class DragAndDrop.Source

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class DragAndDrop.Target

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail