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

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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26