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

Legend:
Removed from v.151  
changed lines
  Added in v.315

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26