com.kheops.jmap.client.tools

Class ToolDraw

java.lang.Object

com.kheops.jmap.client.tools.Tool

com.kheops.jmap.client.tools.ToolDraw

All Implemented Interfaces:

JMapEventDispatcher, ViewEventListener, ViewManagerEventListener, java.awt.event.KeyListener, java.util.EventListener

Direct Known Subclasses:

ToolDistance, ToolDrawPoint, ToolDrawPointCoordinate, ToolDrawState

public abstract class ToolDraw
extends Tool
implements ViewEventListener, ViewManagerEventListener, java.awt.event.KeyListener, JMapEventDispatcher

This abstract class provides a base class for the drawing tools. It contains a few common variables, methods and implements ViewEventListener and KeyListener interfaces.

Field Summary

Fields

Modifier and Type	Field and Description
protected AltKeyManager	altKeyEventManager
protected boolean	altLastPressed
protected boolean	createStyledElement
protected java.awt.Cursor	cursorCrosshair
protected java.awt.Cursor	cursorWait
protected java.text.DecimalFormat	df
protected boolean	displayLabel
protected VectorLayer	drawLayer
protected int	drawLayerId
protected EditionEventDispatcher	eventDispatcher
protected Point	firstPointWc
protected static int	ID_DISTANCE_LINE
protected static int	ID_LABEL
protected static int	ID_LINE_TMP
protected static int	ID_SNAP_POINT
protected boolean	isPersistant
protected Point	lastMousePositionDc
protected Point	secPointWc
protected boolean	showAttributesEditor
protected Layer[]	snapLayers
protected StyleContainer	styleContainer
protected K2DTransform	t
protected Rectangle	toRedrawDc
protected boolean	useHighlightHandles
protected boolean	useUndoManager

Fields inherited from class com.kheops.jmap.client.tools.Tool

autoPan, cursor, view

Constructor Summary

Constructors

Constructor and Description
ToolDraw() Initiates this drawing tool so that it isn't persistent, won't display any label and draws elements in the default user drawing layer.
ToolDraw(int nbDecimals, boolean displayLabel, boolean isPersistant, int drawLayerId, StyleContainer styleContainer, boolean useUndoManager) Initiates this drawing tool

Method Summary

Modifier and Type	Method and Description
void	addEditionEventListener(EditionEventListener listener)
protected boolean	altIsPressed(java.awt.event.MouseEvent me) Determine if ALT key was pressed when this mouse event occurred.
protected boolean	altLastPressed()
protected boolean	ctrlIsPressed(java.awt.event.MouseEvent me) Determine if CTRL key was pressed when this mouse event occurred.
void	dispatchEvent(JMapEvent event) The dispatchEvent method is used to dispatch synchronously JMap events to all registered listeners.
protected void	fireEditionEvent(EditionEvent event)
protected static StyleContainer	genTrnsprntFillContainer(StyleContainer styleContainer) Initializes and sets the ToolDrawStyleContainer with a transparent fill if its null.
java.awt.Cursor	getCursor() returns the cursor
VectorLayer	getDrawLayer() Returns the layer used to store the drawn elements.
protected int	getLabelAlignment()
static Style	getLabelStyle() Initializes and sets the Style with parameters Color, labelPosition, etc...
static Style	getLineStyle() Initializes and sets the Style with parameters LineThickness, RenderingHints.
StyleContainer	getStyleContainer()
void	init(View view) Initiates this drawing tool: Sets the view, the K2DTransform and sets the layer if none was specified before
protected EditionEventDispatcher	initEventDispatcher()
boolean	isCreateStyledElement() Determines if the elements draw using this tool are styled elements (style defined by the style container).
boolean	isPersistant() Deprecated. use isPersistent instead
boolean	isPersistent() Determines if the elements drawn using this tool are persisted (placed on a layer).
boolean	isUseUndoManager()
void	keyPressed(java.awt.event.KeyEvent e) KeyListener methods
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
static Geometry	offsetGeometry(Geometry geo, Point offset) Add an offset to geometry.
void	removeEditionEventListener(EditionEventListener listener)
void	setCreateStyledElement(boolean createStyledElement) Specifies if the elements drawn using this tool are styled elements (style defined by the style container).
void	setDrawLayer(VectorLayer drawLayer) Changes the layer used to store the drawn elements.
void	setPersistant(boolean isPersistent) Deprecated. use setPersistent instead
void	setPersistent(boolean isPersistent) Specifies if the elements drawn using this tool are persisted (placed on a layer).
void	setShowAttributesEditor(boolean showAttributesEditor) Specifies id the attributes editor will show when adding a new element.
void	setStyleContainer(StyleContainer styleContainer)
void	setUseUndoManager(boolean useUndoManager) Sets whether this tool uses the UndoManager.
protected boolean	shiftIsPressed(java.awt.event.MouseEvent me) Determine if SHIFT key was pressed when this mouse event occurred.
void	terminate() Terminates the current tool
static Geometry	unoffsetGeometry(Geometry geo, Point offset) Remove an offset from geometry.
protected void	updatePtMouseVars(Point p, double x, double y) sets the WC location of the specified point using the current transform and DC coordinates
protected void	updatePtMouseVars(Point p, java.awt.event.MouseEvent me) sets the WC location of the specified point using the current transform and DC coordinates
void	viewActivated(ViewActivatedEvent e) ViewManagerEventListener methods
void	viewAdded(ViewAddedEvent e) This method handles viewAdded
void	viewChangedOccurred(ViewChangedEvent e) This method handles ViewChangedEvent
void	viewDeactivated(ViewDeactivatedEvent e) This method handles viewActivated
void	viewPopupMenuShowing(ViewPopupMenuShowingEvent e) This method handles ViewPopupMenuShowing
void	viewReadyOccurred(ViewReadyEvent e) This method handles ViewReadyOccurred
void	viewRedrawOccurred(ViewRedrawEvent e) This method handles viewRedrawOccurred
void	viewRemoved(ViewRemovedEvent e) This method handles viewRemoved
void	viewRepaintOccurred(ViewRepaintEvent e) This method handles viewRepaintOccurred
void	viewStaticElementChanged(ViewStaticElementEvent e) This method handles viewStaticElementChanged
void	viewToolChangedOccurred(ViewToolChangedEvent e) ViewEventListener methods

Methods inherited from class com.kheops.jmap.client.tools.Tool

getView, isAutoPan, onToolClicked, onToolDragged, onToolMoved, onToolPressed, onToolReleased, setAutoPan, toWCPoint

Methods inherited from class java.lang.Object

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

Field Detail

cursorCrosshair

protected java.awt.Cursor cursorCrosshair

cursorWait

protected java.awt.Cursor cursorWait

df

protected java.text.DecimalFormat df

toRedrawDc

protected Rectangle toRedrawDc

firstPointWc

protected Point firstPointWc

secPointWc

protected Point secPointWc

lastMousePositionDc

protected Point lastMousePositionDc

isPersistant

protected boolean isPersistant

displayLabel

protected boolean displayLabel

drawLayer

protected VectorLayer drawLayer

drawLayerId

protected int drawLayerId

t

protected K2DTransform t

styleContainer

protected StyleContainer styleContainer

useUndoManager

protected boolean useUndoManager

snapLayers

protected Layer[] snapLayers

useHighlightHandles

protected boolean useHighlightHandles

altKeyEventManager

protected AltKeyManager altKeyEventManager

createStyledElement

protected boolean createStyledElement

eventDispatcher

protected EditionEventDispatcher eventDispatcher

ID_SNAP_POINT

protected static final int ID_SNAP_POINT

See Also:

Constant Field Values

ID_LABEL

protected static final int ID_LABEL

See Also:

Constant Field Values

ID_DISTANCE_LINE

protected static final int ID_DISTANCE_LINE

See Also:

Constant Field Values

ID_LINE_TMP

protected static final int ID_LINE_TMP

See Also:

Constant Field Values

altLastPressed

protected boolean altLastPressed

showAttributesEditor

protected boolean showAttributesEditor

Constructor Detail

ToolDraw

public ToolDraw()

Initiates this drawing tool so that it isn't persistent, won't display any label and draws elements in the default user drawing layer.

ToolDraw

public ToolDraw(int nbDecimals,
                boolean displayLabel,
                boolean isPersistant,
                int drawLayerId,
                StyleContainer styleContainer,
                boolean useUndoManager)

Initiates this drawing tool

Parameters:

nbDecimals - The number of decimals to display on the label

displayLabel - if a label displaying the proportions of the element should be drawn

isPersistant - if the element needs to be stored once drawn or if it is just volatile

drawLayerId - the layer where the element is added

styleContainer - the style container

useUndoManager - Whether the UndoManager is used or not

Method Detail

initEventDispatcher

protected EditionEventDispatcher initEventDispatcher()

addEditionEventListener

public void addEditionEventListener(EditionEventListener listener)

removeEditionEventListener

public void removeEditionEventListener(EditionEventListener listener)

dispatchEvent

public void dispatchEvent(JMapEvent event)

The dispatchEvent method is used to dispatch synchronously JMap events to all registered listeners. The main use of the JMapEventDispatcher interface is to dispatch events that were previously added to the JMap event queue.
Note: only EditionEvent will be accepted by this method. Any other JMap event types will cause the tool to throw an exception.

Specified by:

dispatchEvent in interface JMapEventDispatcher

Parameters:

event - the event to be dispatched.

Throws:

java.lang.IllegalArgumentException - will be thrown if the JMapEvent instance is not an instance of the EditionEvent class.

See Also:

JMapEventQueue.push(JMapEvent, JMapEventDispatcher)

fireEditionEvent

protected void fireEditionEvent(EditionEvent event)

genTrnsprntFillContainer

protected static StyleContainer genTrnsprntFillContainer(StyleContainer styleContainer)

Initializes and sets the ToolDrawStyleContainer with a transparent fill if its null. If not null, it just returns the same instance. Used to generate the default style for tools such as ToolSelectBox, ToolZoomInBox, etc..

Returns:

ToolDrawStyleContainer initialized with a transparent fill

init

public void init(View view)

Initiates this drawing tool: Sets the view, the K2DTransform and sets the layer if none was specified before

Overrides:

init in class Tool

Parameters:

view - view instance associated with the tool

terminate

public void terminate()

Terminates the current tool

Overrides:

terminate in class Tool

getCursor

public java.awt.Cursor getCursor()

returns the cursor

Overrides:

getCursor in class Tool

Returns:

the corresponding Cursor instance

See Also:

Cursor

getStyleContainer

public StyleContainer getStyleContainer()

setStyleContainer

public void setStyleContainer(StyleContainer styleContainer)

viewToolChangedOccurred

public void viewToolChangedOccurred(ViewToolChangedEvent e)

ViewEventListener methods

Specified by:

viewToolChangedOccurred in interface ViewEventListener

Parameters:

e - the corresponding ViewToolChangedEvent object

viewChangedOccurred

public void viewChangedOccurred(ViewChangedEvent e)

Description copied from interface: ViewEventListener

This method handles ViewChangedEvent

Specified by:

viewChangedOccurred in interface ViewEventListener

Parameters:

e - the corresponding ViewChangedEvent object

viewRedrawOccurred

public void viewRedrawOccurred(ViewRedrawEvent e)

Description copied from interface: ViewEventListener

This method handles viewRedrawOccurred

Specified by:

viewRedrawOccurred in interface ViewEventListener

Parameters:

e - the corresponding ViewRedrawEvent object

viewRepaintOccurred

public void viewRepaintOccurred(ViewRepaintEvent e)

Description copied from interface: ViewEventListener

This method handles viewRepaintOccurred

Specified by:

viewRepaintOccurred in interface ViewEventListener

Parameters:

e - the corresponding ViewRepaintEvent object

viewStaticElementChanged

public void viewStaticElementChanged(ViewStaticElementEvent e)

Description copied from interface: ViewEventListener

This method handles viewStaticElementChanged

Specified by:

viewStaticElementChanged in interface ViewEventListener

Parameters:

e - the corresponding ViewStaticElementEvent object

viewPopupMenuShowing

public void viewPopupMenuShowing(ViewPopupMenuShowingEvent e)

Description copied from interface: ViewEventListener

This method handles ViewPopupMenuShowing

Specified by:

viewPopupMenuShowing in interface ViewEventListener

Parameters:

e - the corresponding ViewPopupMenuShowingEvent object

viewReadyOccurred

public void viewReadyOccurred(ViewReadyEvent e)

Description copied from interface: ViewEventListener

This method handles ViewReadyOccurred

Specified by:

viewReadyOccurred in interface ViewEventListener

Parameters:

e - the corresponding ViewReadyEvent object

viewActivated

public void viewActivated(ViewActivatedEvent e)

ViewManagerEventListener methods

Specified by:

viewActivated in interface ViewManagerEventListener

Parameters:

e - the corresponding ViewActivatedEvent object

viewDeactivated

public void viewDeactivated(ViewDeactivatedEvent e)

Description copied from interface: ViewManagerEventListener

This method handles viewActivated

Specified by:

viewDeactivated in interface ViewManagerEventListener

Parameters:

e - the corresponding ViewDeactivatedEvent object

viewAdded

public void viewAdded(ViewAddedEvent e)

Description copied from interface: ViewManagerEventListener

This method handles viewAdded

Specified by:

viewAdded in interface ViewManagerEventListener

Parameters:

e - the corresponding ViewAddedEvent object

viewRemoved

public void viewRemoved(ViewRemovedEvent e)

Description copied from interface: ViewManagerEventListener

This method handles viewRemoved

Specified by:

viewRemoved in interface ViewManagerEventListener

Parameters:

e - the corresponding ViewRemovedEvent object

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

KeyListener methods

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

setUseUndoManager

public void setUseUndoManager(boolean useUndoManager)

Sets whether this tool uses the UndoManager. By default it is not used.

Parameters:

useUndoManager -

isUseUndoManager

public boolean isUseUndoManager()

Returns:

true if uses the UndoManager, false otherwise

updatePtMouseVars

protected void updatePtMouseVars(Point p,
                                 double x,
                                 double y)

sets the WC location of the specified point using the current transform and DC coordinates

Parameters:

p - the point which we will set the location in WC with the specified DC coordinates

x - the X coord in DC

y - the Y coord in DC

updatePtMouseVars

protected void updatePtMouseVars(Point p,
                                 java.awt.event.MouseEvent me)

sets the WC location of the specified point using the current transform and DC coordinates

Parameters:

p - the point which we will set the location in WC with the specified DC coordinates

me - the mouse event from which the DC coordinates will be taken.

altIsPressed

protected boolean altIsPressed(java.awt.event.MouseEvent me)

Determine if ALT key was pressed when this mouse event occurred.

Parameters:

me - the mouse event to check if ALT key was pressed.

Returns:

true if ALT key was pressed when the mouse event occurred, otherwise false

altLastPressed

protected boolean altLastPressed()

Returns:

true if ALT key was pressed when the last mouse event occurred, otherwise false

ctrlIsPressed

protected boolean ctrlIsPressed(java.awt.event.MouseEvent me)

Determine if CTRL key was pressed when this mouse event occurred.

Parameters:

me - the mouse event to check if CTRL key was pressed.

Returns:

true if CTRL key was pressed when the mouse event occurred, otherwise false

shiftIsPressed

protected boolean shiftIsPressed(java.awt.event.MouseEvent me)

Determine if SHIFT key was pressed when this mouse event occurred.

Parameters:

me - the mouse event to check if SHIFT key was pressed.

Returns:

true if SHIFT key was pressed when the mouse event occurred, otherwise false

getLabelStyle

public static Style getLabelStyle()

Initializes and sets the Style with parameters Color, labelPosition, etc...

Returns:

Style that will be used to display a label next to the drawing element.

getLineStyle

public static Style getLineStyle()

Initializes and sets the Style with parameters LineThickness, RenderingHints.

Returns:

Style that will be used to display a line over to the drawing element.

unoffsetGeometry

public static Geometry unoffsetGeometry(Geometry geo,
                                        Point offset)

Remove an offset from geometry.

Parameters:

geo - the geometry that should be unoffsetted.

offset - the point contains the offset values.

Returns:

Geometry without offset.

offsetGeometry

public static Geometry offsetGeometry(Geometry geo,
                                      Point offset)

Add an offset to geometry.

Parameters:

geo - the geometry that should be offsetted.

offset - the point contains the offset values.

Returns:

Geometry with offset.

getLabelAlignment

protected int getLabelAlignment()

getDrawLayer

public VectorLayer getDrawLayer()

Returns the layer used to store the drawn elements.

Returns:

the layer used

setDrawLayer

public void setDrawLayer(VectorLayer drawLayer)

Changes the layer used to store the drawn elements.

Parameters:

drawLayer - new layer to use

isPersistant

@Deprecated
public boolean isPersistant()

Deprecated. use isPersistent instead

Determines if the elements drawn using this tool are persisted (placed on a layer).

Returns:

true if the elements are persistent

isPersistent

public boolean isPersistent()

Determines if the elements drawn using this tool are persisted (placed on a layer).

Returns:

true if the elements are persistent

setPersistant

@Deprecated
public void setPersistant(boolean isPersistent)

Deprecated. use setPersistent instead

Specifies if the elements drawn using this tool are persisted (placed on a layer).

Parameters:

isPersistent - new persistent value

setPersistent

public void setPersistent(boolean isPersistent)

Specifies if the elements drawn using this tool are persisted (placed on a layer).

Parameters:

isPersistent - new persistent value

setCreateStyledElement

public void setCreateStyledElement(boolean createStyledElement)

Specifies if the elements drawn using this tool are styled elements (style defined by the style container). Default is true.

Parameters:

createStyledElement -

See Also:

K2DStyledElement

isCreateStyledElement

public boolean isCreateStyledElement()

Determines if the elements draw using this tool are styled elements (style defined by the style container). Default is true.

Returns:

true if styled elements are created

See Also:

K2DStyledElement

setShowAttributesEditor

public void setShowAttributesEditor(boolean showAttributesEditor)

Specifies id the attributes editor will show when adding a new element.

Parameters:

showAttributesEditor -