net.refractions.udig.tools.edit.behaviour
Class DoubleClickRunAcceptBehaviour

java.lang.Object
  net.refractions.udig.tools.edit.behaviour.DoubleClickRunAcceptBehaviour

All Implemented Interfaces:

EventBehaviour

public class DoubleClickRunAcceptBehaviour
extends java.lang.Object
implements EventBehaviour

Requirements:

• EventType==DOUBLE_CLICKED
• EditState==MODIFIED or CREATING
• no modifiers
• button1 clicked
• no buttons down
*

Action:

• Adds the point where double click occurs if addPoint is true. (Default behaviour)
Runs Accept Behaviours
• If current state is CREATING the changes state to MODIFYING

Since:

1.1.0

Author:

jones

Constructor Summary

DoubleClickRunAcceptBehaviour()

Method Summary

UndoableMapCommand	getCommand(EditToolHandler handler, MapMouseEvent e, EventType eventType) The action to be performed by this EventBehaviour.
void	handleError(EditToolHandler handler, java.lang.Throwable error, UndoableMapCommand command) This method is called if an exception occurs during the execution of the run method.
boolean	isAddPoint() Returns true if a point will be added at the location of the double click.
boolean	isValid(EditToolHandler handler, MapMouseEvent e, EventType eventType) Called to determine whether this EventBehaviour is applicable and should be run.
void	setAddPoint(boolean addPoint) Sets the parameter of whether a point should be added at the location of the double click.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleClickRunAcceptBehaviour

public DoubleClickRunAcceptBehaviour()

Method Detail

isValid

public boolean isValid(EditToolHandler handler,
                       MapMouseEvent e,
                       EventType eventType)

Description copied from interface: EventBehaviour

Called to determine whether this EventBehaviour is applicable and should be run.

Specified by:

isValid in interface EventBehaviour

Parameters:

handler - handler that calls this Behaviour

e - mouse event that just occurred.

eventType - the type of event that just occurred

Returns:

true if this mode is applicable and should be run.

handleError

public void handleError(EditToolHandler handler,
                        java.lang.Throwable error,
                        UndoableMapCommand command)

Description copied from interface: EventBehaviour

This method is called if an exception occurs during the execution of the run method.

This method should

1. Rollback the changes made during the run method
2. Log the error in the plugin's log

Specified by:

handleError in interface EventBehaviour

Parameters:

handler - handler that calls this Behaviour

error - Error that occurred

command - Command retrieved from getCommandMethod. May be null if exception occurred while executing getCommand();

getCommand

public UndoableMapCommand getCommand(EditToolHandler handler,
                                     MapMouseEvent e,
                                     EventType eventType)

Description copied from interface: EventBehaviour

The action to be performed by this EventBehaviour. This action takes place in the event thread so it must perform VERY quickly.

Specified by:

getCommand in interface EventBehaviour

Parameters:

handler - handler that calls this Behaviour

e - Event that occurred.

eventType - The type of event that has occurred

Returns:

Command that will be executed in order to perform the behaviour

isAddPoint

public boolean isAddPoint()

Returns true if a point will be added at the location of the double click.

Returns:

Returns true if a point will be added at the location of the double click.

setAddPoint

public void setAddPoint(boolean addPoint)

Sets the parameter of whether a point should be added at the location of the double click.

Parameters:

addPoint - true if a point should be added at the location of the double click.