Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.cit.gvsig.fmap;

import java.awt.Color;

import java.awt.Component;

import java.awt.Dimension;

import java.awt.Graphics;

import java.awt.Graphics2D;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.ComponentEvent;

import java.awt.event.ComponentListener;

import java.awt.event.MouseEvent;

import java.awt.event.MouseListener;

import java.awt.event.MouseMotionListener;

import java.awt.event.MouseWheelEvent;

import java.awt.event.MouseWheelListener;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

import java.util.HashMap;

import java.util.Set;

import javax.swing.JComponent;

import javax.swing.Timer;

import org.cresques.cts.IProjection;

import com.iver.cit.gvsig.fmap.crs.CRSFactory;

import com.iver.cit.gvsig.fmap.edition.commands.CommandListener;

import com.iver.cit.gvsig.fmap.layers.LayerCollectionEvent;

import com.iver.cit.gvsig.fmap.layers.LayerEvent;

import com.iver.cit.gvsig.fmap.tools.BehaviorException;

import com.iver.cit.gvsig.fmap.tools.CompoundBehavior;

import com.iver.cit.gvsig.fmap.tools.Behavior.Behavior;

import com.iver.utiles.exceptionHandling.ExceptionHandlingSupport;

import com.iver.utiles.exceptionHandling.ExceptionListener;

import com.iver.utiles.swing.threads.Cancellable;

/**

 * <p>A component that includes a {@link MapContext MapContext} with support for use it as a particular {@link Behavior Behavior}.</p>

 *

 * <p>A developer can register a set of <code>Behavior</code>, but only one (that can be a composition of several) of them can be active. The active one

 *  defines the way to work and access with its <code>MapContext</code>'s layers. The active behavior, in combination with the appropriate

 *  {@link ToolListener ToolListener} will allow user work with a particular <i>tool</i>.</p>

 *

 * <p>All mouse events produced on this component will be delegated to the current active behavior, the <i>currentMapTool</i>.</p>

 * 

 * <p><b>Drawing process:</b></p>

 * 

 * <p>Uses a double buffer for the drawing process of <code>MapContext</code>'s information.</p>

 * 

 * <p>If the double buffer wasn't created, creates a new one.</p>

 * 

 * <p>Paints the component according the following algorithm:

 * <br>

 *  &nbsp If <i>status</i> is <i>UPDATED</i>:<br>

 *  &nbsp &nbsp If there is a <i>double buffer</i>:<br>

 *  &nbsp &nbsp &nbsp If there is a <i>behavior</i> for managing the <code>MapControl</code> instance, delegates

 *   the drawing process to that behavior, calling: <code><i>behavior_instance</i>.paintComponent(g)</code>.<br>

 *  &nbsp &nbsp &nbsp Else, repaints the current graphical information quickly calling: <code>g.drawImage(image,0,0,null)</code>.<br>

 *  &nbsp Else, (<i>status</i> is <i>OUTDATED</i>, or <i>ONLY_GRAPHICS</i>): executes a quickly repaint of the previous information calling <code>g.drawImage(image,0,0,null)</code>, and creates

 *   a <i>painting request</i> to delegate the heavy drawing process to the {@link Drawer2 Drawer2}'s worker thread, according the <i>SingleWorketThread</i> pattern, starting a timer to update

 *   (invoking <code>repaint()</code>) the view every delay of <code>1000 / drawFrameRate</code> ms. during that heavy drawing process, and if its enabled <code>drawAnimationEnabled</code>. The <i>painting request</i> once is being attended, invokes <code>MapContext</code> to

 *   draw the layers: <code>mapContext.draw(image, g, cancel,mapContext.getScaleView());</code> 

 * <br>

 * <p>Some notes:

 *  <ul>

 *   <li>The painting process can be cancelled calling {@link #cancelDrawing() #cancelDrawing()}.</li>

 *   <li>At last resort, the particular implementation of each layer in a <code>MapControl</code>'s <code>MapContrext</code>

 *    will be that one which will draw the graphical information, and, if supports, which could cancel its drawing subprocess.</li>

 *   <li>It's possible to force repaint all layers, calling {@link #drawMap(boolean doClear) #drawMap(boolean)}.</li>

 *   <li>It's possible repaint only the dirty layers, calling {@link #rePaintDirtyLayers() #rePaintDirtyLayers()}.</li>

 *   <li>It's possible repaint only the {@link GraphicLayer GraphicLayer}, calling {@link #drawGraphics() #drawGraphics()}.</li>

 *  </ul> 

 * </p>

 * 

 * <p><b>Tools:</b></p>

 * 

 * <p>A developer can:

 *   <ul>

 *    <li>Register each tool as:

 *     <ul>

 *      <li>A single behavior: {@link #addMapTool(String, Behavior) #addMapTool(String, Behavior)}.</li>

 *      <li>Or, a compound behavior: {@link #addMapTool(String, Behavior) #addMapTool(String, Behavior)}.</li>

 *     </ul>

 *    </li>

 *    <li>Get the current active tool: {@link #getCurrentMapTool() #getCurrentMapTool()}.</li>

 *    <li>Get the current active tool name: {@link #getCurrentTool() #getCurrentTool()}.</li>

 *    <li>Get a registered tool: {@link #getMapTool(String) #getMapTool(String)}.</li>

 *    <li>Get the name of all tools registered: {@link #getMapToolsKeySet() #getMapToolsKeySet()}.</li>

 *    <li>Get all tools registered, including the name they were registered: {@link #getNamesMapTools() #getNamesMapTools()}.</li>

 *    <li>Determine if has a tool registered: {@link #hasTool(String) #hasTool(String)}.</li>

 *    <li>Set as an active tool, one of the registered: {@link #setTool(String) #setTool(String)}.</li>

 *    <li>Set as active tool, the previous used: {@link #setPrevTool() #setPrevTool()}.</li>

 *    <li>Set the current tool: {@link #setCurrentMapTool(Behavior) #setCurrentMapTool(Behavior)}.</li>

 *    <li>Change the draw frame rate: {@link #setDrawFrameRate(int) #setDrawFrameRate(int)} and {@link #applyFrameRate() #applyFrameRate()}.</li>

 *    <li>Get the draw frame rate: {@link #getDrawFrameRate() #getDrawFrameRate()}.</li>

 *    <li>Determine if will repaint this component each time timer finishes: {@link #isDrawAnimationEnabled() #isDrawAnimationEnabled()}.</li>

 *    <li>Change if will repaint this component each time timer finishes: {@link #setDrawAnimationEnabled(boolean) #setDrawAnimationEnabled(boolean)}.</li>

 *    <li>Get the shared object that determines if a drawing process must be cancelled or can continue: {@link #getCanceldraw() #getCanceldraw()}.</li>

 *   </ul>

 * </p>

 *

 * <p><b>Exception listener:</b></p>

 * 

 * <p> Adding an <code>ExceptionListener</code>, can get notification about any exception produced: 

 *  <ul>

 *   <li>Attending a <i>painting request</i>.</li>

 *   <li>Working with the active tool.</li>

 *   <li>Applying a <i>zoom in</i> or <i>zoom out</i> operation.</li>

 *  </ul>

 * </p>

 * 

 * <p><b>Other:</b></p>

 * 

 * <p>Other useful capabilities of <code>MapControl</code>:

 *   <ul>

 *    <li>Cancel the current drawing process (notifying it also to the inner

 *     <code>MapContext</code> instance and its layers): {@link #cancelDrawing() #cancelDrawing()}.</li>

 *    <li>Applying a <i>zoom in</i> operation centered at mouse position (without a <code>ToolListener</code>): {@link #zoomIn() #zoomIn()}.</li>

 *    <li>Applying a <i>zoom out</i> operation centered at mouse position (without a <code>ToolListener</code>): {@link #zoomOut() #zoomOut()}.</li>

 *   </ul>

 * </p>

 * 

 * @see CancelDraw

 * @see Drawer2

 * @see MapContextListener

 * @see MapToolListener

 * 

 * @author Fernando Gonz?lez Cort?s

 */

public class MapControl extends JComponent implements ComponentListener, CommandListener {

        /**

         * <p>One of the possible status of <code>MapControl</code>. Determines that all visible information has been

         * drawn and its updated.</p> 

         */

        public static final int ACTUALIZADO = 0;

        /**

         * <p>One of the possible status of <code>MapControl</code>. Determines that not all visible information has been

         * drawn or isn't updated.</p> 

         */

        public static final int DESACTUALIZADO = 1;

        /**

         * <p>One of the possible status of <code>MapControl</code>. Determines that only the graphical layer must

         * be drawn / updated.</p> 

         */

        public static final int ONLY_GRAPHICS = 2;

        /**

         * <p>Determines the number of frames.</p>

         *

         * <p>Number of updates per second that the timer will invoke repaint this component.</p>

         */

    private static int drawFrameRate = 3;

    /**

     * <p>Determines if the drawer can update this <code>MapControl</code> instance when the timer launches an event.</p>

     */

    private static boolean drawAnimationEnabled = true;

    // public static final int FAST_PAINT = 3;

        //private static Logger logger = Logger.getLogger(MapControl.class.getName());

    /**

     * <p>Inner model with the layers, event support for drawing them, and the <code>ViewPort</code>

     *  with information to adapt to the bounds available in <i>image coordinates</i>.</p>

     *  

     * @see #getMapContext()

     * @see #setMapContext(MapContext) 

     */

    private MapContext mapContext = null;

    //private boolean drawerAlive = false;

        /**

         * <p>All registered <code>Behavior</code> that can define a way to work with this <code>MapControl</code>.</p>

         * 

         * <p>Only one of them can be active at a given moment.</p>

         * 

         * @see #addMapTool(String, Behavior)

         * @see #addMapTool(String, Behavior[])

         * @see #getMapTool(String)

         * @see #getMapToolsKeySet() 

         * @see #getNamesMapTools()

         */

    protected HashMap namesMapTools = new HashMap();

        /**

         * <p>Active {@link Behavior Behavior} that will generate events according a criterion, and then, with a {@link ToolListener ToolListener}

         *  associated, will simulate to user that works with this component as a particular tool.</p>

         *  

         * @see #getCurrentMapTool()

         * @see #getCurrentTool()

         * @see #setTool(String) 

         */

    protected Behavior currentMapTool = null;

        /**

         * <p>Determines which's the current drawn status of this component:

         * <ul>

         *  <li><b>OUTDATED</b>: all visible information has been drawn or isn't updated.</li>

         *  <li><b>UTDATED</b>: all visible information has been drawn and its updated.</li>

         *  <li><b>ONLY_GRAPHICS</b>: only the graphical layer must be drawn / updated.</li>

         * </ul>

         * </p>

         * 

         * <p>The <code>MapControl</code> drawing process will consider the value of this parameter to decide which elements will

         *  be updated or drawn.</p>

         */

    private int status = DESACTUALIZADO;

        /**

         * <p>Image with a buffer to accelerate the draw the changes of the graphical items in this component.</p>

         * 

         * <p>Firstly, information will be drawn in the buffer, and, when is outright drawn, that information will be displayed.

         * Meanwhile, the previous image can be kept showed.</p>

         * 

         * @see BufferedImage

         * 

         * @see #getImage()

         */

    private BufferedImage image = null;

        /**

         * <p>Name of the tool used currently to interact with this component.</p>

         * 

         * @see #getCurrentTool()

         * @see #setTool(String) 

         */

    protected String currentTool;

        /**

         * <p>Object to store the flag that notifies a drawing thread task and <code>MapContext</code>'s layers,

         * that must be canceled or can continue with the process.</p>

         * 

         * @see #cancelDrawing()

         */

    private CancelDraw canceldraw;

    //private boolean isCancelled = true;

        /**

         * <p>Fires an action events after a specified delay.</p>

         * 

         * <p><code>MapControl</code> will use the timer to update its visible graphical information during

         *  a drawing process, or allowing to cancel that process.</p>

         * 

         * <p>This is very useful to pretend faster interactivity to user when <code>MapControl</code> has

         *  lots of layers, and / or layers with heavy graphical elements, that need a long time to finish

         *  drawing all its data.</p> 

         */

    private Timer timer;

        /**

         * <p>Reference to the {@link ViewPort ViewPort} of the {@link MapContext MapContext} of this component.</p>

         * 

         * <p>The view port once is created an instance of <code>MapControl</code>,

         *  is obtained from the <i>EPSG:23030</i> projection, that's the default projection for this component.</p>

         *  

         * <p>After, the view port will change adapting itself according the current projection and the extent.</p>

         * 

         * @see #getViewPort()

         * 

         * @see ViewPort

         */

    protected ViewPort vp;

    //private Drawer drawer;

        /**

         * <p>Manager of all <code>MapControl</code> painting requests.</p>

         */

    private Drawer2 drawer2;

    // private boolean firstDraw = true;

        /**

         * <p>Listener of all kind of mouse events produced in this component.</p>

         * 

         * <p>Delegates each mouse event to the current map tool.</p>

         * 

         * @see #addMapTool(String, Behavior)

         * @see #addMapTool(String, Behavior[])

         * @see #getMapTool(String)

         * @see #getMapToolsKeySet()

         * @see #getNamesMapTools()

         * @see #setTool(String)

         */

    protected MapToolListener mapToolListener = new MapToolListener();

        /**

         * <p>Listener of all events produced in a this component's <code>MapContext</code>

         * object during an atomic period of time.</p>

         */

    private MapContextListener mapContextListener = new MapContextListener();

        /**

         * <p>Group of <code>ExceptionListener</code> that, in whatever moment could be notified a Throwable Java error or exception.</p>

         * 

         * @see #addExceptionListener(ExceptionListener)

         * @see #removeExceptionListener(ExceptionListener)

         */

    private ExceptionHandlingSupport exceptionHandlingSupport = new ExceptionHandlingSupport();

    /**

     * <p>Name of the previous tool used.</p>

     */

        protected String prevTool;

        /**

     * We need this to avoid not wanted refresh. REMEMBER TO SET TO TRUE!!

     */

    // private boolean paintEnabled = false;

        /**

         * <p>Creates a new <code>MapControl</code> instance with the following characteristics:

         * <ul>

         *  <li><i>Name</i>: MapControl .</li>

         *  <li>Disables the double buffer of <code>JComponent</code> .</li>

         *  <li>Sets opaque <i>(see {@link JComponent#setOpaque(boolean)} )</i>. </li>

         *  <li>Sets its status to <code>OUTDATED</code> .</li>

         *  <li>Creates a new {@link CancelDraw CancelDraw} object to notify <code>MapContext</code>'s layers if can continue processing the drawn or must cancel it.</li>

         *  <li>Creates a new {@link MapContext MapContext} with a new {@link ViewPort ViewPort} in the projection <i>"EPSG:23030"</i> .</li>

         *  <li>Creates a new {@link CommandListener CommandListener} for edition operations.</li>

         *  <li>Creates a new {@link MapToolListener MapToolListener}, and associates it as a listener of whatever kind of mouse events produced in this component.</li>

         *  <li>Creates a new {@link Drawer2 Drawer2} for managing the painting requests.</li>

         *  <li>Creates a new timer that will invoke refresh this component <code>drawFrameRate</code> per second, when is running a drawing process, and its enabled

         *   <code>drawAnimationEnabled</code>.</li>

         * </ul>

         * </p>

         */

        public MapControl() {

                this.setName("MapControl");

                setDoubleBuffered(false);

                setOpaque(true);

                status = DESACTUALIZADO;

                //Clase usada para cancelar el dibujado

                canceldraw = new CancelDraw();

                //Modelo de datos y ventana del mismo

                // TODO: Cuando creamos un mapControl, deber?amos asignar

                // la projecci?n por defecto con la que vayamos a trabajar.

                // 23030 es el c?digo EPSG del UTM30 elipsoide ED50

                vp = new ViewPort(CRSFactory.getCRS("EPSG:23030"));

                setMapContext(new MapContext(vp));

                //eventos

                this.addComponentListener(this);

                this.addMouseListener(mapToolListener);

                this.addMouseMotionListener(mapToolListener);

                this.addMouseWheelListener(mapToolListener);

        this.drawer2 = new Drawer2();

                //Timer para mostrar el redibujado mientras se dibuja

                timer = new Timer(1000/drawFrameRate,

                                new ActionListener() {

                                        public void actionPerformed(ActionEvent e) {

                                                if (drawAnimationEnabled) {

                                                        MapControl.this.repaint();

                                                }

                                        }

                                });

        }

        /**

         * <p>Sets a <code>MapContext</code> to this component.</p>

         * 

         * <p>The <code>MapContext</code> has the <i>model</i>, and most of the <i>view</i>,

         * and <i>control</i> logic of the layers of this component, including a {@link ViewPort ViewPort} to adapt the

         * information to the projection, and to display it in the available area.</p>

         * 

         * <p>If <code>model</code> hadn't a <code>ViewPort</code>, assigns the current one to it, otherwise, use its <code>ViewPort</code>.</p>

         * 

         * <p>After assigning the <code>MapContext</code> and <code>ViewPort</code>, sets the same {@link MapContextListener MapContextListener}

         *  that was using, and changes the <i>status</i> to <code>OUTDATED</code>.</p>

         * 

         * @param model this component's <code>MapContext</code>, that includes the <code>ViewPort</code>.

         * 

         * @see MapContext

         * 

         * @see #getMapContext()

         */

        public void setMapContext(MapContext model) {

                if (mapContext != null) {

                        mapContext.removeAtomicEventListener(mapContextListener);

                }

                mapContext = model;

                if (mapContext.getViewPort() == null) {

                        mapContext.setViewPort(vp);

                } else {

                        vp = mapContext.getViewPort();

                        // vp.setImageSize(new Dimension(getWidth(), getHeight()));

                        //System.err.println("Viewport en setMapContext:" + vp);

                }

                mapContext.addAtomicEventListener(mapContextListener);

                status = DESACTUALIZADO;

        }

        /**

         * <p>Gets this component's {@link MapContext MapContext} projection.</p>

         *

         * @return this component's {@link MapContext MapContext} projection

         * 

         * @see MapContext#getProjection()

         * @see MapControl#setProjection(IProjection)

         */

        public IProjection getProjection() {

                return getMapContext().getProjection();

        }

        /**

         * <p>Sets the projection to this component's {@link MapContext MapContext}.</p>

         *

         * @param proj the kind of projection to this component's {@link MapContext MapContext}

         * 

         * @see MapContext#setProjection(IProjection)

         * @see MapControl#getProjection()

         */

        public void setProjection(IProjection proj) {

                getMapContext().setProjection(proj);

        }

        /**

         * <p>Gets this component's <code>MapContext</code>, with the <i>model</i>, and most of the <i>view</i>,

         * and <i>control</i> logic of the layers of this component, including a {@link ViewPort ViewPort} to adapt the

         * information to the projection, and display it in the available area.</p>

         * 

         * @return this component's <code>MapContext</code>, that includes the <code>ViewPort</code> used to project the

         * graphical information, and display it in the available area

         * 

         * @see MapContext

         * 

         * @see MapControl#setMapContext(MapContext)

         */

        public MapContext getMapContext() {

                return mapContext;

        }

        /**

         * <p>Registers a new behavior to this component.</p>

         * 

         * <p>According the nature of the {@link Behavior Behavior}, different events will be generated. Those

         *  events can be caught by a particular {@link ToolListener ToolListener}, allowing user to interact with this

         *  <code>MapControl</code> object as a <i>tool</i>.</p>

         *

         * @param name name to identify the behavior to add

         * @param tool the behavior to add

         * 

         * @see #addMapTool(String, Behavior[])

         * @see #getNamesMapTools()

         * @see #getMapToolsKeySet()

         * @see #hasTool(String)

         */

        public void addMapTool(String name, Behavior tool) {

                namesMapTools.put(name, tool);

                tool.setMapControl(this);

        }

        /**

         * <p>Registers a new behavior to this component as a {@link CompoundBehavior CompoundBehavior} made up of <code>tools</code>.</p>

         * 

         * <p>According the nature of the behaviors registered, different events will be generated. Those

         *  events can be caught by a particular {@link ToolListener ToolListener}, allowing user to interact with this

         *  <code>MapControl</code> object as a <i>tool</i>.</p>

         *

         * @param name name to identify the compound behavior to add

         * @param tools the compound behavior to add

         * 

         * @see #addMapTool(String, Behavior)

         * @see #getNamesMapTools()

         * @see #getMapToolsKeySet()

         * @see #hasTool(String)

         */

        public void addMapTool(String name, Behavior[] tools){

                CompoundBehavior tool = new CompoundBehavior(tools);

                addMapTool(name, tool);

        }

        /**

         * <p>Gets the <code>Behavior</code> registered in this component, identified

         *  by <code>name</code>.</p>

         *

         * @param name name of a registered behavior

         * 

         * @return tool the registered behavior in this component as <code>name</code>, or <code>null</code> if

         *  no one has that identifier

         *  

         * @see #addMapTool(String, Behavior)

         * @see #addMapTool(String, Behavior[])

         * @see #hasTool(String)

         */

        public Behavior getMapTool(String name) {

                return (Behavior)namesMapTools.get(name);

        }

        /**

         * <p>Returns a set view of the keys that identified the tools

         *  registered.</p>

         *

         * @return a set view of the keys that identified the tools registered

         * 

         * @see HashMap#keySet()

         * 

         * @see #getNamesMapTools()

          * @see #addMapTool(String, Behavior)

          * @see #addMapTool(String, Behavior[])

         */

        public Set getMapToolsKeySet() {

                return namesMapTools.keySet();

        }

        /**

         * <p>Returns <code>true</code> if this component contains a tool identified by <code>toolName</code>.</p>

         * 

         * @param toolName identifier of the tool

         * 

         * @return <code>true</code> if this component contains a tool identified by <code>toolName</code>; otherwise <code>false</code>

         * 

         * @see #addMapTool(String, Behavior)

         * @see #addMapTool(String, Behavior[])

         */

        public boolean hasTool(String toolName) {

                return namesMapTools.containsKey(toolName);

        }

        /**

         * <p>Sets as current active <code>Behavior</code> associated to this component, that one which

         *  is registered and identified by <code>toolName</code>.</p>

         * 

         * <p>Changing the current active behavior for this <code>MapControl</code>, implies also updating the

         *  previous <i>behavior</i> tool, and the current cursor.</p>

         * 

         * @param toolName name of a registered behavior

         * 

         * @see #getCurrentMapTool()

         * @see #getCurrentTool()

         */

        public void setTool(String toolName) {

                prevTool=getCurrentTool();

                Behavior mapTool = (Behavior) namesMapTools.get(toolName);

                currentMapTool = mapTool;

                currentTool = toolName;

                this.setCursor(mapTool.getCursor());

        }

        /**

         * <p>Gets as current active <code>Behavior</code> associated to this component, that one which

         *  is registered and identified by <code>toolName</code>.</p>

         * 

         * <p>Changing the current active behavior for this <code>MapControl</code>, implies also updating the

         *  previous <i>behavior</i> tool, and the current cursor.</p>

         * 

         * @param toolName name of a registered behavior

         * 

         * @see #getCurrentTool()

         * @see #setTool(String)

         */

        public Behavior getCurrentMapTool(){

                return currentMapTool;

        }

        /**

         * <p>Returns the name of the current selected tool on this MapControl</p>

         *

         * @return the name of the current's behavior tool associated to this component

         * 

         * @see #getCurrentMapTool()

         * @see #setTool(String)

         */

        public String getCurrentTool() {

                return currentTool;

        }

        /**

         * <p>Determines that current drawing process of <code>MapControl</code>'s <code>MapContext</code>'s data must be canceled.</p>

         * 

         * <p>It has no effects if now isn't drawing that graphical information.</p>

         *  

         * <p>At last resort, the particular implementation of each layer in this <code>MapControl</code>'s <code>MapContrext</code>

     *   will be that one which will draw the graphical information, and, if supports, which could cancel its drawing subprocess.</p>

         */

        public void cancelDrawing() {

                /* if (drawer != null) {

                        if (!drawer.isAlive()) {

                                return;

                        }

                }

                */

                canceldraw.setCanceled(true);

                /* while (!isCancelled) {

                        if (!drawer.isAlive()) {

                            // Si hemos llegado aqu? con un thread vivo, seguramente

                            // no estamos actualizados.

                                break;

                        }

                }

                canceldraw.setCancel(false);

                isCancelled = false;

        drawerAlive = false; */

        }

        /**

         * <p>Creates a {@link BufferedImage BufferedImage} image if there was no buffered image, or if

         *  its viewport's image height or width is different from this component's size. Once has created

         *  a double-buffer, fills it with the vieport's background color, or with <i>white</i> if it had no background color.</p>

         * 

         * <p>If no double-buffered existed, creates a {@link BufferedImage BufferedImage} with the size of this component,

         * and as an image with 8-bit RGBA color components packed into integer pixels. That image has a <code>DirectColorModel</code> with alpha.

         * The color data in that image is considered not to be premultiplied with alpha.</p> 

         * 

         * <p>Once has created and filled the new inner <code>MapControl</code>'s double-buffer, changes the status to

         * <code>OUTDATED</code>.</p>

         * 

         * @return <code>true</code> if has created and filled a new double-buffer for this <code>MapControl</code> instance; otherwise <code>false</code>

         */

    private boolean adaptToImageSize()

    {

        if ((image == null) || (vp.getImageWidth() != this.getWidth()) || (vp.getImageHeight() != this.getHeight()))

        {

            image = new BufferedImage(this.getWidth(), this.getHeight(),

                    BufferedImage.TYPE_INT_ARGB);

            // ESTILO MAC

//                image = GraphicsEnvironment.getLocalGraphicsEnvironment()

//                                .getDefaultScreenDevice().getDefaultConfiguration()

//                                .createCompatibleImage(this.getWidth(), this.getHeight());

            vp.setImageSize(new Dimension(getWidth(), getHeight()));

            getMapContext().getViewPort().refreshExtent();

            Graphics gTemp = image.createGraphics();

            Color theBackColor = vp.getBackColor();

            if (theBackColor == null)

                gTemp.setColor(Color.WHITE);

            else

                gTemp.setColor(theBackColor);

            gTemp.fillRect(0,0,getWidth(), getHeight());

            gTemp.dispose();

            status = DESACTUALIZADO;

            // g.drawImage(image,0,0,null);

            return true;

        }

        return false;

    }

        /**

         * <p>Paints the graphical information of this component using a double buffer.</p>

         * 

         * <p>If the double buffer wasn't created, creates a new one.</p>

         * 

         * <p>Paints the component according the following algorithm:

         * <br>

         *  &nbsp If <i>status</i> is <i>UPDATED</i>:<br>

         *  &nbsp &nbsp If there is no <i>double buffer</i>:<br>

         *  &nbsp &nbsp &nbsp If there is a <i>behavior</i> for managing the <code>MapControl</code> instance, delegates

         *   the drawing process to that behavior, calling: <code><i>behavior_instance</i>.paintComponent(g)</code> &nbsp .<br>

         *  &nbsp &nbsp &nbsp Else, repaints the current graphical information quickly calling: <code>g.drawImage(image,0,0,null)</code> &nbsp .<br>

         *  &nbsp Else, (<i>status</i> is <i>OUTDATED</i>, or <i>ONLY_GRAPHICS</i>): executes a quickly repaint of the previous information calling <code>g.drawImage(image,0,0,null)</code>, and creates

         *   a <i>painting request</i> to delegate the heavy drawing process to the {@link Drawer2 Drawer2}'s worker thread, according the <i>SingleWorketThread</i> pattern, starting a timer to update

         *   (invoking <code>repaint()</code> that comprises invoke this method) the view every delay of 360 ms. during the the process drawing.</p>

         * 

           * @see javax.swing.JComponent#paintComponent(java.awt.Graphics)

           * @see Drawer2

         */

        protected void paintComponent(Graphics g) {

        adaptToImageSize();

        /* if (status == FAST_PAINT) {

            System.out.println("FAST_PAINT");

            g.drawImage(image,0,0,null);

            status = ACTUALIZADO;

            return;

        } */

        // System.out.println("PINTANDO MAPCONTROL" + this);

                if (status == ACTUALIZADO) {

                        // LWS logger.debug("Dibujando la imagen obtenida");

                        /*

                         * Si hay un behaviour y la imagen es distinta de null se delega el dibujado

                         * en dicho behaviour

                         */

            if (image != null)

            {

                if (currentMapTool != null)

                    currentMapTool.paintComponent(g);

                else

                    g.drawImage(image,0,0,null);

                                // System.out.println("Pinto ACTUALIZADO");

                        }

                } else if ((status == DESACTUALIZADO)

                || (status == ONLY_GRAPHICS)) {

                        // LWS System.out.println("DESACTUALIZADO: Obteniendo la imagen de la cartograf?a");

                        /* if (isOpaque())

                        {

                            if (image==null)

                            {

                                g.setColor(vp.getBackColor());

                                g.fillRect(0,0,getWidth(), getHeight());

                            }

                            // else g.drawImage(image,0,0,null);

                        } */

            // cancelDrawing();

                        //Se crea la imagen con el color de fonde deseado

                        /* if (image == null)

                        {

                                image = new BufferedImage(this.getWidth(), this.getHeight(),

                                                BufferedImage.TYPE_INT_ARGB);

                                vp.setImageSize(new Dimension(getWidth(), getHeight()));

                                Graphics gTemp = image.createGraphics();

                            Color theBackColor = vp.getBackColor();

                            if (theBackColor == null)

                                gTemp.setColor(Color.WHITE);

                            else

                                gTemp.setColor(theBackColor);

                                gTemp.fillRect(0,0,getWidth(), getHeight());

                                gTemp.dispose();

                                // g.drawImage(image,0,0,null);

                                System.out.println("Imagen con null en DESACTUALIZADO. Width = " + this.getWidth());

                        } */

            // else

            // {

            // if (image != null)

            //  {

                g.drawImage(image,0,0,null);

                drawer2.put(new PaintingRequest());

                timer.start();

            /* }

            else

                return; */

            // }

            /* if (drawerAlive == false)

            {

                drawer = new Drawer(image, canceldraw);

                drawer.start();

                        //Se lanza el tread de dibujado

            } */

                        // status = ACTUALIZADO;

                }

        }

        /**

         * <p>Gets the {@link BufferedImage BufferedImage} used to accelerate the draw of new ''frames'' with changes, 

         * or new graphical items in this component.</p>

         * 

         * @return double buffered image used by this component to accelerate the draw of its graphical information, or

         * <code>null</code> if isn't already created

         * 

         * @see BufferedImage 

         */

        public BufferedImage getImage() {

                return image;

        }

        /**

         * <p>Forces repaint all visible graphical information in this component.</p>

         * 

         * <p>If <code>doClear == true</code>, before repainting, clears all graphics before repainting.</p>

         *

         * @param doClear <code>true</code> if needs clearing graphics drawn on the map

         * 

         * @see #cancelDrawing()

         * @see FLayers#setDirty(boolean)

         */

        public void drawMap(boolean doClear) {

                cancelDrawing();

                //System.out.println("drawMap con doClear=" + doClear);

        status = DESACTUALIZADO;

        getMapContext().getLayers().setDirty(true);

                if (doClear)

        {

//            // image = null; // Se usa para el PAN

            if (image != null)

            {

                Graphics2D g = image.createGraphics();

                g.setColor(Color.BLACK);

////                Color theBackColor = vp.getBackColor();

////                if (theBackColor == null)

////                    g.setColor(Color.WHITE);

////                else

////                    g.setColor(theBackColor);

//                g.fillRect(0, 0, vp.getImageWidth(), vp.getImageHeight());

                g.dispose();

            }

        }

                repaint();

        }

        /**

         * <p>Cancels any current drawing process, changing the status to <code>OUTDATED</code>, and forcing

         * repaint only the layers dirty.</p>

         * 

         * @see #cancelDrawing()

         */

        public void rePaintDirtyLayers()

        {

                cancelDrawing();

        status = DESACTUALIZADO;

        repaint();

        }

        /**

         * <p>Cancels any current drawing process, changing the status to <code>ONLY_GRAPHICS</code>, and forcing

         * repaint only the graphical layer of the <code>MapContext</code>.</p>

         */

    public void drawGraphics() {

        status = ONLY_GRAPHICS;

        repaint();

    }

        /**

         * @see java.awt.event.ComponentListener#componentHidden(java.awt.event.ComponentEvent)

         */

        public void componentHidden(ComponentEvent e) {

        }

        /**

         * @see java.awt.event.ComponentListener#componentMoved(java.awt.event.ComponentEvent)

         */

        public void componentMoved(ComponentEvent e) {

        }

        /**

         * @see java.awt.event.ComponentListener#componentResized(java.awt.event.ComponentEvent)

         */

        public void componentResized(ComponentEvent e) {

                /* image = new BufferedImage(this.getWidth(), this.getHeight(),

                                BufferedImage.TYPE_INT_ARGB);

                Graphics gTemp = image.createGraphics();

                gTemp.setColor(vp.getBackColor());

                gTemp.fillRect(0,0,getWidth(), getHeight());

        System.out.println("MapControl resized");

            // image = null;

            vp.setImageSize(new Dimension(getWidth(), getHeight()));

                getMapContext().getViewPort().setScale(); */

                // drawMap(true);

        }

        /**

         * @see java.awt.event.ComponentListener#componentShown(java.awt.event.ComponentEvent)

         */

        public void componentShown(ComponentEvent e) {

        }

        /**

         * @see ExceptionHandlingSupport#addExceptionListener(ExceptionListener)

         */

        public void addExceptionListener(ExceptionListener o) {

                exceptionHandlingSupport.addExceptionListener(o);

        }

        /**

         * @see ExceptionHandlingSupport#removeExceptionListener(ExceptionListener)

         */

        public boolean removeExceptionListener(ExceptionListener o) {

                return exceptionHandlingSupport.removeExceptionListener(o);

        }

        /**

         * @see ExceptionHandlingSupport#throwException(Throwable)

         */

        protected void throwException(Throwable t) {

                exceptionHandlingSupport.throwException(t);

        }

        /**

         * <p>Represents each <code>MapControl</code>'s data painting request.</p>

         * 

         * <p>The request will be attended by a <code>Drawer2</code>, which will hold it since the <code>Drawer2</code>'s worker

         *  takes it, or arrives a new painting request, which will replace it.</p> 

         */

    private class PaintingRequest

    {

            /**

             * <p>Creates a new <code>PaintingRequest</p> instance.</p>

             */

        public PaintingRequest()

        {

        }

        /**

         * <p><code>MapControl</code> paint process:</p>

         * 

         * <p>

         *  <ul>

         *   <li><i>1.- </i>Cancels all previous <code>MapControl</code>'s drawing processes.</li>

         *   <li><i>2.- </i>If <i>status</i> was OUTDATED:

         *    <ul>

         *     <li><i>2.1.- </i>Fills the background color with viewport's background color, or <i>white</i> if it was undefined.</li>

         *     <li><i>2.2.- </i>Notifies <i>MapContext</i> to be drawn invoking: <code>mapContext.draw(double-buffer, double-buffer's buffer, shared cancel-draw object, mapContext.getScaleView());</code>.</li>

         *     <li><i>2.3.- </i>If <code>canceldraw.isCanceled()</code>

         *      <ul>

         *       <li><i>2.3.1.- </i>Sets <i>status</i> to OUTDATED.</li>

         *       <li><i>2.3.2.- </i>Sets <i>dirty</i> all layers stored in <i>MapContext</i>.</li>

         *      </ul>

         *     </li>

         *     <li><i>2.4.- </i>Else, sets <i>status</i> to UPDATED.</li>

         *    </ul>

         *   </li>

         *   <li><i>3.- </i>Else, if <i>status</i> was ONLY_GRAPHICS:

         *    <ul>

         *     <li><i>3.1.- </i>Sets <i>status</i> to UPDATED.</li>

         *     <li><i>3.2.- </i>Notifies <i>MapContext</i> to be drawn invoking: <code>mapContext.drawGraphics(double-buffer, double-buffer's buffer, shared cancel-draw object, mapContext.getScaleView());</code>.</li>

         *    </ul>

         *   </li>

         *   <li><i>4.- </i>Stops the <i>timer</i>.</li>

         *   <li><i>5.- </i>Repaints this component invoking: <code>repaint();</code></li>

         *  </ul>

         * </p>

         * 

         * @see #cancelDrawing()

         * @see MapContext#draw(BufferedImage, Graphics2D, Cancellable, double)

         * @see MapContext#drawGraphics(BufferedImage, Graphics2D, Cancellable, double)

         * 

         * @see ViewPort

         */

        public void paint()

        {

            try

            {

                    canceldraw.setCanceled(false);

                /* if (image == null)

                {

                    image = new BufferedImage(vp.getImageWidth(), vp.getImageHeight(),

                            BufferedImage.TYPE_INT_ARGB);

                    Graphics gTemp = image.createGraphics();

                    Color theBackColor = vp.getBackColor();

                    if (theBackColor == null)

                        gTemp.setColor(Color.WHITE);

                    else

                        gTemp.setColor(theBackColor);

                    gTemp.fillRect(0,0,getWidth(), getHeight());

                    gTemp.dispose();

                    // g.drawImage(image,0,0,null);

                    System.out.println("Imagen con null en DESACTUALIZADO. Width = " + this.getWidth());

                } */

                Graphics2D g = image.createGraphics();

                ViewPort viewPort = mapContext.getViewPort();

                if (status == DESACTUALIZADO)

                {

                        Graphics2D gTemp = image.createGraphics();

                    Color theBackColor = viewPort.getBackColor();

                    if (theBackColor == null)

                        gTemp.setColor(Color.WHITE);

                    else

                        gTemp.setColor(theBackColor);

                    gTemp.fillRect(0, 0, viewPort.getImageWidth(), viewPort.getImageHeight());

                    // ESTILO MAC

//                  BufferedImage imgMac = new BufferedImage(vp.getImageWidth(), vp.getImageHeight(),

//                          BufferedImage.TYPE_INT_ARGB);

          //

//                  mapContext.draw(imgMac, g, canceldraw, mapContext.getScaleView());

//                  g.drawImage(imgMac, 0, 0, null);

                  // FIN ESTILO MAC

                  // SIN MAC:

                  mapContext.draw(image, g, canceldraw, mapContext.getScaleView());

                  if (!canceldraw.isCanceled()){

                          status=ACTUALIZADO;

                 }else{

                          status=DESACTUALIZADO;

                          getMapContext().getLayers().setDirty(true);

                  }

                }

                else if (status == ONLY_GRAPHICS)

                {

                    status = ACTUALIZADO;

                    mapContext.drawGraphics(image, g, canceldraw,mapContext.getScaleView());

                }

                // status = FAST_PAINT;

              //  drawerAlive = false;

                timer.stop();

                repaint();

            } catch (Throwable e) {

                timer.stop();

              //  isCancelled = true;

                e.printStackTrace();

                throwException(e);

            } finally {

            }

        }

    }

    /**

     * <p>An instance of <code>Drawer2</code> could manage all <code>MapControl</code> painting requests.</p>

     * 

     * <p>Based on the <i>WorkerThread</i> software pattern, creates a worker thread that will attend sequentially

     *  the current waiting painting request, after finishing the previous (that could be by a cancel action).</p>

     * 

     * <p>All new {@link PaintingRequest PaintingRequest} generated will be stored as <i>waiting requests</i> since the worker

     * attends it.</p>

     * 

     * <p>If a worker finished and there was no <i>painting request</i>, the worker would be set to wait until any

     *  <i>painting request</i> would be put.</p>

     * 

     * @author fjp

     */

    public class Drawer2

    {

        // Una mini cola de 2. No acumulamos peticiones de dibujado

        // dibujamos solo lo ?ltimo que nos han pedido.

            /**

             * <p>Painting request that's been attended by the <code>Drawer2</code>'s worker.</p>

             * 

             * @see #put(com.iver.cit.gvsig.fmap.MapControl.PaintingRequest)

             * @see #take()

             */

            private PaintingRequest paintingRequest;

            /**

             * <p>Painting request waiting to be attended by the <code>Drawer2</code>'s worker.</p>

             * 

             * @see #put(com.iver.cit.gvsig.fmap.MapControl.PaintingRequest)

             * @see #take()

             */

            private PaintingRequest waitingRequest;

            /**

             * <p>Determines that the <code>Drawer2</code>'s worker is busy attending a painting request.</p> 

              * 

             * @see #put(com.iver.cit.gvsig.fmap.MapControl.PaintingRequest)

             * @see #take()

             */

        private boolean waiting;

            /**

             * <p>Notifies the <code>Drawer2</code>'s worker to finish or continue with its process.</p>

             * 

             * @see #setShutdown(boolean)

             */

        private boolean shutdown;

        /**

         * <p>Sets this <code>Drawer2</code>'s worker to finish or continue with its process.</p>

         * 

         * @param isShutdown a boolean value

         */

        public void setShutdown(boolean isShutdown)

        {

            shutdown = isShutdown;

        }

        /**

         * <p>Creates a new drawer for managing all data painting requests in <code>MapControl</code>.</p>

         * 

         * <p>Includes the following steps:

         *  <ul>

         *   <li>By default, there is no <i>current painting request</i>.</li>

         *   <li>By default, there is no <i>waiting painting request</i>.</li>

         *   <li>By default, the worker thread is waiting no <i>painting request</i>.</li>

         *   <li>By default, the worker thread is running.</li>

         *   <li>Creates and starts a worker thread for attending the <i>painting requests</i>.</li>

         *  </ul>

         * </p>

         */

        public Drawer2()

        {

            paintingRequest = null;

            waitingRequest = null;

            waiting = false;

            shutdown = false;

            new Thread(new Worker()).start();

        }

        /**

         * <p>Sets a <code>PaintingRequest</code> to be attended by the worker thread of this object. If 

         *  this one was waiting, wakes up.</p>

         * 

         * <p>All waiting threads will be notified synchronized.</p>

         * 

         * @param newPaintRequest

         * 

         * @see #take()

         */

        public void put(PaintingRequest newPaintRequest)

        {

            waitingRequest = newPaintRequest;

            if (waiting)

            {

                synchronized (this) {

                    notifyAll();

                }

            }

        }

        /**

         * <p>Used by this object's worker, returns the current waiting drawing request, causing current thread

         *  to wait until another thread invokes {@link #put(com.iver.cit.gvsig.fmap.MapControl.PaintingRequest) #put(com.iver.cit.gvsig.fmap.MapControl.PaintingRequest)},

         *  if there was no waiting request.</p>

         * 

         * <p>All threads will access synchronized to the waiting request.</p>

         * 

         * @return <code>PaintingRequest</code> that was waiting to be attended

         * 

         * @see #put(com.iver.cit.gvsig.fmap.MapControl.PaintingRequest)

         */

        public PaintingRequest take()

        {

            if (waitingRequest == null)

            {

                synchronized (this) {

                    waiting = true;

                    try {

                        wait();

                    }

                    catch (InterruptedException ie)

                    {

                        waiting = false;

                    }

                }

            }

            paintingRequest = waitingRequest;

            waitingRequest = null;

            return paintingRequest;

        }

        /**

         * <p>Thread for attending painting requests.</p>

         * 

         * <p>If there was no double buffer, sets the status to <code>OUTDATED</code> and finishes, otherwise

         *  takes the painting request (it's probably that would wait some time), cancel the previous drawing

         *  process, and starts processing the request.</p>

         * 

         * @see Thread

         */

        private class Worker implements Runnable

        {

                /*

                 * (non-Javadoc)

                 * @see java.lang.Runnable#run()

                 */

                public void run()

            {

                while (!shutdown)

                {

                    PaintingRequest p = take();

                    //System.out.println("Pintando");

                    if (image != null){

                            cancelDrawing();

                        p.paint();

                    } else{

                        status = DESACTUALIZADO;

                    }

                }

            }

        }

    }

        /**

         * <p><code>Drawer</code> is implemented for drawing the layers of a <code>MapControl</code>'s <i>MapContext</i> instance

         *  as a <i>thread</i> of execution.</p>

         *  

         * <p>Draws <code>MapControl</code> according its <i>status</i>:

         *  <ul>

         *   <li><code><i>ONLY_GRAPHICS</i></code>: refreshes only the graphical layer, changing the status to <code><i>UPDATED</i></code>, via

         *    {@linkplain MapContext#drawGraphics(BufferedImage, Graphics2D, Cancellable, double) MapContext#drawGraphics(BufferedImage, Graphics2D, Cancellable, double)}.</li>

         *   <li><code><i>OUTDATED</i></code>: refreshes all layers, changing the status to <code><i>UPDATED</i></code>, via

         *    {@linkplain MapContext#draw(BufferedImage, Graphics2D, Cancellable, double) MapContext#draw(BufferedImage, Graphics2D, Cancellable, double)}.</li>

         *  <ul>

         * </p>

         * 

         * <p>This drawing process is accelerated by a <code>BufferedImage</code>, and can be canceled.</p>

         * 

         * <p>Once the drawing process has finished, the timer stops and this component gets repainted.</p> 

         *

         * @deprecated

         * @author Vicente Caballero Navarro

         */

        public class Drawer extends Thread {

                //private Graphics g;

                /**

                 * <p>Image with a buffer to accelerate the draw the changes of the graphical items in this component.</p>

                 * 

                 * <p>Firstly, information will be drawn in the buffer, and, when is outright drawn, that information will be displayed.

                 * Meanwhile, the previous image can be kept showed.</p>

                 * 

                 * @see BufferedImage

                 */

                private BufferedImage image = null;

                /**

                 * <p>Object to store the flag that notifies the drawing must be canceled or can continue with the process.</p>

                 * 

                 * <p>At last resort, the particular implementation of each layer in a <code>MapControl</code>'s <code>MapContrext</code>

         *   will be which will draw the graphical information, and, if supports, which could cancel its drawing subprocess.</p>

                 */

                private CancelDraw cancel;

                //private boolean threadCancel = false;

                /**

                 * <p>Creates a new <code>Drawer</code> instance.</p>

                 */

                public Drawer(BufferedImage image, CancelDraw cancel)

        {

                        this.image = image;

                        this.cancel = cancel;

         //   drawerAlive = true;

                }

                /**

                 * @see java.lang.Runnable#run()

                 * @see MapContext#draw(BufferedImage, Graphics2D, Cancellable, double)

                 * @see MapContext#drawGraphics(BufferedImage, Graphics2D, Cancellable, double)

                 */

                public void run() {

                        try {

                                // synchronized (Drawer.class) {

                                    Graphics2D g = image.createGraphics();

                                    ViewPort viewPort = mapContext.getViewPort();

                    if (status == DESACTUALIZADO)

                    {

                                        Color theBackColor = viewPort.getBackColor();

                                        if (theBackColor == null)

                                            g.setColor(Color.WHITE);

                                        else

                                            g.setColor(theBackColor);

                                            g.fillRect(0, 0, viewPort.getImageWidth(), viewPort.getImageHeight());

                        status = ACTUALIZADO;

                        mapContext.draw(image, g, cancel,mapContext.getScaleView());

                    }

                    else if (status == ONLY_GRAPHICS)

                    {

                        status = ACTUALIZADO;

                        mapContext.drawGraphics(image, g, cancel,mapContext.getScaleView());

                    }

                                        timer.stop();

                    // status = FAST_PAINT;

                  //  drawerAlive = false;

                                        repaint();

                                // }

                        } catch (Throwable e) {

                            timer.stop();

                                //isCancelled = true;

                e.printStackTrace();

                                throwException(e);

                        } finally {

                        }

                }

        }

        /**

         * <p>An instance of <code>CancelDraw</code> will be shared by all this <code>MapControl</code>'s <code>MapContext</code> layers,

         *  allowing receive a notification that, when they're been drawn, to be cancelled.</p>

         *

         * @see Cancellable

         *

         * @author Fernando Gonz?lez Cort?s

         */

        public class CancelDraw implements Cancellable {

                /**

                 * <p>Determines if the drawing task must be canceled or not.</p>

                 * 

                 * @see #isCanceled()

                 * @see #setCanceled(boolean)

                 */

                private boolean cancel = false;

                /**

                 * Creates a new <code>CancelDraw</code> object.