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

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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26