CADToolAdapter

java.lang.Object
- org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior
- - org.gvsig.editing.gui.cad.CADToolAdapter

All Implemented Interfaces:

IBehavior
```
public class CADToolAdapter
extends Behavior
```
Allows user interact with different CAD tools, on a layer being edited.

There are two ways of interacting:
- With the mouse : user selects any CADTool that produces mouse events as consequence of the actions working with the layer being edited.
- Writing commands in the edition console : most of the CADTool mouse actions can also be called writing a command or a command's parameter in the associated edition console, and pressing the key Enter. If the command isn't valid, will notify it.
The edition has been implemented as a finite machine, with three kind of transitions between states according the parameters introduced:
- First transition type: Point: if text matches with any pattern of parameters needed for any kind of point coordinates.
  There are eight ways of introducing point 2D coordinates:
  - X,Y : absolute cardinal 2D coordinate from the center (0,0) of the CCS Current Coordinate System.
  - @X,Y : relative cardinal 2D distances from the last point added of the CCS. If it's the first point of the geometry, works like X,Y.
  - length< angle : absolute polar 2D coordinate from the center (0,0) of the CCS Current Coordinate System, using angle from the X axis of CCS, and length far away.
  - @length< angle : relative polar 2D coordinate from the last point added of the CCS Current Coordinate System, using angle from the X axis of CCS, and length far away. If it's the first point of the geometry, works like length< angle.
  - *X,Y : like X,Y but using UCS Universal Coordinate System as reference.
  - @*X,Y : like @X,Y but using UCS Universal Coordinate System as reference. If it's the first point of the geometry, works like *X,Y.
  - *length< angle : like length< angle but using UCS Universal Coordinate System as reference.
  - @*length< angle : like @length< angle but using UCS Universal Coordinate System as reference. If it's the first point of the geometry, works like *length< angle.
- Second transition type: Value: if recognizes it as a single number.
- Third transition type: Option: by default, if can't classify the information as a single number neither as a point. This information will be an String and dealt as an option of the current tool state. Ultimately, if isn't valid, text will be rewritten in the console notifying the user that isn't correct.
See Also:
Behavior, MapControl

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABSOLUTE` Identifies that the data are absolute coordinates of the new point from the (0, 0) position.
`static int`	`POLAR_SCP` Identifies that the data are relative polar distances (longitude of the line and angle given in degrees) of the new point from the previous introduced.
`static int`	`POLAR_SCU` Identifies that the data are relative polar distances (longitude of the line and angle given in radians) of the new point from the previous introduced.
`static int`	`RELATIVE_SCP` Equivalent to `CADToolAdapter#ABSOLUTE`.
`static int`	`RELATIVE_SCU` Identifies that the data are relative distances of the new point from the previous introduced.

Fields inherited from class org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior
BUTTON_LEFT, BUTTON_MIDDLE, BUTTON_RIGHT, geomManager

Constructor Summary

Constructors
Constructor and Description

CADToolAdapter()

Constructors
Constructor and Description
`CADToolAdapter()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addCADTool(String name, CADTool c)` Associates and stores the specified name with the specified `CADTool`.
`void`	`askQuestion()` Displays at the console associated to the current active view that's being edited, the question of the following operation that user can do with the current `CADTool`, only if it hasn't just answered.
`void`	`configureMenu()` If there are options related with the `CADTool` at the peek of the CAD tool stack, displays them as a popup.
`void`	`delete()` Removes all geometries selected in the associated `MapControl`.
`GeometryType`	`getActiveLayerGeometryType()` Returns the GeometryType of the current active and vector layer being edited.
`int`	`getActiveLayerType()` Deprecated. use `getActiveLayerGeometryType()` instead. To be removed in gvSIG 2.1
`CADTool`	`getCadTool()` Returns the `CADTool` at the top of the stack without removing it from the CAD tool stack.
`CADTool`	`getCADTool(String text)` Returns the `CADTool` to which the specified name is mapped.
`static CADTool[]`	`getCADTools()` Gets all CAD tools available to edit layers with this tool listener.
`IEditionManager`	`getEditionManager()` Gets the object used to manage the edition of the layers of the associated `MapControl`.
`ToolListener`	`getListener()` Shows or hides a grid on the `ViewPort` of the associated `MapControl`.
`void`	`initializeFlatness()` Initializes the flatness with the defined in preferences.
`boolean`	`isOrtoMode()` Determines if is enabled or not the orto mode.
`void`	`keyPressed(String actionCommand)` Responds to actions of writing common key commands for all kind of CAD operations, enabling/disabling after the controls to manage the available information according the tool selected: eliminar: removes the geometries that are now selected.
`void`	`mouseClicked(MouseEvent e)` Responds two kind of mouse click events: *One click of the third mouse's button*: displays a popup with edition options.
`void`	`mouseDragged(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)` Selects the vertex of a geometry at the point selected on the `MapControl` by pressing the first mouse's button.
`void`	`mouseReleased(MouseEvent e)`
`void`	`mouseWheelMoved(MouseWheelEvent e)` Tries to find the nearest geometry or grid control point by the position of the current snap tool.
`void`	`paintComponent(MapControlDrawer mapControlDrawer)` Draws the selected geometries to edit.
`void`	`popCadTool()` Removes the peek of the CAD tool stack.
`void`	`pushCadTool(CADTool cadTool)` Pushes a `CADTool` onto the top of the CAD tool stack, and sets it as current.
`void`	`refreshEditedLayer()` Applies a lightweight repaint of the active layer being edited.
`void`	`setCadTool(CADTool cadTool)` Empties the CAD tools stack and pushes `cadTool` in it.
`void`	`setMapControl(MapControl mc)` Associates this behavior to a `MapControl` object.
`void`	`setOrtoMode(boolean b)` Enables / disables the orto mode.
`void`	`textEntered(String text)` Process the information written by the user about the next point coordinate, determining the kind of transition according the parameters written.
`void`	`transition(String option)` One of the three kind of transaction methods of the finite machine of edition.

Methods inherited from class org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior
clean, createArc, createArc, createArc, createCircle, createLineString, createPoint, createPoint, getImageCursor, getMapControl, isMyButton, isMyButton, paintComponent, resetMyButton

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ABSOLUTE
```
public static final int ABSOLUTE
```
    Identifies that the data are absolute coordinates of the new point from the (0, 0) position.
    
    See Also:
    Constant Field Values
  - RELATIVE_SCP
```
public static final int RELATIVE_SCP
```
    Equivalent to CADToolAdapter#ABSOLUTE.
    
    See Also:
    Constant Field Values
  - RELATIVE_SCU
```
public static final int RELATIVE_SCU
```
    Identifies that the data are relative distances of the new point from the previous introduced.
    
    See Also:
    Constant Field Values
  - POLAR_SCP
```
public static final int POLAR_SCP
```
    Identifies that the data are relative polar distances (longitude of the line and angle given in degrees) of the new point from the previous introduced.
    
    See Also:
    Constant Field Values
  - POLAR_SCU
```
public static final int POLAR_SCU
```
    Identifies that the data are relative polar distances (longitude of the line and angle given in radians) of the new point from the previous introduced.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - CADToolAdapter
```
public CADToolAdapter()
```
- Method Detail
  - setMapControl
```
public void setMapControl(MapControl mc)
```
    Description copied from interface: IBehavior
    
    Associates this behavior to a MapControl object.
    
    Specified by:
    
    setMapControl in interface IBehavior
    
    Overrides:
    
    setMapControl in class Behavior
    
    Parameters:
    mc - the MapControl object to associate
    See Also:
    IBehavior.getMapControl()
  - paintComponent
```
public void paintComponent(MapControlDrawer mapControlDrawer)
```
    Draws the selected geometries to edit. And, if the snapping is enabled, draws also its effect over them.
    
    Specified by:
    
    paintComponent in interface IBehavior
    
    Overrides:
    
    paintComponent in class Behavior
    
    See Also:
    com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#paintComponent(java.awt.Graphics)
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
                  throws BehaviorException
```
    Responds two kind of mouse click events:
    - One click of the third mouse's button: displays a popup with edition options.
    - Two clicks of the first mouse's button: ends the last cad tool setting as end transition point the event's one.
    Specified by:
    
    mouseClicked in interface IBehavior
    
    Overrides:
    
    mouseClicked in class Behavior
    
    Throws:
    
    BehaviorException - any exception processing the action associated to a mouse clicked event, by the IBehavior object
    See Also:
    com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseClicked(java.awt.event.MouseEvent), CADExtension.showPopup(MouseEvent)
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
                  throws BehaviorException
```
    Specified by:
    
    mouseEntered in interface IBehavior
    
    Overrides:
    
    mouseEntered in class Behavior
    
    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(MouseEvent e)
                 throws BehaviorException
```
    Specified by:
    
    mouseExited in interface IBehavior
    
    Overrides:
    
    mouseExited in class Behavior
    
    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)
  - mousePressed
```
public void mousePressed(MouseEvent e)
                  throws BehaviorException
```
    Selects the vertex of a geometry at the point selected on the MapControl by pressing the first mouse's button.
    
    Specified by:
    
    mousePressed in interface IBehavior
    
    Overrides:
    
    mousePressed in class Behavior
    
    Throws:
    
    BehaviorException - any exception processing the action associated to a mouse pressed event, by the IBehavior object
    See Also:
    com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mousePressed(java.awt.event.MouseEvent)
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
                   throws BehaviorException
```
    Specified by:
    
    mouseReleased in interface IBehavior
    
    Overrides:
    
    mouseReleased in class Behavior
    
    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)
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
                  throws BehaviorException
```
    Specified by:
    
    mouseDragged in interface IBehavior
    
    Overrides:
    
    mouseDragged in class Behavior
    
    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)
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
                throws BehaviorException
```
    Specified by:
    
    mouseMoved in interface IBehavior
    
    Overrides:
    
    mouseMoved in class Behavior
    
    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)
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
                     throws BehaviorException
```
    Tries to find the nearest geometry or grid control point by the position of the current snap tool.
    
    Prioritizes the grid control points than the geometries ones.
    
    If finds any near, stores the map and pixel coordinates for the snap, and enables the bForceCoord attribute for the next draw of the mouse's cursor.
    
    Specified by:
    
    mouseWheelMoved in interface IBehavior
    
    Overrides:
    
    mouseWheelMoved in class Behavior
    
    Parameters:
    point - current mouse 2D position
    
    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)
  - textEntered
```
public void textEntered(String text)
```
    Process the information written by the user about the next point coordinate, determining the kind of transition according the parameters written.
    
    After, invokes one of the three possible transition methods of the finite machine of edition:
    - First transition type: Point: if text matches with any pattern of parameters needed for any kind of point coordinates.
      There are eight ways of introducing point 2D coordinates:
      
      X,Y : absolute cardinal 2D coordinate from the center (0,0) of the CCS Current Coordinate System.
      
      @X,Y : relative cardinal 2D distances from the last point added of the CCS. If it's the first point of the geometry, works like X,Y.
      
      length< angle : absolute polar 2D coordinate from the center (0,0) of the CCS Current Coordinate System, using angle from the X axis of CCS, and length far away.
      
      @length< angle : relative polar 2D coordinate from the last point added of the CCS Current Coordinate System, using angle from the X axis of CCS, and length far away. If it's the first point of the geometry, works like length< angle.
      
      *X,Y : like X,Y but using UCS Universal Coordinate System as reference.
      
      @*X,Y : like @X,Y but using UCS Universal Coordinate System as reference. If it's the first point of the geometry, works like *X,Y.
      
      *length< angle : like length< angle but using UCS Universal Coordinate System as reference.
      
      @*length< angle : like @length< angle but using UCS Universal Coordinate System as reference. If it's the first point of the geometry, works like *length< angle.
    - Second transition type: Value: if recognizes it as a single number.
    - Third transition type: Option: by default, if can't classify the information as a single number neither as a point. This information will be an String and dealt as an option of the current tool state. Ultimately, if isn't valid, text will be rewritten in the console notifying the user that isn't correct.
    Parameters:
    text - command written by user in the edition's console
  - configureMenu
```
public void configureMenu()
```
    If there are options related with the CADTool at the peek of the CAD tool stack, displays them as a popup.
  - transition
```
public void transition(String option)
```
    One of the three kind of transaction methods of the finite machine of edition.
    
    This one deals option as an option of the current tool state. Ultimately, if isn't valid, option will be rewritten in the console notifying the user that isn't correct.
    
    Parameters:
    option - option for the current tool state
    See Also:
    CADTool.transition(String), transition(double[], InputEvent, int), transition(double)
  - getListener
```
public ToolListener getListener()
```
    Shows or hides a grid on the ViewPort of the associated MapControl.
    
    Specified by:
    
    getListener in interface IBehavior
    
    Specified by:
    
    getListener in class Behavior
    
    Parameters:
    value - true to make the grid visible; false to make it invisible
    
    Returns:
    the ToolListener used by this behavior
  - getCadTool
```
public CADTool getCadTool()
```
    Returns the CADTool at the top of the stack without removing it from the CAD tool stack.
    
    Returns:
    the CADTool at the top of the stack
    See Also:
    pushCadTool(CADTool), popCadTool(), setCadTool(CADTool)
  - pushCadTool
```
public void pushCadTool(CADTool cadTool)
```
    Pushes a CADTool onto the top of the CAD tool stack, and sets it as current.
    
    Parameters:
    cadTool - CAD tool to enable as current
    See Also:
    getCadTool(), popCadTool(), setCadTool(CADTool)
  - popCadTool
```
public void popCadTool()
```
    Removes the peek of the CAD tool stack.
    
    See Also:
    pushCadTool(CADTool), getCadTool(), setCadTool(CADTool)
  - askQuestion
```
public void askQuestion()
```
    Displays at the console associated to the current active view that's being edited, the question of the following operation that user can do with the current CADTool, only if it hasn't just answered.
    
    The format of the question will be according the following pattern:
    "\n#"{cadtool at CAD tool stack peek}.getQuestion()">"
  - setCadTool
```
public void setCadTool(CADTool cadTool)
```
    Empties the CAD tools stack and pushes cadTool in it.
    
    Parameters:
    cadTool - CAD tool to set at the peek of the stack
    See Also:
    pushCadTool(CADTool), popCadTool(), getCadTool()
  - delete
```
public void delete()
```
    Removes all geometries selected in the associated MapControl.
  - keyPressed
```
public void keyPressed(String actionCommand)
```
    Responds to actions of writing common key commands for all kind of CAD operations, enabling/disabling after the controls to manage the available information according the tool selected:
    - eliminar: removes the geometries that are now selected.
    - escape: executes different actions according to the current CAD tool of the associated MapControl:
      
      If the tool enabled is identified by cadtooladapter: empties the CAD tools stack, changing the current tool by a SelectionCADTool, which is identified by _selection and allows select features of the active vector layer of the associated MapControl instance.
      
      Otherwise, that means current associated MapControl instance isn't identified by "cadtooladapter", changes the enabled tool by the previous.
    Parameters:
    actionCommand - identifier of the key action command executed by the user
    See Also:
    SelectionCADTool, MapControl.setPrevTool()
  - refreshEditedLayer
```
public void refreshEditedLayer()
```
    Applies a lightweight repaint of the active layer being edited.
    
    All layers under it won't be drawn, only the upper one and whose are over that layer in the TOC.
    
    See Also:
    MapControl.rePaintDirtyLayers()
  - isOrtoMode
```
public boolean isOrtoMode()
```
    Determines if is enabled or not the orto mode.
    
    Returns:
    true if is enabled the orto mode; otherwise false
    See Also:
    setOrtoMode(boolean)
  - setOrtoMode
```
public void setOrtoMode(boolean b)
```
    Enables / disables the orto mode.
    
    Parameters:
    b - the desired value
    See Also:
    isOrtoMode()
  - addCADTool
```
public static void addCADTool(String name,
              CADTool c)
```
    Associates and stores the specified name with the specified CADTool.
    
    Parameters:
    name - name of the tool
    c - CAD tool to interactuate editing the layers
    See Also:
    getCADTools(), getCADTool(String)
  - getCADTools
```
public static CADTool[] getCADTools()
```
    Gets all CAD tools available to edit layers with this tool listener.
    
    Returns:
    CAD tools available to edit layers with this tool listener
    See Also:
    addCADTool(String, CADTool), getCADTool(String)
  - getCADTool
```
public CADTool getCADTool(String text)
```
    Returns the CADTool to which the specified name is mapped.
    
    Parameters:
    text - name of the tool
    
    Returns:
    the CAD tool whose associated name is to be returned
    See Also:
    addCADTool(String, CADTool), getCADTools()
  - getEditionManager
```
public IEditionManager getEditionManager()
```
    Gets the object used to manage the edition of the layers of the associated MapControl.
    
    Returns:
    object used to manage the edition of the layers
    See Also:
    IEditionManager
  - initializeFlatness
```
public void initializeFlatness()
```
    Initializes the flatness with the defined in preferences.
    
    The flatness is the maximum tolerance used to approximate curved lines in a shape by polylines.
    
    The shapes doesn't support primitive like arcs neither other curved lines to draw their geometries, then for drawing any kind of this geometries the curved lines are drawn approximately by a polyline. And for doing more realistic that curves, is used the flatness parameter, that indicates that the difference between each arc and the straight segment that approximates it must be in the worse case, like the flatness.
    
    See Also:
    FConverter#FLATNESS
  - getActiveLayerGeometryType
```
public GeometryType getActiveLayerGeometryType()
```
    Returns the GeometryType of the current active and vector layer being edited.
    
    Returns:
    type of the shape that's the current active and vector layer being edited
    See Also:
    FLyrVect#getGeom
  - getActiveLayerType
```
public int getActiveLayerType()
```
    Deprecated. use getActiveLayerGeometryType() instead. To be removed in gvSIG 2.1
    
    Returns the type of the shape that's the current active and vector layer being edited.
    
    Returns:
    type of geometry that's the current active and vector layer being edited
    See Also:
    FLyrVect.getGeometryType()

Class CADToolAdapter

Field Summary

Fields inherited from class org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior

Constructor Summary

Method Summary

Methods inherited from class org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior

Methods inherited from class java.lang.Object

Field Detail

ABSOLUTE

RELATIVE_SCP

RELATIVE_SCU

POLAR_SCP

POLAR_SCU

Constructor Detail

CADToolAdapter

Method Detail

setMapControl

paintComponent

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

mouseDragged

mouseMoved

mouseWheelMoved

textEntered

configureMenu

transition

getListener

getCadTool

pushCadTool

popCadTool

askQuestion

setCadTool

delete

keyPressed

refreshEditedLayer

isOrtoMode

setOrtoMode

addCADTool

getCADTools

getCADTool

getEditionManager

initializeFlatness

getActiveLayerGeometryType

getActiveLayerType