com.kheops.jmap.client.tools

Class Tool

java.lang.Object

com.kheops.jmap.client.tools.Tool

Direct Known Subclasses:

ToolDraw, ToolInfo, ToolInfoWindow, ToolLabel, ToolPan, ToolPointPan, ToolPrintMap, ToolSelect, ToolSelectionReport, ToolURL

public abstract class Tool
extends java.lang.Object

This abstract class is the base class of all the tools to be used with View objects. It is essentially a mouse event listener with cursor control that receives most events generated by the view. Conceptually, it is used to implement the interactions between the user and the view (View). Derived classes can override the events they are interested to handle. The reference to the View instance is assigned through the init method and it is used to collect the appropriate information and make the necessary changes on the view Here is an example of code to illustrate how tools are used

 public void onToolReleased(MouseEvent e)
 {
   Layer layer;
   K2DElement elem = null;

   // Obtain an array of layers to cycle through them in reverse order (from top to bottom)
   Layer layers[] = view.getLayerManager().getProjectLayers();

   // Transform the event DC coordinate to a WC coordinate
   int xDC = e.getX();
   int yDC = e.getY();
   K2DCoord WCCoord = view.getTransform().transformInv(new Point.Float(xDC, yDC));

   // Cycle through every layer looking for an element under the WC coordinate
   for (int i=layers.length-1; i>=0; i--)
   {
     layer = layers[i];

     // Layer should be visible and displayed at the current scale
     if (!layer.getVisible() || !layer.isDrawable(view.getZoomLevel()))
       continue;

     elem = layer.getElementAtPoint(WCCoord, mainView, true);

     if (elem != null)
     {
       // do something useful with the element

       break;
     }
   }
 }
  

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoPan
protected java.awt.Cursor	cursor
protected View	view

Constructor Summary

Constructors

Constructor and Description
Tool()

Method Summary

Modifier and Type	Method and Description
java.awt.Cursor	getCursor() Gets the cursor to be used on the view when this tool is active.
View	getView() This method gets the View instance associated with the tool
void	init(View view) This method is called by the view when this tool becomes the current active tool of the view.
boolean	isAutoPan()
void	onToolClicked(java.awt.event.MouseEvent e) This method is called by the view (View instance) after mouse clicked events generated by the user.
void	onToolDragged(java.awt.event.MouseEvent e) This method is called by the view (View instance) after mouse dragged events generated by the user.
void	onToolMoved(java.awt.event.MouseEvent e) This method is called by the view (View instance) after mouse moved events generated by the user.
void	onToolPressed(java.awt.event.MouseEvent e) This method is called by the view (View instance) after mouse pressed events generated by the user.
void	onToolReleased(java.awt.event.MouseEvent e) This method is called by the view (View instance) after mouse released events generated by the user.
void	setAutoPan(boolean autoPan) Determines if the tool supports auto pan (automatic panning when mouse cursor is close to view sides)
void	terminate() This method is called by the view when this tool is replaced as the current active tool of the view.
protected Point	toWCPoint(java.awt.event.MouseEvent e) Utility method that returns a point in WC from the specifies mouse event.

Methods inherited from class java.lang.Object

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

Field Detail

cursor

protected java.awt.Cursor cursor

view

protected View view

autoPan

protected boolean autoPan

Constructor Detail

Tool

public Tool()

Method Detail

init

public void init(View view)

This method is called by the view when this tool becomes the current active tool of the view. It sets the proper view instance. Also, subclasses can override this method to do any necessary initialization.

Parameters:

view - view instance associated with the tool

terminate

public void terminate()

This method is called by the view when this tool is replaced as the current active tool of the view. This method will be overridden by subclasses as needed to do any necessary cleaning.

getCursor

public java.awt.Cursor getCursor()

Gets the cursor to be used on the view when this tool is active. It can also be used to change the type of cursor used when the current tool is active by returning a new instance of Cursor.

Returns:

the corresponding Cursor instance

See Also:

Cursor

onToolReleased

public void onToolReleased(java.awt.event.MouseEvent e)

This method is called by the view (View instance) after mouse released events generated by the user. It will handle these events by making the necessary changes. This method should be overridden by the subclasses that needs to perform specific tasks when such events occur.

Parameters:

e - the corresponding mouse event.

onToolDragged

public void onToolDragged(java.awt.event.MouseEvent e)

This method is called by the view (View instance) after mouse dragged events generated by the user. It will handle these events by making the necessary changes. This method should be overridden by the subclasses that needs to perform specific tasks when such events occur.

Parameters:

e - the corresponding mouse event.

onToolPressed

public void onToolPressed(java.awt.event.MouseEvent e)

This method is called by the view (View instance) after mouse pressed events generated by the user. It will handle these events by making the necessary changes. This method should be overridden by the subclasses that needs to perform specific tasks when such events occur.

Parameters:

e - the corresponding mouse event.

onToolMoved

public void onToolMoved(java.awt.event.MouseEvent e)

This method is called by the view (View instance) after mouse moved events generated by the user. It will handle these events by making the necessary changes. This method should be overridden by the subclasses that needs to perform specific tasks when such events occur.

Parameters:

e - the corresponding mouse event.

onToolClicked

public void onToolClicked(java.awt.event.MouseEvent e)

This method is called by the view (View instance) after mouse clicked events generated by the user. It will handle these events by making the necessary changes. This method should be overridden by the subclasses that needs to perform specific tasks when such events occur.

Parameters:

e - the corresponding mouse event.

getView

public View getView()

This method gets the View instance associated with the tool

Returns:

view the corresponding View instance.

isAutoPan

public boolean isAutoPan()

Returns:

true if the tool supports auto pan (automatic panning when mouse cursor is close to view sides)

setAutoPan

public void setAutoPan(boolean autoPan)

Determines if the tool supports auto pan (automatic panning when mouse cursor is close to view sides)

Parameters:

autoPan - the automatic pan status to use

toWCPoint

protected Point toWCPoint(java.awt.event.MouseEvent e)

Utility method that returns a point in WC from the specifies mouse event.

Parameters:

e - the mouse event

Returns:

the WC point