com.simsilica.lemur.dnd

Class DefaultDragSession

java.lang.Object

com.simsilica.lemur.dnd.DefaultDragSession

All Implemented Interfaces:

DragSession

public class DefaultDragSession
extends java.lang.Object
implements DragSession

Field Summary

Fields inherited from interface com.simsilica.lemur.dnd.DragSession

ITEM

Constructor Summary

Constructors

Constructor and Description
DefaultDragSession(com.jme3.scene.Spatial source, com.jme3.math.Vector2f dragLocation)

Method Summary

Modifier and Type	Method and Description
protected void	close(DragEvent event)
<T> T	get(java.lang.String name, T defaultValue) Returns an attribute previously stored in this session or the default value if no such attribute exists.
Draggable	getDraggable() Returns the application-provided "Draggable" that is used to display the current drag location.
com.jme3.math.Vector2f	getDragLocation() Returns the current drag location in 'cursor space', ie: the 2D coordinate of the screen or viewport that indicates the drag location.
com.jme3.scene.Spatial	getDragSource() Returns the container Spatial upon which the drag operation was initiated.
DragStatus	getDragStatus() Return the drop status of this drag session.
com.jme3.collision.CollisionResult	getDropCollision() Returns the current 'drop' collision information or null if there is no current drop target.
com.jme3.scene.Spatial	getDropTarget() Returns the current drop target or null if the drag is not currently over a drop target.
boolean	hasAttribute(java.lang.String name) Returns true if the session has the specified attribute defined.
void	set(java.lang.String name, java.lang.Object attribute) Sets an application-specific session attribute that lives as long as this specific drag session.
protected void	setDraggable(Draggable draggable)
void	setDragStatus(DragStatus status) Called by drop event handlers to indicate that a drop target and location are valid or invalid.
protected void	setDropCollision(com.jme3.collision.CollisionResult collision)
protected void	setDropTarget(com.jme3.scene.Spatial dropTarget, DragEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDragSession

public DefaultDragSession(com.jme3.scene.Spatial source,
                          com.jme3.math.Vector2f dragLocation)

Method Detail

set

public void set(java.lang.String name,
                java.lang.Object attribute)

Description copied from interface: DragSession

Sets an application-specific session attribute that lives as long as this specific drag session. Applications can use this to store their payload or attributes relating to the drag payload or advanced status not provided by the DragSession's normal book-keeping. Most often this is used to store a reference to the dragged item. For standardization, the callers can use the ITEM constant for a default location for dragged items. Setting an attribute to null will remove it from the session.

Specified by:

set in interface DragSession

get

public <T> T get(java.lang.String name,
                 T defaultValue)

Description copied from interface: DragSession

Returns an attribute previously stored in this session or the default value if no such attribute exists.

Specified by:

get in interface DragSession

hasAttribute

public boolean hasAttribute(java.lang.String name)

Description copied from interface: DragSession

Returns true if the session has the specified attribute defined.

Specified by:

hasAttribute in interface DragSession

getDragSource

public com.jme3.scene.Spatial getDragSource()

Description copied from interface: DragSession

Returns the container Spatial upon which the drag operation was initiated.

Specified by:

getDragSource in interface DragSession

setDraggable

protected void setDraggable(Draggable draggable)

getDraggable

public Draggable getDraggable()

Description copied from interface: DragSession

Returns the application-provided "Draggable" that is used to display the current drag location.

Specified by:

getDraggable in interface DragSession

setDragStatus

public void setDragStatus(DragStatus status)

Description copied from interface: DragSession

Called by drop event handlers to indicate that a drop target and location are valid or invalid. If there is no current drop target than the drag status is DragStatus.NoTarget.

Specified by:

setDragStatus in interface DragSession

getDragStatus

public DragStatus getDragStatus()

Description copied from interface: DragSession

Return the drop status of this drag session. If there is no current drop target then the drag status is DragStatus.NoTarget. DragStatus.InvalidTarget indicates that the drag is over a drop target but either the container or the location in the container is not valid.

Specified by:

getDragStatus in interface DragSession

close

protected void close(DragEvent event)

setDropTarget

protected void setDropTarget(com.jme3.scene.Spatial dropTarget,
                             DragEvent event)

getDropTarget

public com.jme3.scene.Spatial getDropTarget()

Description copied from interface: DragSession

Returns the current drop target or null if the drag is not currently over a drop target.

Specified by:

getDropTarget in interface DragSession

getDragLocation

public com.jme3.math.Vector2f getDragLocation()

Description copied from interface: DragSession

Returns the current drag location in 'cursor space', ie: the 2D coordinate of the screen or viewport that indicates the drag location.

Specified by:

getDragLocation in interface DragSession

setDropCollision

protected void setDropCollision(com.jme3.collision.CollisionResult collision)

getDropCollision

public com.jme3.collision.CollisionResult getDropCollision()

Description copied from interface: DragSession

Returns the current 'drop' collision information or null if there is no current drop target.

Specified by:

getDropCollision in interface DragSession