fr.lri.swingstates.sm

Class DnDStateMachine

java.lang.Object

fr.lri.swingstates.sm.StateMachine

fr.lri.swingstates.sm.BasicInputStateMachine

fr.lri.swingstates.canvas.CStateMachine

fr.lri.swingstates.sm.DnDStateMachine

All Implemented Interfaces:

StateMachineListener, java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public abstract class DnDStateMachine
extends CStateMachine

DnDStateMachine is a predefined state machine to implement "press-drag-release" interactions on shapes contained in a SwingStates' canvas.

DnDStateMachine can be used directly by only overriding actions for press, drag and release (methods pressAction, dragAction and releaseAction.

Example: This program makes shapes drawn in a canvas movable by drag'n drop.

 DnDStateMachine smDragShapes = new DnDStateMachine(BasicInputStateMachine.BUTTON1) {
                        public void dragAction(CShape shape, double previousX, double previousY, double currentX, double currentY) {
                                shape.translateBy(currentX - previousX, currentY - previousY);
                        }
                        public void releaseAction(CShape shape, double previousX, double previousY, double currentX, double currentY) {
                                shape.translateBy(currentX - previousX, currentY - previousY);
                        }
                };
        smDragShapes.attachTo(canvas);
        

Author:

Caroline Appert

Field Summary

Fields

Modifier and Type	Field and Description
State	move The two states (start and move) of this machine.
State	start The two states (start and move) of this machine.

Fields inherited from class fr.lri.swingstates.canvas.CStateMachine

ANIMATION_RESUMED, ANIMATION_STARTED, ANIMATION_STOPPED, ANIMATION_SUSPENDED

Fields inherited from class fr.lri.swingstates.sm.BasicInputStateMachine

ALT, ALT_CONTROL, ALT_CONTROL_SHIFT, ALT_SHIFT, ANYBUTTON, ANYMODIFIER, BUTTON1, BUTTON2, BUTTON3, CONTROL, CONTROL_SHIFT, NOBUTTON, NOMODIFIER, SHIFT

Fields inherited from class fr.lri.swingstates.sm.StateMachine

TIME_OUT

Constructor Summary

Constructors

Constructor and Description
DnDStateMachine(int button) Builds a state machine to manage press-drag-release interactions that are inited on a CShape.
DnDStateMachine(int button, java.lang.Class classTag) Builds a state machine to manage press-drag-release interactions that are inited on a CShape which has a tag of a given class classTag.
DnDStateMachine(int button, CTag tag) Builds a state machine to manage press-drag-release interactions that are inited on a CShape which has a given tag.

Method Summary

Methods

Modifier and Type	Method and Description
void	dragAction(CShape shape, double previousX, double previousY, double currentX, double currentY) The method to override in subclasses to specify action to do when a drag event occurs.
void	pressAction(CShape shape, double currentX, double currentY) The method to override in subclasses to specify action to do when a press event on a CShape occurs.
void	releaseAction(CShape shape, double previousX, double previousY, double currentX, double currentY) The method to override in subclasses to specify action to do when a release event occurs.

Methods inherited from class fr.lri.swingstates.canvas.CStateMachine

attachTo, attachTo, controls, detach, getControlledObjects, greaterPriorityThan, greatestPriority, isAttachedTo, lowerPriorityThan, lowestPriority

Methods inherited from class fr.lri.swingstates.sm.BasicInputStateMachine

addAsListenerOf, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, removeAsListenerOf

Methods inherited from class fr.lri.swingstates.sm.StateMachine

actionPerformed, addStateMachineListener, addStateMachineListener, armTimer, armTimer, consumes, disarmTimer, disarmTimer, doReset, doResume, doSuspend, eventOccured, fireEvent, fireEvent, getAllStates, getCurrentState, getInitialState, getState, hasConsumed, init, initStatesAndTransitions, isActive, isInited, processEvent, processEvent, removeStateMachineListener, removeStateMachineListener, reset, resume, setActive, suspend

Methods inherited from class java.lang.Object

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

Field Detail

start

public State start

The two states (start and move) of this machine.

move

public State move

The two states (start and move) of this machine.

Constructor Detail

DnDStateMachine

public DnDStateMachine(int button)

Builds a state machine to manage press-drag-release interactions that are inited on a CShape.

Parameters:

button - The mouse button for press and release events (constants BUTTON1, BUTTON2, etc. in class BasicInputStateMachine).

See Also:

BasicInputStateMachine.BUTTON1, BasicInputStateMachine.BUTTON2, BasicInputStateMachine.BUTTON3

DnDStateMachine

public DnDStateMachine(int button,
               java.lang.Class classTag)

Builds a state machine to manage press-drag-release interactions that are inited on a CShape which has a tag of a given class classTag.

Parameters:

button - The mouse button for press and release events (constants BUTTON1, BUTTON2, etc. in class BasicInputStateMachine).

classTag - The class of the tag.

See Also:

BasicInputStateMachine.BUTTON1, BasicInputStateMachine.BUTTON2, BasicInputStateMachine.BUTTON3

DnDStateMachine

public DnDStateMachine(int button,
               CTag tag)

Builds a state machine to manage press-drag-release interactions that are inited on a CShape which has a given tag.

Parameters:

button - The mouse button for press and release events (constants BUTTON1, BUTTON2, etc. in class BasicInputStateMachine).

tag - The tag.

See Also:

BasicInputStateMachine.BUTTON1, BasicInputStateMachine.BUTTON2, BasicInputStateMachine.BUTTON3

Method Detail

pressAction

public void pressAction(CShape shape,
               double currentX,
               double currentY)

The method to override in subclasses to specify action to do when a press event on a CShape occurs.

Parameters:

shape - The shape on which occured the press event

currentX - The mouse x-coordinate

currentY - The mouse y-coordinate

dragAction

public void dragAction(CShape shape,
              double previousX,
              double previousY,
              double currentX,
              double currentY)

The method to override in subclasses to specify action to do when a drag event occurs. (the considered drag events are only those that are within a "press-drag-release" sequence inited by a press on a CShape).

Parameters:

shape - The shape on which occured the press event

previousX - The last mouse x-coordinate

previousY - The last mouse y-coordinate

currentX - The mouse x-coordinate

currentY - The mouse y-coordinate

releaseAction

public void releaseAction(CShape shape,
                 double previousX,
                 double previousY,
                 double currentX,
                 double currentY)

The method to override in subclasses to specify action to do when a release event occurs. (the considered release events are only those that are within a "press-drag-release" sequence inited by a press on a CShape).

Parameters:

shape - The shape on which occured the press event

previousX - The last mouse x-coordinate

previousY - The last mouse y-coordinate

currentX - The mouse x-coordinate

currentY - The mouse y-coordinate