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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26