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

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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26