org.gvsig.fmap.mapcontrol.tools.Behavior

Class Behavior

java.lang.Object

org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior

All Implemented Interfaces:

IBehavior

Direct Known Subclasses:

CircleBehavior, CompoundBehavior, DraggerBehavior, EllipseBehavior, FreehandBehavior, MouseMovementBehavior, MouseWheelBehavior, MoveBehavior, PointBehavior, PolylineBehavior, RectangleBehavior

public abstract class Behavior
extends java.lang.Object
implements IBehavior

When user is working with a tool on a MapControl instance, Behavior defines the basic ways of interacting: selecting a point, a circle, a rectangle, or ...

All events generated will be MouseEvent, and will depend on the nature of the behavior, like the kind of tool for applying the changes.

Behavior defines the common and basic functionality for all kinds of interacting ways with the MapControl object.

Author:

Luis W. Sevilla

See Also:

IBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_LEFT
static int	BUTTON_MIDDLE
static int	BUTTON_RIGHT
protected org.gvsig.fmap.geom.GeometryManager	geomManager
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
Behavior()
Behavior(int mouseButton)

Method Summary

Modifier and Type	Method and Description
void	clean(MapControlDrawer mapControlDrawer)
protected org.gvsig.fmap.geom.primitive.Arc	createArc(double centerX, double centerY, double radious, double angleStart, double angleExtent) Create an arc.
protected org.gvsig.fmap.geom.primitive.Arc	createArc(java.awt.geom.Point2D p1, java.awt.geom.Point2D p2, java.awt.geom.Point2D p3) Create an Arc.
protected org.gvsig.fmap.geom.primitive.Arc	createArc(org.gvsig.fmap.geom.primitive.Point p1, org.gvsig.fmap.geom.primitive.Point p2, org.gvsig.fmap.geom.primitive.Point p3) Create an arc.
protected org.gvsig.fmap.geom.primitive.Circle	createCircle(double centerX, double centerY, double radious) Create an circle.
protected org.gvsig.fmap.geom.primitive.Ellipse	createEllipse(java.awt.geom.Point2D p1, java.awt.geom.Point2D p2, java.awt.geom.Point2D p3)
protected org.gvsig.fmap.geom.primitive.Point	createPoint(double x, double y) Create point.
protected org.gvsig.fmap.geom.primitive.Point	createPoint(java.awt.geom.Point2D p1) Create a curve point.
java.awt.Image	getImageCursor() Gets the mouse cursor of the tool listener associated to this behavior.
abstract ToolListener	getListener() Gets the ToolListener used by this behavior to perform actions on the associated MapControl object.
MapControl	getMapControl() Returns the reference to the MapControl object that this behavior uses.
boolean	isMyButton()
boolean	isMyButton(java.awt.event.MouseEvent e)
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
void	paintComponent(MapControlDrawer mapControlDrawer) Method executed in real-time, when user is working with a tool on the associated MapControl object, repainting the MapControl's image.
void	paintComponent(MapControlDrawer mapControlDrawer, boolean clean)
void	resetMyButton()
void	setMapControl(MapControl mc) Associates this behavior to a MapControl object.

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_LEFT

public static final int BUTTON_LEFT

See Also:

Constant Field Values

BUTTON_MIDDLE

public static final int BUTTON_MIDDLE

See Also:

Constant Field Values

BUTTON_RIGHT

public static final int BUTTON_RIGHT

See Also:

Constant Field Values

geomManager

protected org.gvsig.fmap.geom.GeometryManager geomManager

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

Behavior

public Behavior()

Behavior

public Behavior(int mouseButton)

Method Detail

clean

public void clean(MapControlDrawer mapControlDrawer)

createArc

protected org.gvsig.fmap.geom.primitive.Arc createArc(double centerX,
                                                      double centerY,
                                                      double radious,
                                                      double angleStart,
                                                      double angleExtent)

Create an arc. If there is an error return null and add the error to the log

Parameters:

centerX -

centerY -

radious -

angleStart -

angleExtent -

Returns:

The arc

createArc

protected org.gvsig.fmap.geom.primitive.Arc createArc(java.awt.geom.Point2D p1,
                                                      java.awt.geom.Point2D p2,
                                                      java.awt.geom.Point2D p3)

Create an Arc. If there is an error return null and add the error to the log

Parameters:

p1 -

p2 -

p3 -

Returns:

The arc

createArc

protected org.gvsig.fmap.geom.primitive.Arc createArc(org.gvsig.fmap.geom.primitive.Point p1,
                                                      org.gvsig.fmap.geom.primitive.Point p2,
                                                      org.gvsig.fmap.geom.primitive.Point p3)

Create an arc. If there is an error return null and add the error to the log

Parameters:

p1 -

p2 -

p3 -

Returns:

The arc

createCircle

protected org.gvsig.fmap.geom.primitive.Circle createCircle(double centerX,
                                                            double centerY,
                                                            double radious)

Create an circle. If there is an error return null and add the error to the log

Parameters:

centerX -

centerY -

radious -

Returns:

The arc

createEllipse

protected org.gvsig.fmap.geom.primitive.Ellipse createEllipse(java.awt.geom.Point2D p1,
                                                              java.awt.geom.Point2D p2,
                                                              java.awt.geom.Point2D p3)

createPoint

protected org.gvsig.fmap.geom.primitive.Point createPoint(double x,
                                                          double y)

Create point. If there is an error return null and add the error to the log

Parameters:

x - The X coordinate

y - The y coordinate

Returns:

The Point

createPoint

protected org.gvsig.fmap.geom.primitive.Point createPoint(java.awt.geom.Point2D p1)

Create a curve point. If there is an error return null and add the error to the log

Parameters:

p1 - The AWT point

Returns:

The gvSIG point

getImageCursor

public java.awt.Image getImageCursor()

Description copied from interface: IBehavior

Gets the mouse cursor of the tool listener associated to this behavior.

Specified by:

getImageCursor in interface IBehavior

Returns:

the mouse cursor of the tool listener associated

getListener

public abstract ToolListener getListener()

Description copied from interface: IBehavior

Gets the ToolListener used by this behavior to perform actions on the associated MapControl object.

Specified by:

getListener in interface IBehavior

Returns:

the ToolListener used by this behavior

getMapControl

public MapControl getMapControl()

Description copied from interface: IBehavior

Returns the reference to the MapControl object that this behavior uses.

Specified by:

getMapControl in interface IBehavior

Returns:

the MapControl object used this behavior

See Also:

IBehavior.setMapControl(MapControl)

isMyButton

public boolean isMyButton()

isMyButton

public boolean isMyButton(java.awt.event.MouseEvent e)

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
                  throws BehaviorException

Specified by:

mouseClicked in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse clicked event, by the IBehavior object

See Also:

MouseListener.mouseClicked(java.awt.event.MouseEvent)

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)
                  throws BehaviorException

Specified by:

mouseDragged in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse dragged event, by the IBehavior object

See Also:

MouseMotionListener.mouseDragged(java.awt.event.MouseEvent)

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)
                  throws BehaviorException

Specified by:

mouseEntered in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse entered event, by the IBehavior object

See Also:

MouseListener.mouseEntered(java.awt.event.MouseEvent)

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)
                 throws BehaviorException

Specified by:

mouseExited in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse exited event, by the IBehavior object

See Also:

MouseListener.mouseExited(java.awt.event.MouseEvent)

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)
                throws BehaviorException

Specified by:

mouseMoved in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse moved event, by the IBehavior object

See Also:

MouseMotionListener.mouseMoved(java.awt.event.MouseEvent)

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)
                  throws BehaviorException

Specified by:

mousePressed in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse pressed event, by the IBehavior object

See Also:

MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
                   throws BehaviorException

Specified by:

mouseReleased in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse released event, by the IBehavior object

See Also:

MouseListener.mouseReleased(java.awt.event.MouseEvent)

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)
                     throws BehaviorException

Specified by:

mouseWheelMoved in interface IBehavior

Throws:

BehaviorException - any exception processing the action associated to a mouse wheel event, by the IBehavior object

See Also:

MouseWheelListener.mouseWheelMoved(java.awt.event.MouseWheelEvent)

paintComponent

public void paintComponent(MapControlDrawer mapControlDrawer)

Description copied from interface: IBehavior

Method executed in real-time, when user is working with a tool on the associated MapControl object, repainting the MapControl's image.

Returns immediately in all cases, even if the complete image has not yet been loaded.

This method will be implemented according to the specific nature of each behavior, and its extra and particular features.

Specified by:

paintComponent in interface IBehavior

See Also:

Graphics.drawImage(java.awt.Image, int, int, java.awt.image.ImageObserver)

paintComponent

public void paintComponent(MapControlDrawer mapControlDrawer,
                           boolean clean)

resetMyButton

public void resetMyButton()

setMapControl

public void setMapControl(MapControl mc)

Description copied from interface: IBehavior

Associates this behavior to a MapControl object.

Specified by:

setMapControl in interface IBehavior

Parameters:

mc - the MapControl object to associate

See Also:

IBehavior.getMapControl()