/[schmitzm]/trunk/src/skrueger/geotools/MapPaneToolBar.java
ViewVC logotype

Diff of /trunk/src/skrueger/geotools/MapPaneToolBar.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 128 by alfonx, Sat May 30 16:27:26 2009 UTC revision 1220 by alfonx, Wed Nov 3 13:09:32 2010 UTC
# Line 1  Line 1 
1  package skrueger.geotools;  /*******************************************************************************
2     * Copyright (c) 2009 Martin O. J. Schmitz.
3  import java.awt.Dimension;   *
4  import java.awt.event.ActionEvent;   * This file is part of the SCHMITZM library - a collection of utility
5  import java.util.ArrayList;   * classes based on Java 1.6, focusing (not only) on Java Swing
6  import java.util.SortedMap;   * and the Geotools library.
7  import java.util.TreeMap;   *
8     * The SCHMITZM project is hosted at:
9  import javax.swing.AbstractAction;   * http://wald.intevation.org/projects/schmitzm/
10  import javax.swing.AbstractButton;   *
11  import javax.swing.BorderFactory;   * This program is free software; you can redistribute it and/or
12  import javax.swing.Icon;   * modify it under the terms of the GNU Lesser General Public License
13  import javax.swing.ImageIcon;   * as published by the Free Software Foundation; either version 3
14  import javax.swing.JButton;   * of the License, or (at your option) any later version.
15  import javax.swing.JComponent;   *
16  import javax.swing.JToggleButton;   * This program is distributed in the hope that it will be useful,
17  import javax.swing.JToolBar;   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  import org.apache.log4j.Logger;   * GNU General Public License for more details.
20     *
21  import schmitzm.geotools.gui.JMapPane;   * You should have received a copy of the GNU Lesser General Public License (license.txt)
22  import schmitzm.geotools.map.event.JMapPaneEvent;   * along with this program; if not, write to the Free Software
23  import schmitzm.geotools.map.event.JMapPaneListener;   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
24  import schmitzm.geotools.map.event.MapAreaChangedEvent;   * or try this link: http://www.gnu.org/licenses/lgpl.html
25  import schmitzm.swing.ButtonGroup;   *
26  import schmitzm.swing.SwingUtil;   * Contributors:
27     *     Martin O. J. Schmitz - initial API and implementation
28  import com.vividsolutions.jts.geom.Envelope;   *     Stefan A. Tzeggai - additional utility classes
29     ******************************************************************************/
30  /**  package skrueger.geotools;
31   * A toolbar to control an {@link JMapPane} (Atlas visualization). This contains two types  
32   * of buttons. A group of <i>tools</i> for the mouse actions on the map represented  import java.awt.Color;
33   * by {@link JToggleButton JToggleButtons}, where only one tool can be activated  import java.awt.Graphics;
34   * every time. And some (general) <i>actions</i>, represented by normal  import java.awt.event.ActionEvent;
35   * {@link JButton JButtons}.  import java.awt.event.ActionListener;
36   * @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)  import java.util.ArrayList;
37   * @version 1.2 Stefan Krüger  import java.util.HashSet;
38   */  import java.util.Set;
39  public class MapPaneToolBar extends JToolBar {  import java.util.SortedMap;
40          private static final Logger LOGGER = Logger.getLogger(MapPaneToolBar.class.getName());  import java.util.TreeMap;
41          /** Constant for the tool "Panning" (10). */  
42          public static final int TOOL_PAN = 10;  import javax.swing.AbstractAction;
43          /** Constant for the tool "Info" (20). */  import javax.swing.AbstractButton;
44          public static final int TOOL_INFO = 20;  import javax.swing.Action;
45          public static final int SEPERATOR0 = 99;  import javax.swing.Icon;
46            import javax.swing.ImageIcon;
47          /** Constant for the tool "Zoom In" (110). */  import javax.swing.JButton;
48          public static final int TOOL_ZOOMIN = 110;  import javax.swing.JComponent;
49          /** Constant for the tool "Zoom Out" (120). */  import javax.swing.JToggleButton;
50          public static final int TOOL_ZOOMOUT = 120;  import javax.swing.JToolBar;
51          /** Constant for the action "Zoom back" (130). */  
52          public static final int ACTION_ZOOM_BACK = 130;  import org.apache.log4j.Logger;
53          /** Constant for the action "Zoom forward" (140). */  
54          public static final int ACTION_ZOOM_FORWARD = 140;  import schmitzm.geotools.gui.GeotoolsGUIUtil;
55          public static final int SEPERATOR1 = 199;  import schmitzm.geotools.gui.SelectableXMapPane;
56            import schmitzm.geotools.gui.XMapPaneEvent;
57          /** Constant for the tool "Select" which sets the Selection to the selected features (210). */  import schmitzm.geotools.gui.XMapPaneTool;
58          public static final int TOOL_SELECTION_SET = 210;  import schmitzm.geotools.map.event.JMapPaneListener;
59          /** Constant for the tool "Selection add" which adds the features to the Selection (220). */  import schmitzm.geotools.map.event.MapAreaChangedEvent;
60          public static final int TOOL_SELECTION_ADD = 220;  import schmitzm.swing.ButtonGroup;
61          /** Constant for the tool "Selection subtract" which removes the selected features from the selection (230). */  import skrueger.swing.SmallButton;
62          public static final int TOOL_SELECTION_REMOVE = 230;  import skrueger.swing.SmallToggleButton;
63          /** Constant for the tool "Selection Reset" which clears the selection (240). */  
64          public static final int TOOL_SELECTION_CLEAR = 240;  import com.vividsolutions.jts.geom.Envelope;
65          public static final int SEPERATOR2 = 299;  
66    /**
67          /** Constant for the action "Search Labels" (120). */   * A toolbar to control an {@link SelectableXMapPane} (Atlas visualization).
68          public static final int ACTION_SEARCH = 300;   * This contains two types of buttons. A group of <i>tools</i> for the mouse
69     * actions on the map represented by {@link JToggleButton JToggleButtons}, where
70          /** Tool currently selected */   * only one tool can be activated every time. And some (general) <i>actions</i>,
71      protected int selectedTool = TOOL_ZOOMIN;   * represented by normal {@link JButton JButtons}.
72         *
73      /** Holds the tool buttons of the tool bar. */   * @author <a href="mailto:[email protected]">Martin Schmitz</a>
74      protected SortedMap<Integer, JComponent> toolAndActionButtons = null;   *         (University of Bonn/Germany)
75      /** Controls that only one tool button is activated. */   * @version 1.2 Stefan Tzeggai
76      protected ButtonGroup toolButtonGroup = null;   */
77    public class MapPaneToolBar extends JToolBar {
78  // SK: Musste ich ändern damit man Tools und Actions in der Reihenfolge mischen kann.              private static final Logger LOGGER = Logger.getLogger(MapPaneToolBar.class
79  //    /** Holds the action buttons of the bar. */                          .getName());
80  //    protected SortedMap<Integer, JButton> actionButtons = null;  
81            public static String R(String key, Object... values) {
82          /** Holds the {@link JMapPane} this tool bar controls. */                  return GeotoolsGUIUtil.R(key, values);
83          protected JMapPane mapPane = null;          }
84    
85          /**          /** Constant for the tool "Panning" (10). */
86           * A List to remember the last Envelopes that have been watched. Used for          public static final int TOOL_PAN = 10;
87           * the zoomBack- and zoomForwardButtons *          /** Constant for the tool "Info" (20). */
88           */          public static final int TOOL_INFO = 20;
89          protected ArrayList<Envelope> lastZooms = new ArrayList<Envelope>();          public static final int SEPERATOR0 = 99;
90          /** Holds the index to the current element in {@link #lastZooms}. */  
91          protected int zoomBackIndex = 0;          /** Constant for the tool "Zoom In" (110). */
92            public static final int TOOL_ZOOMIN = 110;
93          /** Listener to sniff the zoom actions on the map. */          public static final int ACTION_ZOOM_DEFAULT = 150;
94          protected JMapPaneListener mapPaneListener = null;          /** Constant for the tool "Zoom Out" (120). */
95                    public static final int TOOL_ZOOMOUT = 120;
96          protected boolean zoomBackForwardButtonInAction;          /** Constant for the action "Zoom back" (130). */
97            public static final int ACTION_ZOOM_BACK = 130;
98      /**          /** Constant for the action "Zoom forward" (140). */
99       * Creates a new toolbar. Notice: This toolbar does nothing          public static final int ACTION_ZOOM_FORWARD = 140;
100       * until {@link #setMapPane(JMapPane)} is called!          public static final int SEPERATOR1 = 199;
101       */  
102      public MapPaneToolBar() {          /**
103        this(null);           * Constant for the tool "Selection Reset" which clears the selection (240).
104      }           */
105                public static final int TOOL_SELECTION_CLEAR = 240;
106      /**  
107           * Creates a new tool bar.          /**
108           * @param mapPane {@link JMapPane} the tool bar controls           * Constant for the tool "Select" which sets the Selection to the selected
109           */           * features (210).
110          public MapPaneToolBar(JMapPane mapPane) {           */
111            super("Control the map", JToolBar.HORIZONTAL);          public static final int TOOL_SELECTION_SET = 210;
112        this.toolAndActionButtons  = new TreeMap<Integer,JComponent>();          /**
113        this.toolButtonGroup = new ButtonGroup();           * Constant for the tool "Selection add" which adds the features to the
114        // Create a Listener to sniff the zooms on the JMapPane           * Selection (220).
115        this.mapPaneListener = new JMapPaneListener() {           */
116            public void performMapPaneEvent(JMapPaneEvent e) {          public static final int TOOL_SELECTION_ADD = 220;
117                if ( !(e instanceof MapAreaChangedEvent) )          /**
118                  return;           * Constant for the tool "Selection subtract" which removes the selected
119                             * features from the selection (230).
120                if ( zoomBackForwardButtonInAction ) {           */
121                  zoomBackForwardButtonInAction = false;          public static final int TOOL_SELECTION_REMOVE = 230;
122                  return;  
123                }          public static final int ACTION_CHARTS = 401;
124                
125                Envelope oldMapArea = ((MapAreaChangedEvent)e).getOldMapArea();          /** Tool currently selected */
126                if (lastZooms.size() == 0 && oldMapArea != null ) {          protected int selectedTool = TOOL_ZOOMIN;
127                  lastZooms.add(oldMapArea);  
128                  zoomBackIndex = 1;          /** Holds the tool buttons of the tool bar. */
129                }          final protected SortedMap<Integer, JComponent> toolAndActionButtons = new TreeMap<Integer, JComponent>();
130            /** Controls that only one tool button is activated. */
131                final Envelope mapArea = ((MapAreaChangedEvent)e).getNewMapArea();          protected ButtonGroup toolButtonGroup = null;
132                if (mapArea == null)  
133                  return;          // SK: Musste ich ändern damit man Tools und Actions in der Reihenfolge
134                          // mischen kann.
135                if (lastZooms.size() > 0 && mapArea.equals(lastZooms.get(lastZooms.size() - 1))) {          // /** Holds the action buttons of the bar. */
136                  // LOGGER.debug("MapAreaChangedEvent ausgelassen bei der Zaehlung der Zoomschritt weil identisch");          // protected SortedMap<Integer, JButton> actionButtons = null;
137                  return;  
138                }          /** Holds the {@link SelectableXMapPane} this tool bar controls. */
139            protected SelectableXMapPane mapPane = null;
140                if (lastZooms.size() > 0)  
141                  while (zoomBackIndex < lastZooms.size())          /**
142                    lastZooms.remove(lastZooms.size() - 1);           * A List to remember the last Envelopes that have been watched. Used for
143             * the zoomBack- and zoomForwardButtons *
144                lastZooms.add(mapArea);           */
145                zoomBackIndex = lastZooms.size();          protected ArrayList<Envelope> lastZooms = new ArrayList<Envelope>();
146                setButtonEnabled(ACTION_ZOOM_BACK, lastZooms.size() > 1);          /** Holds the index to the current element in {@link #lastZooms}. */
147                setButtonEnabled(ACTION_ZOOM_FORWARD, false);          protected int zoomBackIndex = 0;
148            }  
149        };              /** Listener to sniff the zoom actions on the map. */
150                protected JMapPaneListener mapPaneListener = null;
151        setMapPane(mapPane);  
152            setFloatable(false);          protected boolean zoomBackForwardButtonInAction;
153            setRollover(true);  
154                      /** Listeners what want to be informed about a change of the selected tool **/
155            init();          protected Set<MapPaneToolSelectedListener> toolSelectionListeners = new HashSet<MapPaneToolSelectedListener>();
156          }  
157                    /** This listener is added to all {@link JToggleButton} **/
158          /**          private final ActionListener toolSelectedListener = new ActionListener() {
159           * Sets the {@link JMapPane} controlled by this tool bar.  
160           * @param mapPane {@link JMapPane} to control (if {@code null} this                  @Override
161           *                tool bar controls NOTHING!)                  public void actionPerformed(ActionEvent e) {
162           */                          JToggleButton tb = (JToggleButton) e.getSource();
163          public void setMapPane(JMapPane mapPane) {  
164            // Remove listener from old MapPane                          // Inform the listeners about a newly selected tool
165            if ( this.mapPane != null )                          for (MapPaneToolSelectedListener l : toolSelectionListeners) {
166              this.mapPane.removeMapPaneListener( mapPaneListener );                                  l.toolSelected(Integer.valueOf(tb.getName()));
167        this.mapPane = mapPane;                          }
168        if ( this.mapPane != null && mapPaneListener != null )                  }
169          this.mapPane.addMapPaneListener( mapPaneListener );  
170          }          };
171                    private CrsLabel crsViewer;
172          /**  
173           * Calls {@link #initToolsAndActions()} and {@link #initActions()} and then puts          /**
174           * all tool buttons and all actions buttons to the tool bar.           * Creates a new toolbar. Notice: This toolbar does nothing until
175           */           * {@link #setMapPane(SelectableXMapPane)} is called!
176          protected void init() {           */
177            initToolsAndActions();          public MapPaneToolBar() {
178                          this(null);
179            addSeparator(SEPERATOR0, new JToolBar.Separator());          }
180        addSeparator(SEPERATOR1, new JToolBar.Separator());  
181        addSeparator(SEPERATOR2, new JToolBar.Separator());          public void addButtonSelectedListener(MapPaneToolSelectedListener listener) {
182                          toolSelectionListeners.add(listener);
183            initToolBar();          }
184          }  
185            public void removeButtonSelectedListener(
186                            MapPaneToolSelectedListener listener) {
187          /**                  toolSelectionListeners.remove(listener);
188           * Creates the tool buttons and action buttons and seperators, adds them to          }
189           * {@link #toolAndActionButtons} and finally creates a button group for all tools.  
190           * So sub-classes which override this method should FIRST add their new tool          /**
191           * buttons to {@link #toolAndActionButtons} before calling {@code super.initTools()}.           * Creates a new tool bar.
192           */           *
193          protected void initToolsAndActions() {           * @param mapPane
194        // Panning           *            {@link SelectableXMapPane} the tool bar controls
195        addTool( new MapPaneToolBarAction(           */
196            TOOL_PAN,          public MapPaneToolBar(SelectableXMapPane mapPane) {
197            this,                  super("Control the map", JToolBar.HORIZONTAL);
198            "",  
199            new ImageIcon(MapView.class.getResource("resource/icons/pan.png"))                  // I want to see nothing on the background
200        ), false );                  setOpaque(false);
201        // Info                  setBorder(null);
202        addTool( new MapPaneToolBarAction(  
203            TOOL_INFO,                  this.toolButtonGroup = new ButtonGroup();
204            this,  
205            "",                  // Create a Listener to listen to the zooms on the JMapPane
206            new ImageIcon(MapView.class.getResource("resource/icons/info.png"))                  this.mapPaneListener = new JMapPaneListener() {
207        ), false );                          public void performMapPaneEvent(XMapPaneEvent e) {
208          
209        // Set Selection                                  if (!(e instanceof MapAreaChangedEvent))
210        addTool( new MapPaneToolBarAction(                                          return;
211            TOOL_SELECTION_SET,  
212            this,                                  if (zoomBackForwardButtonInAction) {
213            "",                                          zoomBackForwardButtonInAction = false;
214            new ImageIcon(MapView.class.getResource("resource/icons/selection_set.png"))                                          return;
215        ), false );                                  }
216    
217        // Add Selection                                  final MapAreaChangedEvent mapAreaChangedEvent = (MapAreaChangedEvent) e;
218        addTool( new MapPaneToolBarAction(                                  Envelope oldMapArea = mapAreaChangedEvent.getOldMapArea();
219                    TOOL_SELECTION_ADD,  
220                    this,                                  final Envelope mapArea = mapAreaChangedEvent.getNewMapArea();
221                    "",                                  if (mapArea == null || mapArea.equals(oldMapArea)
222                    new ImageIcon(MapView.class.getResource("resource/icons/selection_add.png"))                                                  || Double.isNaN(mapArea.getMinX())
223        ), false );                                                  || Double.isNaN(mapArea.getMaxX())
224                                                    || Double.isNaN(mapArea.getMinY())
225        // Remove Selection                                                  || Double.isNaN(mapArea.getMaxY())) {
226        addTool( new MapPaneToolBarAction(                                          // If the MapArea didn't change... we don't want to register
227                    TOOL_SELECTION_REMOVE,                                          // it as a zoom action.
228                    this,                                          return;
229                    "",                                  }
230                    new ImageIcon(MapView.class.getResource("resource/icons/selection_remove.png"))  
231        ), false );                                  if (lastZooms.size() == 0
232                                                          && oldMapArea != null
233        // ResetSelection                                                  && !oldMapArea.isNull()
234        addAction( new MapPaneToolBarAction(                                                  && !(Double.isNaN(oldMapArea.getMinX())
235                    TOOL_SELECTION_CLEAR,                                                                  || Double.isNaN(oldMapArea.getMaxX())
236                    this,                                                                  || Double.isNaN(oldMapArea.getMinY()) || Double
237                    "",                                                                  .isNaN(oldMapArea.getMaxY()))) {
238                    new ImageIcon(MapView.class.getResource("resource/icons/selection_clear.png"))                                          lastZooms.add(oldMapArea);
239        ), false );                                          zoomBackIndex = 1;
240                                          }
241        // Zoom in                                  if (mapArea == null)
242        addTool( new MapPaneToolBarAction(                                          return;
243            TOOL_ZOOMIN,  
244            this,                                  if (lastZooms.size() > 0
245            "",                                                  && mapArea.equals(lastZooms.get(lastZooms.size() - 1))) {
246            new ImageIcon(MapView.class.getResource("resource/icons/zoom_in.png"))                                          // LOGGER.debug("MapAreaChangedEvent ausgelassen bei der Zaehlung der Zoomschritt weil identisch");
247        ), false );                                          return;
248        // Zoom out                                  }
249        addTool( new MapPaneToolBarAction(  
250            TOOL_ZOOMOUT,                                  if (lastZooms.size() > 0)
251            this,                                          while (zoomBackIndex < lastZooms.size())
252            "",                                                  lastZooms.remove(lastZooms.size() - 1);
253            new ImageIcon(MapView.class.getResource("resource/icons/zoom_out.png"))  
254        ), false );                                  lastZooms.add(mapArea);
255                                          zoomBackIndex = lastZooms.size();
256        // Action button to revert the last zoom                                  setButtonEnabled(ACTION_ZOOM_BACK, lastZooms.size() > 1);
257        addAction( new MapPaneToolBarAction(                                  setButtonEnabled(ACTION_ZOOM_FORWARD, false);
258            ACTION_ZOOM_BACK,                          }
259            this,  
260            "",                  };
261            new ImageIcon(MapView.class.getResource("resource/icons/zoom_back.png"))  
262        ), false);                  setMapPane(mapPane);
263        setButtonEnabled( ACTION_ZOOM_BACK, false );                  setFloatable(false);
264                    setRollover(true);
265        // Action button to redo the last zoom  
266        addAction( new MapPaneToolBarAction(                  init();
267            ACTION_ZOOM_FORWARD,          }
268            this,  
269            "",          private CrsLabel getCrsComponent() {
270            new ImageIcon(MapView.class.getResource("resource/icons/zoom_forward.png"))                  if (crsViewer == null) {
271        ), false);                          crsViewer = new CrsLabel(this.mapPane);
272        setButtonEnabled( ACTION_ZOOM_FORWARD, false );                  }
273                          return crsViewer;
274                  }
275            // set the selected tool enabled  
276        setSelectedTool(selectedTool);          /**
277                   * Sets the {@link SelectableXMapPane} controlled by this tool bar.
278          }           *
279             * @param mapPane
280             *            {@link SelectableXMapPane} to control (if {@code null} this
281          /**           *            tool bar controls NOTHING!)
282       * Clears the GUI of all components and adds all tool and action buttons to the           */
283       * tool bar.          public void setMapPane(SelectableXMapPane mapPane) {
284       */                  // Remove listener from old MapPane
285      protected void initToolBar() {                  if (this.mapPane != null)
286        setAlignmentY( 1f );                          this.mapPane.removeMapPaneListener(mapPaneListener);
287        removeAll();                  this.mapPane = mapPane;
288        // Separator to the left of the tool actions to start                  if (this.mapPane != null && mapPaneListener != null)
289        // the tool buttons with the map (not with the coordinate grid)                          this.mapPane.addMapPaneListener(mapPaneListener);
290        Dimension dimension = new Dimension( 49,10);          }
291        addSeparator(dimension);  
292        // Tool buttons          /**
293        for (JComponent b : toolAndActionButtons.values())           * Calls {@link #initToolsAndActions()} and {@link #initActions()} and then
294          add(b);           * puts all tool buttons and all actions buttons to the tool bar.
295      }           */
296        // Space between tool buttons and action buttons          protected void init() {
297  // SK: Seperators are now als manages like actions and tools        
298  //      Dimension dimension2 = new Dimension( 10,10);                  initToolsAndActions();
299  //      this.addSeparator(dimension2);  
300                          addSeparator(SEPERATOR0, new JToolBar.Separator());
301  //      // Action buttons                  addSeparator(SEPERATOR1, new JToolBar.Separator());
302  //      for (JButton b : actionButtons.values())  
303  //        add(b);                  initToolBar();
304  //    }          }
305        
306          /**          /**
307           * Performs the activation of a tool.           * Creates the tool buttons and action buttons and seperators, adds them to
308           * @param tool the tool to activate           * {@link #toolAndActionButtons} and finally creates a button group for all
309           * @param e    the event of the button           * tools. So sub-classes which override this method should FIRST add their
310           */           * new tool buttons to {@link #toolAndActionButtons} before calling
311          public void performToolButton(int tool, ActionEvent e) {           * {@code super.initTools()}.
312            if ( mapPane == null )           */
313              return;          protected void initToolsAndActions() {
314                              // Pan
315            selectedTool = tool;                  addTool(new MapPaneToolBarAction(TOOL_PAN, this, XMapPaneTool.PAN),
316                                              false);
317        switch( tool ) {  
318          case TOOL_PAN:                  // Info
319            // Set the mouse tool to "Panning"                  addTool(new MapPaneToolBarAction(TOOL_INFO, this, XMapPaneTool.INFO),
320            mapPane.setWindowSelectionState(JMapPane.NONE);                                  false);
321            mapPane.setState(JMapPane.PAN);  
322            mapPane.setHighlight(false);                  // Zoom in
323            mapPane.setNormalCursor(SwingUtil.PAN_CURSOR);                  addTool(new MapPaneToolBarAction(TOOL_ZOOMIN, this,
324            break;                                  XMapPaneTool.ZOOM_IN), false);
325          case TOOL_INFO:  
326            // Set the mouse tool to "Info"                  // Zoom out
327            mapPane.setWindowSelectionState(JMapPane.NONE);                  addTool(new MapPaneToolBarAction(TOOL_ZOOMOUT, this,
328            mapPane.setState(JMapPane.SELECT_TOP); // Why not: JMapPane.SELECT_TOP_ONEONLY                                  XMapPaneTool.ZOOM_OUT), false);
329            mapPane.setHighlight(false);// SK: Was true, but since it not works properly removed it to save performance  
330            mapPane.setNormalCursor(SwingUtil.CROSSHAIR_CURSOR);                  // Action button to revert the last zoom
331            break;                  addAction(
332          case TOOL_SELECTION_SET:                                  new MapPaneToolBarAction(ACTION_ZOOM_BACK, this, "",
333          case TOOL_SELECTION_ADD:                                                  new ImageIcon(MapView.class
334          case TOOL_SELECTION_REMOVE:                                                                  .getResource("resource/icons/zoom_back.png")),
335                  // Set the mouse tool to "Select"                                                  R("MapPaneButtons.LastZoom.TT")), false);
336                  mapPane.setWindowSelectionState(JMapPane.SELECT_TOP);                  setButtonEnabled(ACTION_ZOOM_BACK, false);
337                  mapPane.setState(JMapPane.SELECT_TOP);  
338                  mapPane.setHighlight(false);                  // Action button to redo the last zoom
339                  mapPane.setNormalCursor(SwingUtil.CROSSHAIR_CURSOR); // TODO Select Cursor                  addAction(
340                  break;                                  new MapPaneToolBarAction(
341          case TOOL_ZOOMIN:                                                  ACTION_ZOOM_FORWARD,
342            // Set the mouse tool to "Zoom in"                                                  this,
343            mapPane.setWindowSelectionState(JMapPane.ZOOM_IN);                                                  "",
344            mapPane.setState(JMapPane.ZOOM_IN);                                                  new ImageIcon(MapView.class
345            mapPane.setHighlight(false);                                                                  .getResource("resource/icons/zoom_forward.png")),
346            mapPane.setNormalCursor(SwingUtil.ZOOMIN_CURSOR);                                                  R("MapPaneButtons.NextZoom.TT")), false);
347            break;                  setButtonEnabled(ACTION_ZOOM_FORWARD, false);
348          case TOOL_ZOOMOUT:  
349            // Set the mouse tool to "Zoom out"                  // set the selected tool enabled
350            mapPane.setWindowSelectionState(JMapPane.NONE);                  setSelectedTool(selectedTool);
351            mapPane.setState(JMapPane.ZOOM_OUT);  
352            mapPane.setHighlight(false);                  add(getCrsComponent());
353            mapPane.setNormalCursor(SwingUtil.ZOOMOUT_CURSOR);  
354            break;          }
355          default:  
356            // Set map actions to default          @Override
357            mapPane.setWindowSelectionState(JMapPane.NONE);          public void paint(Graphics g) {
358            mapPane.setState(JMapPane.NONE);                  super.paint(g);
359            mapPane.setHighlight(false);          }
360            mapPane.setNormalCursor(null);  
361            break;          /**
362        }           * Clears the GUI of all components and adds all tool and action buttons to
363        mapPane.updateCursor();           * the tool bar.
364          }           */
365                    public void initToolBar() {
366      /**                  removeAll();
367       * Performs the action of an action button.  
368       * @param tool the action                  // // Separator to the left of the tool actions to start
369       * @param e    the event of the button                  // // the tool buttons with the map (not with the coordinate grid)
370       */                  // Dimension dimension = new Dimension(49, 10);
371          protected void performActionButton(int action, ActionEvent e) {                  // addSeparator(dimension);
372        if ( mapPane == null )  
373          return;                  // Tool buttons
374                    for (Integer bKey : toolAndActionButtons.keySet()) {
375        // Perform the action "Zoom back": Revert the last zoom  
376        if ( action == ACTION_ZOOM_BACK ) {                          JComponent b = toolAndActionButtons.get(bKey);
377              if (zoomBackIndex <= 1)  
378            return;                          if (b instanceof JToggleButton) {
379                                      JToggleButton tb = (JToggleButton) b;
380          zoomBackForwardButtonInAction = true;                                  tb.setName(bKey.toString());
381          zoomBackIndex--;                                  tb.addActionListener(toolSelectedListener);
382          getButton(ACTION_ZOOM_FORWARD).setEnabled(true);                          }
383          getButton(ACTION_ZOOM_BACK).setEnabled( zoomBackIndex > 1 );  
384                              add(b);
385          mapPane.setMapArea( lastZooms.get(zoomBackIndex-1) );                  }
386          mapPane.refresh();  
387        }                  if (!toolAndActionButtons.containsKey(selectedTool)) {
388                            /**
389        // Perform the action "Zoom forward": Redo the last zoom                           * This might be a bit specific, but IF selection buttons are
390        if ( action == ACTION_ZOOM_FORWARD ) {                           * available, select one of them.. if not, select the INFO tool.
391          if (zoomBackIndex < lastZooms.size()) {                           */
392            zoomBackForwardButtonInAction = true;  
393            zoomBackIndex++;                          if (toolAndActionButtons.containsKey(TOOL_SELECTION_SET)) {
394            getButton(ACTION_ZOOM_BACK).setEnabled(true);                                  setSelectedTool(TOOL_SELECTION_SET);
395            getButton(ACTION_ZOOM_FORWARD).setEnabled(zoomBackIndex < lastZooms.size());                          } else if (toolAndActionButtons.containsKey(TOOL_INFO)) {
396                                    setSelectedTool(TOOL_INFO);
397            mapPane.setMapArea( lastZooms.get(zoomBackIndex-1) );                          } else {
398            mapPane.refresh();                                  // TODO What to do now?!
399          }                                  setSelectedTool(null);
400        }                          }
401          
402        /**                  }
403         * Clear the selection by calling the selection model  
404         */                  revalidate();
405        if (action == TOOL_SELECTION_CLEAR) {                  repaint();
406            // TODO          }
407        }  
408          }          /**
409                     * Performs the activation of a tool.
410                     *
411          /**           * @param tool
412           * Adds a tool to the tool bar. Does nothing if a tool or action with the           *            the tool to activate
413           * specified ID already exists!           * @param e
414           * @param buttonAction action for the toggle button           *            the event of the button
415           * @param resetToolBar indicates whether the toolbar GUI is reset after adding           */
416           *                     the button (if adding several actions it useful only to          public void performToolButton(int tool, ActionEvent e) {
417           *                     reset the GUI for the last added tool)                  if (mapPane == null)
418           */                          return;
419          public void addTool(MapPaneToolBarAction buttonAction, boolean resetToolBar) {  
420            if ( isButtonIDUsed(buttonAction.getID()) ) {                  selectedTool = tool;
421              LOGGER.warn("addTool(.) ignored because ID already used for tool or action: "+buttonAction.getID());  
422              return;                  switch (tool) {
423            }                  case TOOL_PAN:
424            JToggleButton button = new JToggleButton(buttonAction);                          mapPane.setTool(XMapPaneTool.PAN);
425            button.setBorder( BorderFactory.createRaisedBevelBorder() );                          break;
426            toolButtonGroup.add(button);                  case TOOL_INFO:
427            toolAndActionButtons.put(buttonAction.getID(), button);                          mapPane.setTool(XMapPaneTool.INFO);
428            if ( resetToolBar )                          break;
429              initToolBar();                  case TOOL_ZOOMIN:
430          }                          mapPane.setTool(XMapPaneTool.ZOOM_IN);
431                            break;
432      /**                  case TOOL_ZOOMOUT:
433       * Adds a tool to the tool bar and resets the toolbar GUI.                          mapPane.setTool(XMapPaneTool.ZOOM_OUT);
434       * @param buttonAction action for the toggle button                          break;
435       */                  }
436      public void addTool(MapPaneToolBarAction buttonAction) {          }
437        addTool(buttonAction, true);  
438      }          /**
439             * @param id
440      /**           *            The ID of the Component to remove. The change will not be
441       * Adds an action to the tool bar. Does nothing if a tool or action with the           *            visible until {@link #initToolBar()} is called.
442       * specified ID already exists!           * @return <code>null</code> or the component that has been removed.
443       * @param buttonAction action for the button           */
444       * @param resetToolBar indicates whether the toolbar GUI is reset after adding          public JComponent removeId(int id) {
445       *                     the button (if adding several actions it useful only to                  return toolAndActionButtons.remove(id);
446       *                     reset the GUI for the last added tool)          }
447       */  
448      public void addAction(MapPaneToolBarAction buttonAction, boolean resetToolBar) {          /**
449        if ( isButtonIDUsed(buttonAction.getID()) ) {           * Performs the action of an action button.
450          LOGGER.warn("addAction(.) ignored because ID already used for tool or action: "+buttonAction.getID());           *
451          return;           * @param tool
452        }           *            the action
453        JButton button = new JButton(buttonAction);           * @param e
454        button.setBorder( BorderFactory.createRaisedBevelBorder() );           *            the event of the button
455        toolAndActionButtons.put( buttonAction.getID(), button );           */
456        if ( resetToolBar )          protected void performActionButton(int action, ActionEvent e) {
457          initToolBar();                  if (mapPane == null)
458      }                          return;
459        
460                    // Perform the action "Zoom back": Revert the last zoom
461      private void addSeparator(int id, Separator separator) {                  if (action == ACTION_ZOOM_BACK) {
462          if ( isButtonIDUsed(id) ) {                          if (zoomBackIndex <= 1)
463              LOGGER.warn("addSeparator(.) ignored because ID already used for tool or action. ");                                  return;
464              return;  
465            }                          zoomBackForwardButtonInAction = true;
466            toolAndActionButtons.put( id, separator);                          zoomBackIndex--;
467          }                          getButton(ACTION_ZOOM_FORWARD).setEnabled(true);
468                            getButton(ACTION_ZOOM_BACK).setEnabled(zoomBackIndex > 1);
469      /**  
470       * Adds an action to the tool bar and resets the toolbar GUI.                          mapPane.setMapArea(lastZooms.get(zoomBackIndex - 1));
471       * @param buttonAction action for the toggle button                          mapPane.refresh();
472       */                  }
473      public void addAction(MapPaneToolBarAction buttonAction) {  
474        addAction(buttonAction, true);                  // Perform the action "Zoom forward": Re-do the last zoom
475      }                  if (action == ACTION_ZOOM_FORWARD) {
476                                if (zoomBackIndex < lastZooms.size()) {
477      /**                                  zoomBackForwardButtonInAction = true;
478       * Returns the button for a specific tool or action.                                  zoomBackIndex++;
479       * @param id the constant for any button in the {@link MapPaneToolBar}                                  getButton(ACTION_ZOOM_BACK).setEnabled(true);
480       * @return a {@link JButton} if {@code id} specifies an {@linkplain #getActionButton(int) action button}                                  getButton(ACTION_ZOOM_FORWARD).setEnabled(
481       *         or {@link JToogleButton} if {@code id} specifies a {@linkplain #getToolButton(int) tool button}                                                  zoomBackIndex < lastZooms.size());
482       */  
483      public AbstractButton getButton(int id) {                                  mapPane.setMapArea(lastZooms.get(zoomBackIndex - 1));
484        AbstractButton button = (AbstractButton)toolAndActionButtons.get(id);                                  mapPane.refresh();
485        if ( button == null )                          }
486          LOGGER.warn("Unknown tool or action ID: "+id);                  }
487        return button;          }
488      }  
489            /**
490      /**           * Adds a tool to the tool bar. Does nothing if a tool or action with the
491       * Returns the button for a specific tool.           * specified ID already exists!
492       * @param tool the constant for a tool           *
493       */           * @param buttonAction
494          public JToggleButton getToolButton(int tool) {           *            action for the toggle button
495        AbstractButton button = getButton(tool);           * @param resetToolBar
496        if ( button != null && !(button instanceof JToggleButton) ) {           *            indicates whether the toolbar GUI is reset after adding the
497          LOGGER.warn("ID specifies no tool: "+tool);           *            button (if adding several actions it useful only to reset the
498          button = null;           *            GUI for the last added tool)
499        }           */
500        return (JToggleButton)button;          public void addTool(MapPaneToolBarAction buttonAction, boolean resetToolBar) {
501      }                  if (isButtonIDUsed(buttonAction.getID())) {
502                            LOGGER.warn("addTool(.) ignored because ID already used for tool or action: "
503      /**                                          + buttonAction.getID());
504       * Returns the button for a specific action.                          return;
505       * @param action the constant an action                  }
506       */                  JToggleButton button = new SmallToggleButton(buttonAction);
507      public JButton getActionButton(int action) {  
508        AbstractButton button = getButton(action);                  toolButtonGroup.add(button);
509        if ( button != null && !(button instanceof JButton) ) {                  toolAndActionButtons.put(buttonAction.getID(), button);
510          LOGGER.warn("ID specifies no action: "+action);                  if (resetToolBar)
511          button = null;                          initToolBar();
512        }          }
513        return (JButton)button;  
514            /**
515      }           * Adds a tool to the tool bar and resets the toolbar GUI.
516             *
517          /**           * @param buttonAction
518           * Sets the selected tool.           *            action for the toggle button
519           * @param tool ID of the tool           */
520           */          public void addTool(MapPaneToolBarAction buttonAction) {
521          public void setSelectedTool(Integer tool) {                  addTool(buttonAction, true);
522            if ( tool == null )          }
523              toolButtonGroup.setUnselected();  
524                      /**
525            JToggleButton button = getToolButton(tool);           * Adds an action to the tool bar. Does nothing if a tool or action with the
526            if ( button == null )           * specified ID already exists!
527              return;           *
528            button.setSelected( true );           * @param buttonAction
529            button.getAction().actionPerformed(null);           *            action for the button
530          }           * @param resetToolBar
531                     *            indicates whether the toolbar GUI is reset after adding the
532          /**           *            button (if adding several actions it useful only to reset the
533           * Returns the selected tool.           *            GUI for the last added tool)
534           * @return -1 if no tool is active           */
535           */          public void addAction(MapPaneToolBarAction buttonAction,
536          public int getSelectedTool() {                          boolean resetToolBar) {
537            if ( toolButtonGroup.getSelectedButton() == null )                  if (isButtonIDUsed(buttonAction.getID())) {
538              return -1;                          LOGGER.warn("addAction(.) ignored because ID already used for tool or action: "
539            return selectedTool;                                          + buttonAction.getID());
540          }                          return;
541                            }
542      /**                  JButton button = new SmallButton(buttonAction);
543       * Sets whether a tool or action is activated or not. The visible property                  toolAndActionButtons.put(buttonAction.getID(), button);
544       * of the button is not affected.                  if (resetToolBar)
545       * @param id tool or actionID                          initToolBar();
546       * @param enabled if {@code true} the tool becomes available          }
547       */  
548      public void setButtonEnabled(int id, boolean enabled) {          /**
549        AbstractButton button = getButton(id);           * Adds any JComponent to the tool bar. Does nothing if a tool or action
550        if ( button == null )           * with the specified ID already exists!
551          return;           *
552        button.setEnabled( enabled );           * @param component
553      }           *            A {@link JComponent} that shall be added
554             * @param id
555      /**           *            The ID associaded with the {@link JComponent}
556       * Sets whether a tool or action is activated or not.           * @param resetToolBar
557       * @param id tool or actionID           *            indicates whether the toolbar GUI is reset after adding the
558       * @param enabled if {@code true} the tool becomes available           *            button (if adding several actions it useful only to reset the
559       * @param hideOnDisable if {@code true} the button is also hidden if           *            GUI for the last added tool)
560       *                      {@code enabled} is {@code false}           */
561       */          public void addJComponent(JComponent component, int id, boolean resetToolBar) {
562          public void setButtonEnabled(int id, boolean enabled, boolean hideOnDisable) {  
563            AbstractButton button = getButton(id);                  if (isButtonIDUsed(id)) {
564            if ( button == null )                          LOGGER.warn("addAction(.) ignored because ID already used for tool or action: "
565              return;                                          + id);
566            button.setEnabled( enabled );                          return;
567            // if button is enabled, it becomes visible anyway                  }
568            // if button is disabled and the "hide" option is set, it is also hidden  
569            if ( enabled )                  toolAndActionButtons.put(id, component);
570              button.setVisible( true );                  if (resetToolBar)
571            else                          initToolBar();
572              button.setVisible( !hideOnDisable );          }
573          }  
574            public void addSeparator(int id, Separator separator) {
575      /**                  if (isButtonIDUsed(id)) {
576       * Checks whether a ID is already used for a tool or action.                          LOGGER.warn("addSeparator(.) ignored because ID already used for tool or action. ");
577       * @param tool tool ID                          return;
578       */                  }
579      public boolean isButtonIDUsed(int id) {                  toolAndActionButtons.put(id, separator);
580        return toolAndActionButtons.get(id) != null;          }
581      }  
582            /**
583      /**           * Adds an action to the tool bar and resets the toolbar GUI.
584       * Checks whether a tool is activated.           *
585       * @param tool tool ID           * @param buttonAction
586       * @return {@code false} if an unknown ID is specified           *            action for the toggle button
587       */           */
588      public boolean isButtonEnabled(int id) {          public void addAction(MapPaneToolBarAction buttonAction) {
589        AbstractButton button = getButton(id);                  addAction(buttonAction, true);
590        if ( button != null )          }
591          return button.isEnabled();  
592        return false;          /**
593      }           * Returns the button for a specific tool or action.
594             *
595      /**           * @param id
596       * Sets the activation for all tools.           *            the constant for any button in the {@link MapPaneToolBar}
597       * @param enabled if {@code true} all tools becomes available           * @return a {@link JButton} if {@code id} specifies an
598       * @param hideOnDisable if {@code true} the buttons are also hidden if           *         {@linkplain #getActionButton(int) action button} or
599       *                      {@code enabled} is {@code false}           *         {@link JToogleButton} if {@code id} specifies a
600       */           *         {@linkplain #getToolButton(int) tool button}
601      public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) {           */
602        for (int tool : toolAndActionButtons.keySet())          public AbstractButton getButton(int id) {
603          setButtonEnabled(tool,enabled,hideOnDisable);  
604      }                    // ACHUTNG: Das ist ein SK QUICK FIX! TODO
605                    if (!(toolAndActionButtons.get(id) instanceof AbstractButton))
606      /**                          return null;
607       * Sets the activation for all actions.  
608       * @param enabled if {@code true} all actions becomes available                  AbstractButton button = (AbstractButton) toolAndActionButtons.get(id);
609       * @param hideOnDisable if {@code true} the buttons are also hidden if                  if (button == null)
610       *                      {@code enabled} is {@code false}                          LOGGER.warn("Unknown tool or action ID: " + id);
611       */                  return button;
612      public void setAllActionsEnabled(boolean enabled, boolean hideOnDisable) {          }
613        for (int id : toolAndActionButtons.keySet()){  
614            if (toolAndActionButtons.get(id) instanceof JButton){          /**
615                    setButtonEnabled(id,enabled,hideOnDisable);           * Returns the button for a specific tool.
616            }           *
617        }           * @param tool
618                     *            the constant for a tool
619      }             */
620                public JToggleButton getToolButton(int tool) {
621      /**                  AbstractButton button = getButton(tool);
622       * Returns the maximum ID of tools.                  if (button != null && !(button instanceof JToggleButton)) {
623       */                          LOGGER.warn("ID specifies no tool: " + tool);
624      public int getMaxToolID() {                          button = null;
625        return toolAndActionButtons.lastKey();                  }
626      }                  return (JToggleButton) button;
627            }
628      /**  
629       * Returns the minimum ID of tools.          /**
630       */           * Returns the button for a specific action.
631      public int getMinToolID() {           *
632        return toolAndActionButtons.firstKey();           * @param action
633      }           *            the constant an action
634  //           */
635  //    /**          public JButton getActionButton(int action) {
636  //     * Returns the maximum ID of actions.                  AbstractButton button = getButton(action);
637  //     */                  if (button != null && !(button instanceof JButton)) {
638  //    public int getMaxActionID() {                          LOGGER.warn("ID specifies no action: " + action);
639  //      return actionButtons.lastKey();                          button = null;
640  //    }                  }
641  //                  return (JButton) button;
642  //    /**  
643  //     * Returns the minimum ID of actions.          }
644  //     */  
645  //    public int getMinActionID() {          /**
646  //      return actionButtons.firstKey();           * Sets the selected tool.
647  //    }           *
648                 * @param tool
649      /**           *            ID of the tool
650       * Extends the {@link AbstractAction} with maintaining an ID and           */
651       * the {@link MapPaneToolBar} the actions controls.          public void setSelectedTool(Integer tool) {
652       * Additionally this class automatically calls {@link MapPaneToolBar#performToolButton(int, ActionEvent)}                  if (tool == null)
653       * or {@link MapPaneToolBar#performActionButton(int, ActionEvent)}                          toolButtonGroup.setUnselected();
654       * depending on whether the action is added via {@link MapPaneToolBar#addTool(MapPaneToolBarAction)}  
655       * or {@link MapPaneToolBar#addAction(MapPaneToolBarAction)}.                  JToggleButton button = getToolButton(tool);
656       * @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)                  if (button == null)
657       */                          return;
658      public static class MapPaneToolBarAction extends AbstractAction {                  button.setSelected(true);
659        /** The ID of the action */                  button.getAction().actionPerformed(null);
660        protected int id = -1;  
661        /** The tool bar, this action is made for. */                  selectedTool = tool;
662        protected MapPaneToolBar toolBar = null;          }
663    
664        /**          /**
665         * Creates a new action with a dummy description and no icon.           * Returns the selected tool.
666         * @param id      unique ID for the action           *
667         * @param toolBar toolbar this action is made for           * @return -1 if no tool is active
668         */           */
669        public MapPaneToolBarAction(int id, MapPaneToolBar toolBar) {          public int getSelectedTool() {
670          this(id,toolBar,""+id);                  if (toolButtonGroup.getSelectedButton() == null)
671        }                          return -1;
672                    return selectedTool;
673        /**          }
674         * Creates a new action without an icon.  
675         * @param id      unique ID for the action          /**
676         * @param toolBar toolbar this action is made for           * Sets whether a tool or action is activated or not. The visible property
677         * @param name    description used for buttons or menus           * of the button is not affected.
678         */           *
679        public MapPaneToolBarAction(int id, MapPaneToolBar toolBar, String name) {           * @param id
680          this(id,toolBar,name,null);           *            tool or actionID
681        }           * @param enabled
682             *            if {@code true} the tool becomes available
683        /**           */
684         * Creates a new action.          public void setButtonEnabled(int id, boolean enabled) {
685         * @param id      unique ID for the action                  AbstractButton button = getButton(id);
686         * @param toolBar toolbar this action is made for                  if (button == null)
687         * @param name    description used for buttons or menus                          return;
688         * @param icon    icon used for buttons or menus                  button.setEnabled(enabled);
689         */          }
690        public MapPaneToolBarAction(int id, MapPaneToolBar toolBar, String name, Icon icon) {  
691          super(name,icon);          /**
692          this.id      = id;           * Sets whether a tool or action is activated or not.
693          this.toolBar = toolBar;           *
694        }           * @param id
695                   *            tool or actionID
696        /**           * @param enabled
697         * Calls {@link MapPaneToolBar#performToolButton(int, ActionEvent)}           *            if {@code true} the tool becomes available
698         * or {@link MapPaneToolBar#performActionButton(int, ActionEvent)}           * @param hideOnDisable
699         * depending on whether the action is added to the toolbar via           *            if {@code true} the button is also hidden if {@code enabled}
700         * {@link MapPaneToolBar#addTool(MapPaneToolBarAction)}           *            is {@code false}
701         * or {@link MapPaneToolBar#addAction(MapPaneToolBarAction)}.           */
702         */          public void setButtonEnabled(int id, boolean enabled, boolean hideOnDisable) {
703        public void actionPerformed(ActionEvent e) {                  AbstractButton button = getButton(id);
704          if ( toolBar.toolAndActionButtons.get(id) instanceof JToggleButton)                  if (button == null)
705            toolBar.performToolButton(id, e);                          return;
706          else if ( toolBar.toolAndActionButtons.get(id) instanceof JButton )                  button.setEnabled(enabled);
707            toolBar.performActionButton(id, e);                  // if button is enabled, it becomes visible anyway
708        }                  // if button is disabled and the "hide" option is set, it is also hidden
709                          if (enabled)
710        /**                          button.setVisible(true);
711         * Returns the (unique) id of this action.                  else
712         * @return                          button.setVisible(!hideOnDisable);
713         */          }
714        public int getID() {  
715          return id;          /**
716        }           * Checks whether a ID is already used for a tool or action.
717      }           *
718  }           * @param tool
719             *            tool ID
720             */
721            public boolean isButtonIDUsed(int id) {
722                    return toolAndActionButtons.get(id) != null;
723            }
724    
725            /**
726             * Checks whether a tool is activated.
727             *
728             * @param tool
729             *            tool ID
730             * @return {@code false} if an unknown ID is specified
731             */
732            public boolean isButtonEnabled(int id) {
733                    AbstractButton button = getButton(id);
734                    if (button != null)
735                            return button.isEnabled();
736                    return false;
737            }
738    
739            /**
740             * Sets the activation for all tools.
741             *
742             * @param enabled
743             *            if {@code true} all tools becomes available
744             * @param hideOnDisable
745             *            if {@code true} the buttons are also hidden if {@code enabled}
746             *            is {@code false}
747             */
748            public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) {
749                    for (int id : toolAndActionButtons.keySet()) {
750                            if (toolAndActionButtons.get(id) instanceof JToggleButton) {
751                                    setButtonEnabled(id, enabled, hideOnDisable);
752                            }
753                    }
754            }
755    
756            /**
757             * Sets the activation for all actions.
758             *
759             * @param enabled
760             *            if {@code true} all actions becomes available
761             * @param hideOnDisable
762             *            if {@code true} the buttons are also hidden if {@code enabled}
763             *            is {@code false}
764             */
765            public void setAllActionsEnabled(boolean enabled, boolean hideOnDisable) {
766                    for (int id : toolAndActionButtons.keySet()) {
767                            if (toolAndActionButtons.get(id) instanceof JButton) {
768                                    setButtonEnabled(id, enabled, hideOnDisable);
769                            }
770                    }
771    
772            }
773    
774            /**
775             * Returns the maximum ID of tools.
776             */
777            public int getMaxToolID() {
778                    return toolAndActionButtons.lastKey();
779            }
780    
781            /**
782             * Returns the minimum ID of tools.
783             */
784            public int getMinToolID() {
785                    return toolAndActionButtons.firstKey();
786            }
787    
788            /**
789             * Extends the {@link AbstractAction} with maintaining an ID and the
790             * {@link MapPaneToolBar} the actions controls. Additionally this class
791             * automatically calls
792             * {@link MapPaneToolBar#performToolButton(int, ActionEvent)} or
793             * {@link MapPaneToolBar#performActionButton(int, ActionEvent)} depending on
794             * whether the action is added via
795             * {@link MapPaneToolBar#addTool(MapPaneToolBarAction)} or
796             * {@link MapPaneToolBar#addAction(MapPaneToolBarAction)}.
797             *
798             * @author <a href="mailto:[email protected]">Martin Schmitz</a>
799             *         (University of Bonn/Germany)
800             */
801            public static class MapPaneToolBarAction extends AbstractAction {
802                    /** The ID of the action */
803                    protected int id = -1;
804                    /** The tool bar, this action is made for. */
805                    protected MapPaneToolBar toolBar = null;
806    
807                    /**
808                     * Creates a new action with a dummy description and no icon.
809                     *
810                     * @param id
811                     *            unique ID for the action
812                     * @param toolBar
813                     *            toolbar this action is made for
814                     */
815                    public MapPaneToolBarAction(int id, MapPaneToolBar toolBar) {
816                            this(id, toolBar, "" + id);
817                    }
818    
819                    /**
820                     * Creates a new action without an icon.
821                     *
822                     * @param id
823                     *            unique ID for the action
824                     * @param toolBar
825                     *            toolbar this action is made for
826                     * @param name
827                     *            description used for buttons or menus
828                     */
829                    public MapPaneToolBarAction(int id, MapPaneToolBar toolBar, String name) {
830                            this(id, toolBar, name, null);
831                    }
832    
833                    /**
834                     * Creates a new action.
835                     *
836                     * @param id
837                     *            unique ID for the action
838                     * @param toolBar
839                     *            toolbar this action is made for
840                     * @param name
841                     *            description used for buttons or menus
842                     * @param icon
843                     *            icon used for buttons or menus
844                     */
845                    public MapPaneToolBarAction(int id, MapPaneToolBar toolBar,
846                                    String name, Icon icon) {
847                            this(id, toolBar, name, icon, null);
848                    }
849    
850                    /**
851                     * Creates a new action.
852                     *
853                     * @param id
854                     *            unique ID for the action
855                     * @param toolBar
856                     *            The {@link MapPaneToolBar} this action is made for
857                     * @param name
858                     *            description used for buttons or menus
859                     * @param icon
860                     *            icon used for buttons or menus
861                     * @param toolTip
862                     *            Tooltip to use for the button or menu
863                     */
864                    public MapPaneToolBarAction(int id, MapPaneToolBar toolBar,
865                                    String name, Icon icon, String toolTip) {
866                            super(name, icon);
867    
868                            if (toolTip != null && !toolTip.trim().isEmpty()) {
869                                    putValue(Action.SHORT_DESCRIPTION, toolTip);
870                            }
871    
872                            this.id = id;
873                            this.toolBar = toolBar;
874                    }
875    
876                    public MapPaneToolBarAction(int id, MapPaneToolBar toolBar,
877                                    XMapPaneTool tool) {
878                            this(id, toolBar, "", tool.getIcon(), tool.getToolTip());
879                    }
880    
881                    /**
882                     * Calls {@link MapPaneToolBar#performToolButton(int, ActionEvent)} or
883                     * {@link MapPaneToolBar#performActionButton(int, ActionEvent)}
884                     * depending on whether the action is added to the toolbar via
885                     * {@link MapPaneToolBar#addTool(MapPaneToolBarAction)} or
886                     * {@link MapPaneToolBar#addAction(MapPaneToolBarAction)}.
887                     */
888                    public void actionPerformed(ActionEvent e) {
889                            if (toolBar.toolAndActionButtons.get(id) instanceof JToggleButton)
890                                    toolBar.performToolButton(id, e);
891                            else if (toolBar.toolAndActionButtons.get(id) instanceof JButton)
892                                    toolBar.performActionButton(id, e);
893                    }
894    
895                    /**
896                     * Returns the (unique) id of this action.
897                     *
898                     * @return
899                     */
900                    public int getID() {
901                            return id;
902                    }
903            }
904    
905            /**
906             * Nuetzlich wenn die Componente gedruckt (z.B. wenn ein Screenshot gemacht
907             * wird) wird. Dann werden wird der Hintergrund auf WEISS gesetzt.
908             *
909             * @author <a href="mailto:[email protected]">Stefan Alfons Tzeggai</a>
910             */
911            @Override
912            public void print(Graphics g) {
913                    Color orig = getBackground();
914                    setBackground(Color.WHITE);
915                    // wrap in try/finally so that we always restore the state
916                    try {
917                            super.print(g);
918                    } finally {
919                            setBackground(orig);
920                    }
921            }
922    
923            @Override
924            protected void finalize() throws Throwable {
925                    super.finalize();
926    
927                    if (mapPane != null && mapPaneListener != null)
928                            mapPane.removeMapPaneListener(mapPaneListener);
929            }
930    
931    }

Legend:
Removed from v.128  
changed lines
  Added in v.1220

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26