/[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

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

Legend:
Removed from v.117  
changed lines
  Added in v.888

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26