org.piccolo2d.event

Class PDragEventHandler

java.lang.Object

org.piccolo2d.event.PBasicInputEventHandler

org.piccolo2d.event.PDragSequenceEventHandler

org.piccolo2d.event.PDragEventHandler

All Implemented Interfaces:

EventListener, PInputEventListener

public class PDragEventHandler
extends PDragSequenceEventHandler

PDragEventHandler is a simple event handler for dragging a node on the canvas.

Version:

1.0

Author:

Jesse Grosjean

Constructor Summary

Constructors

Constructor and Description
PDragEventHandler() Constructs a drag event handler which defaults to not raising the node to the top on drag.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	drag(PInputEvent event) Moves the dragged node in proportion to the drag distance.
protected void	endDrag(PInputEvent event) Clears the current drag node.
protected PNode	getDraggedNode() Returns the node that is currently being dragged, or null if none.
boolean	getRaiseToTopOnPress() Returns whether this drag event handler has been informed to raise nodes to the top of all other on drag.
protected void	setDraggedNode(PNode draggedNode) Set's the node that is currently being dragged.
void	setRaiseToTopOnPress(boolean raiseToTopOnPress) Informs this drag event handler whether it should raise nodes to the top when they are dragged.
protected boolean	shouldStartDragInteraction(PInputEvent event) Returns whether the given event should be start a drag interaction.
protected void	startDrag(PInputEvent event) Starts a drag event and moves the dragged node to the front if this handler has been directed to do so with a call to setRaiseToTopOnDrag.

Methods inherited from class org.piccolo2d.event.PDragSequenceEventHandler

dragActivityFinalStep, dragActivityFirstStep, dragActivityStep, getDragActivity, getMinDragStartDistance, getMousePressedCanvasPoint, isDragging, mouseDragged, mousePressed, mouseReleased, setIsDragging, setMinDragStartDistance, startDragActivity, stopDragActivity

Methods inherited from class org.piccolo2d.event.PBasicInputEventHandler

acceptsEvent, getEventFilter, keyboardFocusGained, keyboardFocusLost, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mouseMoved, mouseWheelRotated, mouseWheelRotatedByBlock, processEvent, setEventFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

PDragEventHandler

public PDragEventHandler()

Constructs a drag event handler which defaults to not raising the node to the top on drag.

Method Detail

getDraggedNode

protected PNode getDraggedNode()

Returns the node that is currently being dragged, or null if none.

Returns:

node being dragged or null

setDraggedNode

protected void setDraggedNode(PNode draggedNode)

Set's the node that is currently being dragged.

Parameters:

draggedNode - node to be flagged as this handler's current drag node

shouldStartDragInteraction

protected boolean shouldStartDragInteraction(PInputEvent event)

Returns whether the given event should be start a drag interaction.

Overrides:

shouldStartDragInteraction in class PDragSequenceEventHandler

Parameters:

event - the event being tested

Returns:

true if event is a valid start drag event

startDrag

protected void startDrag(PInputEvent event)

Starts a drag event and moves the dragged node to the front if this handler has been directed to do so with a call to setRaiseToTopOnDrag.

Overrides:

startDrag in class PDragSequenceEventHandler

Parameters:

event - The Event responsible for the start of the drag

drag

protected void drag(PInputEvent event)

Moves the dragged node in proportion to the drag distance.

Overrides:

drag in class PDragSequenceEventHandler

Parameters:

event - event representing the drag

endDrag

protected void endDrag(PInputEvent event)

Clears the current drag node.

Overrides:

endDrag in class PDragSequenceEventHandler

Parameters:

event - Event reponsible for the end of the drag. Usually a "Mouse Up" event.

getRaiseToTopOnPress

public boolean getRaiseToTopOnPress()

Returns whether this drag event handler has been informed to raise nodes to the top of all other on drag.

Returns:

true if dragging a node will raise it to the top

setRaiseToTopOnPress

public void setRaiseToTopOnPress(boolean raiseToTopOnPress)

Informs this drag event handler whether it should raise nodes to the top when they are dragged. Default is false.

Parameters:

raiseToTopOnPress - true if dragging a node should raise it to the top