/[schmitzm]/trunk/src/skrueger/geotools/MapPaneToolBar.java
ViewVC logotype

Diff of /trunk/src/skrueger/geotools/MapPaneToolBar.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26