/[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

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

Legend:
Removed from v.177  
changed lines
  Added in v.336

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26