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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26