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

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

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26