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. Krüger - 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.Dimension; |
34 |
* A toolbar to control an {@link JMapPane} (Atlas visualization). This contains two types |
import java.awt.Graphics; |
35 |
* of buttons. A group of <i>tools</i> for the mouse actions on the map represented |
import java.awt.event.ActionEvent; |
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.Locale; |
38 |
* {@link JButton JButtons}. |
import java.util.SortedMap; |
39 |
* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany) |
import java.util.TreeMap; |
40 |
* @version 1.2 Stefan Krüger |
|
41 |
*/ |
import javax.swing.AbstractAction; |
42 |
public class MapPaneToolBar extends JToolBar { |
import javax.swing.AbstractButton; |
43 |
private static final Logger LOGGER = Logger.getLogger(MapPaneToolBar.class.getName()); |
import javax.swing.Action; |
44 |
/** Constant for the tool "Panning" (10). */ |
import javax.swing.BorderFactory; |
45 |
public static final int TOOL_PAN = 10; |
import javax.swing.Icon; |
46 |
/** Constant for the tool "Info" (20). */ |
import javax.swing.ImageIcon; |
47 |
public static final int TOOL_INFO = 20; |
import javax.swing.JButton; |
48 |
public static final int SEPERATOR0 = 99; |
import javax.swing.JComponent; |
49 |
|
import javax.swing.JToggleButton; |
50 |
/** Constant for the tool "Zoom In" (110). */ |
import javax.swing.JToolBar; |
51 |
public static final int TOOL_ZOOMIN = 110; |
|
52 |
/** Constant for the tool "Zoom Out" (120). */ |
import org.apache.log4j.Logger; |
53 |
public static final int TOOL_ZOOMOUT = 120; |
|
54 |
/** Constant for the action "Zoom back" (130). */ |
import schmitzm.geotools.gui.JMapPane; |
55 |
public static final int ACTION_ZOOM_BACK = 130; |
import schmitzm.geotools.map.event.JMapPaneEvent; |
56 |
/** Constant for the action "Zoom forward" (140). */ |
import schmitzm.geotools.map.event.JMapPaneListener; |
57 |
public static final int ACTION_ZOOM_FORWARD = 140; |
import schmitzm.geotools.map.event.MapAreaChangedEvent; |
58 |
public static final int SEPERATOR1 = 199; |
import schmitzm.lang.LangUtil; |
59 |
|
import schmitzm.lang.ResourceProvider; |
60 |
/** 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 schmitzm.swing.SwingUtil; |
62 |
/** Constant for the tool "Selection add" which adds the features to the Selection (220). */ |
|
63 |
public static final int TOOL_SELECTION_ADD = 220; |
import com.vividsolutions.jts.geom.Envelope; |
64 |
/** Constant for the tool "Selection subtract" which removes the selected features from the selection (230). */ |
|
65 |
public static final int TOOL_SELECTION_REMOVE = 230; |
/** |
66 |
/** Constant for the tool "Selection Reset" which clears the selection (240). */ |
* A toolbar to control an {@link JMapPane} (Atlas visualization). This contains |
67 |
public static final int TOOL_SELECTION_CLEAR = 240; |
* two types of buttons. A group of <i>tools</i> for the mouse actions on the |
68 |
public static final int SEPERATOR2 = 299; |
* map represented by {@link JToggleButton JToggleButtons}, where only one tool |
69 |
|
* can be activated every time. And some (general) <i>actions</i>, represented |
70 |
/** Constant for the action "Search Labels" (120). */ |
* by normal {@link JButton JButtons}. |
71 |
public static final int ACTION_SEARCH = 300; |
* |
72 |
|
* @author <a href="mailto:[email protected]">Martin Schmitz</a> |
73 |
/** Tool currently selected */ |
* (University of Bonn/Germany) |
74 |
protected int selectedTool = TOOL_ZOOMIN; |
* @version 1.2 Stefan Krüger |
75 |
|
*/ |
76 |
/** Holds the tool buttons of the tool bar. */ |
public class MapPaneToolBar extends JToolBar { |
77 |
protected SortedMap<Integer, JComponent> toolAndActionButtons = null; |
private static final Logger LOGGER = Logger.getLogger(MapPaneToolBar.class |
78 |
/** Controls that only one tool button is activated. */ |
.getName()); |
79 |
protected ButtonGroup toolButtonGroup = null; |
|
80 |
|
public static ResourceProvider RESOURCE = new ResourceProvider(LangUtil |
81 |
// SK: Musste ich ändern damit man Tools und Actions in der Reihenfolge mischen kann. |
.extendPackagePath(MapPaneToolBar.class, |
82 |
// /** Holds the action buttons of the bar. */ |
"resource.locales.mapPaneToolbar"), Locale.ENGLISH); |
83 |
// protected SortedMap<Integer, JButton> actionButtons = null; |
|
84 |
|
public static String R(String key, Object... values) { |
85 |
/** Holds the {@link JMapPane} this tool bar controls. */ |
return RESOURCE.getString(key, values); |
86 |
protected JMapPane mapPane = null; |
} |
87 |
|
|
88 |
/** |
/** Constant for the tool "Panning" (10). */ |
89 |
* A List to remember the last Envelopes that have been watched. Used for |
public static final int TOOL_PAN = 10; |
90 |
* the zoomBack- and zoomForwardButtons * |
/** Constant for the tool "Info" (20). */ |
91 |
*/ |
public static final int TOOL_INFO = 20; |
92 |
protected ArrayList<Envelope> lastZooms = new ArrayList<Envelope>(); |
public static final int SEPERATOR0 = 99; |
93 |
/** Holds the index to the current element in {@link #lastZooms}. */ |
|
94 |
protected int zoomBackIndex = 0; |
/** Constant for the tool "Zoom In" (110). */ |
95 |
|
public static final int TOOL_ZOOMIN = 110; |
96 |
/** Listener to sniff the zoom actions on the map. */ |
/** Constant for the tool "Zoom Out" (120). */ |
97 |
protected JMapPaneListener mapPaneListener = null; |
public static final int TOOL_ZOOMOUT = 120; |
98 |
|
/** Constant for the action "Zoom back" (130). */ |
99 |
protected boolean zoomBackForwardButtonInAction; |
public static final int ACTION_ZOOM_BACK = 130; |
100 |
|
/** Constant for the action "Zoom forward" (140). */ |
101 |
/** |
public static final int ACTION_ZOOM_FORWARD = 140; |
102 |
* Creates a new toolbar. Notice: This toolbar does nothing |
public static final int SEPERATOR1 = 199; |
103 |
* until {@link #setMapPane(JMapPane)} is called! |
|
104 |
*/ |
/** |
105 |
public MapPaneToolBar() { |
* Constant for the tool "Selection Reset" which clears the selection (240). |
106 |
this(null); |
*/ |
107 |
} |
public static final int TOOL_SELECTION_CLEAR = 240; |
108 |
|
|
109 |
/** |
/** |
110 |
* Creates a new tool bar. |
* Constant for the tool "Select" which sets the Selection to the selected |
111 |
* @param mapPane {@link JMapPane} the tool bar controls |
* features (210). |
112 |
*/ |
*/ |
113 |
public MapPaneToolBar(JMapPane mapPane) { |
public static final int TOOL_SELECTION_SET = 210; |
114 |
super("Control the map", JToolBar.HORIZONTAL); |
/** |
115 |
this.toolAndActionButtons = new TreeMap<Integer,JComponent>(); |
* Constant for the tool "Selection add" which adds the features to the |
116 |
this.toolButtonGroup = new ButtonGroup(); |
* Selection (220). |
117 |
// Create a Listener to sniff the zooms on the JMapPane |
*/ |
118 |
this.mapPaneListener = new JMapPaneListener() { |
public static final int TOOL_SELECTION_ADD = 220; |
119 |
public void performMapPaneEvent(JMapPaneEvent e) { |
/** |
120 |
if ( !(e instanceof MapAreaChangedEvent) ) |
* Constant for the tool "Selection subtract" which removes the selected |
121 |
return; |
* features from the selection (230). |
122 |
|
*/ |
123 |
if ( zoomBackForwardButtonInAction ) { |
public static final int TOOL_SELECTION_REMOVE = 230; |
124 |
zoomBackForwardButtonInAction = false; |
|
125 |
return; |
public static final int ACTION_CHARTS = 401; |
126 |
} |
|
127 |
|
/** Tool currently selected */ |
128 |
Envelope oldMapArea = ((MapAreaChangedEvent)e).getOldMapArea(); |
protected int selectedTool = TOOL_ZOOMIN; |
129 |
if (lastZooms.size() == 0 && oldMapArea != null ) { |
|
130 |
lastZooms.add(oldMapArea); |
/** Holds the tool buttons of the tool bar. */ |
131 |
zoomBackIndex = 1; |
protected SortedMap<Integer, JComponent> toolAndActionButtons = null; |
132 |
} |
/** Controls that only one tool button is activated. */ |
133 |
|
protected ButtonGroup toolButtonGroup = null; |
134 |
final Envelope mapArea = ((MapAreaChangedEvent)e).getNewMapArea(); |
|
135 |
if (mapArea == null) |
// SK: Musste ich ändern damit man Tools und Actions in der Reihenfolge |
136 |
return; |
// mischen kann. |
137 |
|
// /** Holds the action buttons of the bar. */ |
138 |
if (lastZooms.size() > 0 && mapArea.equals(lastZooms.get(lastZooms.size() - 1))) { |
// protected SortedMap<Integer, JButton> actionButtons = null; |
139 |
// LOGGER.debug("MapAreaChangedEvent ausgelassen bei der Zaehlung der Zoomschritt weil identisch"); |
|
140 |
return; |
/** Holds the {@link JMapPane} this tool bar controls. */ |
141 |
} |
protected JMapPane mapPane = null; |
142 |
|
|
143 |
if (lastZooms.size() > 0) |
/** |
144 |
while (zoomBackIndex < lastZooms.size()) |
* A List to remember the last Envelopes that have been watched. Used for |
145 |
lastZooms.remove(lastZooms.size() - 1); |
* the zoomBack- and zoomForwardButtons * |
146 |
|
*/ |
147 |
lastZooms.add(mapArea); |
protected ArrayList<Envelope> lastZooms = new ArrayList<Envelope>(); |
148 |
zoomBackIndex = lastZooms.size(); |
/** Holds the index to the current element in {@link #lastZooms}. */ |
149 |
setButtonEnabled(ACTION_ZOOM_BACK, lastZooms.size() > 1); |
protected int zoomBackIndex = 0; |
150 |
setButtonEnabled(ACTION_ZOOM_FORWARD, false); |
|
151 |
} |
/** Listener to sniff the zoom actions on the map. */ |
152 |
}; |
protected JMapPaneListener mapPaneListener = null; |
153 |
|
|
154 |
setMapPane(mapPane); |
protected boolean zoomBackForwardButtonInAction; |
155 |
setFloatable(false); |
|
156 |
setRollover(true); |
/** |
157 |
|
* Creates a new toolbar. Notice: This toolbar does nothing until |
158 |
init(); |
* {@link #setMapPane(JMapPane)} is called! |
159 |
} |
*/ |
160 |
|
public MapPaneToolBar() { |
161 |
/** |
this(null); |
162 |
* Sets the {@link JMapPane} controlled by this tool bar. |
} |
163 |
* @param mapPane {@link JMapPane} to control (if {@code null} this |
|
164 |
* tool bar controls NOTHING!) |
/** |
165 |
*/ |
* Creates a new tool bar. |
166 |
public void setMapPane(JMapPane mapPane) { |
* |
167 |
// Remove listener from old MapPane |
* @param mapPane |
168 |
if ( this.mapPane != null ) |
* {@link JMapPane} the tool bar controls |
169 |
this.mapPane.removeMapPaneListener( mapPaneListener ); |
*/ |
170 |
this.mapPane = mapPane; |
public MapPaneToolBar(JMapPane mapPane) { |
171 |
if ( this.mapPane != null && mapPaneListener != null ) |
super("Control the map", JToolBar.HORIZONTAL); |
172 |
this.mapPane.addMapPaneListener( mapPaneListener ); |
this.toolAndActionButtons = new TreeMap<Integer, JComponent>(); |
173 |
} |
this.toolButtonGroup = new ButtonGroup(); |
174 |
|
|
175 |
/** |
// Create a Listener to listen to the zooms on the JMapPane |
176 |
* Calls {@link #initToolsAndActions()} and {@link #initActions()} and then puts |
this.mapPaneListener = new JMapPaneListener() { |
177 |
* all tool buttons and all actions buttons to the tool bar. |
public void performMapPaneEvent(JMapPaneEvent e) { |
178 |
*/ |
if (!(e instanceof MapAreaChangedEvent)) |
179 |
protected void init() { |
return; |
180 |
initToolsAndActions(); |
|
181 |
|
if (zoomBackForwardButtonInAction) { |
182 |
addSeparator(SEPERATOR0, new JToolBar.Separator()); |
zoomBackForwardButtonInAction = false; |
183 |
addSeparator(SEPERATOR1, new JToolBar.Separator()); |
return; |
184 |
addSeparator(SEPERATOR2, new JToolBar.Separator()); |
} |
185 |
|
|
186 |
initToolBar(); |
final MapAreaChangedEvent mapAreaChangedEvent = (MapAreaChangedEvent) e; |
187 |
} |
Envelope oldMapArea = mapAreaChangedEvent.getOldMapArea(); |
188 |
|
|
189 |
|
final Envelope mapArea = mapAreaChangedEvent.getNewMapArea(); |
190 |
/** |
if (mapArea == null || mapArea.equals(oldMapArea) ) { |
191 |
* Creates the tool buttons and action buttons and seperators, adds them to |
// If the MapArea didn't change... we don't want to register it as a zoom action. |
192 |
* {@link #toolAndActionButtons} and finally creates a button group for all tools. |
return; |
193 |
* So sub-classes which override this method should FIRST add their new tool |
} |
194 |
* buttons to {@link #toolAndActionButtons} before calling {@code super.initTools()}. |
|
195 |
*/ |
if (lastZooms.size() == 0 && oldMapArea != null) { |
196 |
protected void initToolsAndActions() { |
lastZooms.add(oldMapArea); |
197 |
// Panning |
zoomBackIndex = 1; |
198 |
addTool( new MapPaneToolBarAction( |
} |
199 |
TOOL_PAN, |
if (mapArea == null) |
200 |
this, |
return; |
201 |
"", |
|
202 |
new ImageIcon(MapView.class.getResource("resource/icons/pan.png")) |
if (lastZooms.size() > 0 |
203 |
), false ); |
&& mapArea.equals(lastZooms.get(lastZooms.size() - 1))) { |
204 |
// Info |
// LOGGER.debug("MapAreaChangedEvent ausgelassen bei der Zaehlung der Zoomschritt weil identisch"); |
205 |
addTool( new MapPaneToolBarAction( |
return; |
206 |
TOOL_INFO, |
} |
207 |
this, |
|
208 |
"", |
if (lastZooms.size() > 0) |
209 |
new ImageIcon(MapView.class.getResource("resource/icons/info.png")) |
while (zoomBackIndex < lastZooms.size()) |
210 |
), false ); |
lastZooms.remove(lastZooms.size() - 1); |
211 |
|
|
212 |
// Set Selection |
lastZooms.add(mapArea); |
213 |
addTool( new MapPaneToolBarAction( |
zoomBackIndex = lastZooms.size(); |
214 |
TOOL_SELECTION_SET, |
setButtonEnabled(ACTION_ZOOM_BACK, lastZooms.size() > 1); |
215 |
this, |
setButtonEnabled(ACTION_ZOOM_FORWARD, false); |
216 |
"", |
} |
217 |
new ImageIcon(MapView.class.getResource("resource/icons/selection_set.png")) |
}; |
218 |
), false ); |
|
219 |
|
setMapPane(mapPane); |
220 |
// Add Selection |
setFloatable(false); |
221 |
addTool( new MapPaneToolBarAction( |
setRollover(true); |
222 |
TOOL_SELECTION_ADD, |
|
223 |
this, |
init(); |
224 |
"", |
} |
225 |
new ImageIcon(MapView.class.getResource("resource/icons/selection_add.png")) |
|
226 |
), false ); |
/** |
227 |
|
* Sets the {@link JMapPane} controlled by this tool bar. |
228 |
// Remove Selection |
* |
229 |
addTool( new MapPaneToolBarAction( |
* @param mapPane |
230 |
TOOL_SELECTION_REMOVE, |
* {@link JMapPane} to control (if {@code null} this tool bar |
231 |
this, |
* controls NOTHING!) |
232 |
"", |
*/ |
233 |
new ImageIcon(MapView.class.getResource("resource/icons/selection_remove.png")) |
public void setMapPane(JMapPane mapPane) { |
234 |
), false ); |
// Remove listener from old MapPane |
235 |
|
if (this.mapPane != null) |
236 |
// ResetSelection |
this.mapPane.removeMapPaneListener(mapPaneListener); |
237 |
addAction( new MapPaneToolBarAction( |
this.mapPane = mapPane; |
238 |
TOOL_SELECTION_CLEAR, |
if (this.mapPane != null && mapPaneListener != null) |
239 |
this, |
this.mapPane.addMapPaneListener(mapPaneListener); |
240 |
"", |
} |
241 |
new ImageIcon(MapView.class.getResource("resource/icons/selection_clear.png")) |
|
242 |
), false ); |
/** |
243 |
|
* Calls {@link #initToolsAndActions()} and {@link #initActions()} and then |
244 |
// Zoom in |
* puts all tool buttons and all actions buttons to the tool bar. |
245 |
addTool( new MapPaneToolBarAction( |
*/ |
246 |
TOOL_ZOOMIN, |
protected void init() { |
247 |
this, |
initToolsAndActions(); |
248 |
"", |
|
249 |
new ImageIcon(MapView.class.getResource("resource/icons/zoom_in.png")) |
addSeparator(SEPERATOR0, new JToolBar.Separator()); |
250 |
), false ); |
addSeparator(SEPERATOR1, new JToolBar.Separator()); |
251 |
// Zoom out |
|
252 |
addTool( new MapPaneToolBarAction( |
initToolBar(); |
253 |
TOOL_ZOOMOUT, |
} |
254 |
this, |
|
255 |
"", |
/** |
256 |
new ImageIcon(MapView.class.getResource("resource/icons/zoom_out.png")) |
* Creates the tool buttons and action buttons and seperators, adds them to |
257 |
), false ); |
* {@link #toolAndActionButtons} and finally creates a button group for all |
258 |
|
* tools. So sub-classes which override this method should FIRST add their |
259 |
// Action button to revert the last zoom |
* new tool buttons to {@link #toolAndActionButtons} before calling {@code |
260 |
addAction( new MapPaneToolBarAction( |
* super.initTools()}. |
261 |
ACTION_ZOOM_BACK, |
*/ |
262 |
this, |
protected void initToolsAndActions() { |
263 |
"", |
// Panning |
264 |
new ImageIcon(MapView.class.getResource("resource/icons/zoom_back.png")) |
addTool(new MapPaneToolBarAction(TOOL_PAN, this, "", new ImageIcon( |
265 |
), false); |
MapView.class.getResource("resource/icons/pan.png")), R("MapPaneButtons.Pan.TT")), false); |
266 |
setButtonEnabled( ACTION_ZOOM_BACK, false ); |
// Info |
267 |
|
addTool(new MapPaneToolBarAction(TOOL_INFO, this, "", new ImageIcon( |
268 |
// Action button to redo the last zoom |
MapView.class.getResource("resource/icons/info.png")),R("MapPaneButtons.Info.TT")), false); |
269 |
addAction( new MapPaneToolBarAction( |
|
270 |
ACTION_ZOOM_FORWARD, |
// Zoom in |
271 |
this, |
addTool(new MapPaneToolBarAction(TOOL_ZOOMIN, this, "", new ImageIcon( |
272 |
"", |
MapView.class.getResource("resource/icons/zoom_in.png")), R("MapPaneButtons.ZoomIn.TT")), |
273 |
new ImageIcon(MapView.class.getResource("resource/icons/zoom_forward.png")) |
false); |
274 |
), false); |
// Zoom out |
275 |
setButtonEnabled( ACTION_ZOOM_FORWARD, false ); |
addTool(new MapPaneToolBarAction(TOOL_ZOOMOUT, this, "", new ImageIcon( |
276 |
|
MapView.class.getResource("resource/icons/zoom_out.png")), R("MapPaneButtons.ZoomOut.TT")), |
277 |
|
false); |
278 |
// set the selected tool enabled |
|
279 |
setSelectedTool(selectedTool); |
// Action button to revert the last zoom |
280 |
|
addAction(new MapPaneToolBarAction(ACTION_ZOOM_BACK, this, "", |
281 |
} |
new ImageIcon(MapView.class |
282 |
|
.getResource("resource/icons/zoom_back.png")), R("MapPaneButtons.LastZoom.TT")), false); |
283 |
|
setButtonEnabled(ACTION_ZOOM_BACK, false); |
284 |
/** |
|
285 |
* Clears the GUI of all components and adds all tool and action buttons to the |
// Action button to redo the last zoom |
286 |
* tool bar. |
addAction(new MapPaneToolBarAction(ACTION_ZOOM_FORWARD, this, "", |
287 |
*/ |
new ImageIcon(MapView.class |
288 |
protected void initToolBar() { |
.getResource("resource/icons/zoom_forward.png")), R("MapPaneButtons.NextZoom.TT")), |
289 |
setAlignmentY( 1f ); |
false); |
290 |
removeAll(); |
setButtonEnabled(ACTION_ZOOM_FORWARD, false); |
291 |
// Separator to the left of the tool actions to start |
|
292 |
// the tool buttons with the map (not with the coordinate grid) |
// set the selected tool enabled |
293 |
Dimension dimension = new Dimension( 49,10); |
setSelectedTool(selectedTool); |
294 |
addSeparator(dimension); |
|
295 |
// Tool buttons |
} |
296 |
for (JComponent b : toolAndActionButtons.values()) |
|
297 |
add(b); |
/** |
298 |
} |
* Clears the GUI of all components and adds all tool and action buttons to |
299 |
// Space between tool buttons and action buttons |
* the tool bar. |
300 |
// SK: Seperators are now als manages like actions and tools |
*/ |
301 |
// Dimension dimension2 = new Dimension( 10,10); |
public void initToolBar() { |
302 |
// this.addSeparator(dimension2); |
setAlignmentY(1f); |
303 |
|
removeAll(); |
304 |
// // Action buttons |
// Separator to the left of the tool actions to start |
305 |
// for (JButton b : actionButtons.values()) |
// the tool buttons with the map (not with the coordinate grid) |
306 |
// add(b); |
Dimension dimension = new Dimension(49, 10); |
307 |
// } |
addSeparator(dimension); |
308 |
|
// Tool buttons |
309 |
/** |
for (JComponent b : toolAndActionButtons.values()) |
310 |
* Performs the activation of a tool. |
add(b); |
311 |
* @param tool the tool to activate |
|
312 |
* @param e the event of the button |
if (!toolAndActionButtons.containsKey(selectedTool)) { |
313 |
*/ |
/** |
314 |
public void performToolButton(int tool, ActionEvent e) { |
* This might be a bit specific, but IF selection buttons are |
315 |
if ( mapPane == null ) |
* available, select one of them.. if not, select the INFO tool. |
316 |
return; |
*/ |
317 |
|
|
318 |
selectedTool = tool; |
if (toolAndActionButtons.containsKey(TOOL_SELECTION_SET)) { |
319 |
|
setSelectedTool(TOOL_SELECTION_SET); |
320 |
switch( tool ) { |
} else if (toolAndActionButtons.containsKey(TOOL_INFO)) { |
321 |
case TOOL_PAN: |
setSelectedTool(TOOL_INFO); |
322 |
// Set the mouse tool to "Panning" |
} else { |
323 |
mapPane.setWindowSelectionState(JMapPane.NONE); |
// TODO What to do now?! |
324 |
mapPane.setState(JMapPane.PAN); |
setSelectedTool(null); |
325 |
mapPane.setHighlight(false); |
} |
326 |
mapPane.setNormalCursor(SwingUtil.PAN_CURSOR); |
|
327 |
break; |
} |
328 |
case TOOL_INFO: |
|
329 |
// Set the mouse tool to "Info" |
revalidate(); |
330 |
mapPane.setWindowSelectionState(JMapPane.NONE); |
repaint(); |
331 |
mapPane.setState(JMapPane.SELECT_TOP); // Why not: JMapPane.SELECT_TOP_ONEONLY |
} |
332 |
mapPane.setHighlight(false);// SK: Was true, but since it not works properly removed it to save performance |
|
333 |
mapPane.setNormalCursor(SwingUtil.CROSSHAIR_CURSOR); |
// Space between tool buttons and action buttons |
334 |
break; |
// SK: Seperators are now als manages like actions and tools |
335 |
case TOOL_SELECTION_SET: |
// Dimension dimension2 = new Dimension( 10,10); |
336 |
case TOOL_SELECTION_ADD: |
// this.addSeparator(dimension2); |
337 |
case TOOL_SELECTION_REMOVE: |
|
338 |
// Set the mouse tool to "Select" |
// // Action buttons |
339 |
mapPane.setWindowSelectionState(JMapPane.SELECT_TOP); |
// for (JButton b : actionButtons.values()) |
340 |
mapPane.setState(JMapPane.SELECT_TOP); |
// add(b); |
341 |
mapPane.setHighlight(false); |
// } |
342 |
mapPane.setNormalCursor(SwingUtil.CROSSHAIR_CURSOR); // TODO Select Cursor |
|
343 |
break; |
/** |
344 |
case TOOL_ZOOMIN: |
* Performs the activation of a tool. |
345 |
// Set the mouse tool to "Zoom in" |
* |
346 |
mapPane.setWindowSelectionState(JMapPane.ZOOM_IN); |
* @param tool |
347 |
mapPane.setState(JMapPane.ZOOM_IN); |
* the tool to activate |
348 |
mapPane.setHighlight(false); |
* @param e |
349 |
mapPane.setNormalCursor(SwingUtil.ZOOMIN_CURSOR); |
* the event of the button |
350 |
break; |
*/ |
351 |
case TOOL_ZOOMOUT: |
public void performToolButton(int tool, ActionEvent e) { |
352 |
// Set the mouse tool to "Zoom out" |
if (mapPane == null) |
353 |
mapPane.setWindowSelectionState(JMapPane.NONE); |
return; |
354 |
mapPane.setState(JMapPane.ZOOM_OUT); |
|
355 |
mapPane.setHighlight(false); |
selectedTool = tool; |
356 |
mapPane.setNormalCursor(SwingUtil.ZOOMOUT_CURSOR); |
|
357 |
break; |
switch (tool) { |
358 |
default: |
case TOOL_PAN: |
359 |
// Set map actions to default |
// Set the mouse tool to "Panning" |
360 |
mapPane.setWindowSelectionState(JMapPane.NONE); |
mapPane.setWindowSelectionState(JMapPane.NONE); |
361 |
mapPane.setState(JMapPane.NONE); |
mapPane.setState(JMapPane.PAN); |
362 |
mapPane.setHighlight(false); |
mapPane.setNormalCursor(SwingUtil.PAN_CURSOR); |
363 |
mapPane.setNormalCursor(null); |
break; |
364 |
break; |
case TOOL_INFO: |
365 |
} |
// Set the mouse tool to "Info" |
366 |
mapPane.updateCursor(); |
mapPane.setWindowSelectionState(JMapPane.NONE); |
367 |
} |
mapPane.setState(JMapPane.SELECT_TOP); // Why not: |
368 |
|
// JMapPane.SELECT_TOP_ONEONLY |
369 |
/** |
// properly removed it to save |
370 |
* Performs the action of an action button. |
// performance |
371 |
* @param tool the action |
mapPane.setNormalCursor(SwingUtil.CROSSHAIR_CURSOR); |
372 |
* @param e the event of the button |
break; |
373 |
*/ |
case TOOL_ZOOMIN: |
374 |
protected void performActionButton(int action, ActionEvent e) { |
// Set the mouse tool to "Zoom in" |
375 |
if ( mapPane == null ) |
mapPane.setWindowSelectionState(JMapPane.ZOOM_IN); |
376 |
return; |
mapPane.setState(JMapPane.ZOOM_IN); |
377 |
|
mapPane.setNormalCursor(SwingUtil.ZOOMIN_CURSOR); |
378 |
// Perform the action "Zoom back": Revert the last zoom |
break; |
379 |
if ( action == ACTION_ZOOM_BACK ) { |
case TOOL_ZOOMOUT: |
380 |
if (zoomBackIndex <= 1) |
// Set the mouse tool to "Zoom out" |
381 |
return; |
mapPane.setWindowSelectionState(JMapPane.NONE); |
382 |
|
mapPane.setState(JMapPane.ZOOM_OUT); |
383 |
zoomBackForwardButtonInAction = true; |
mapPane.setNormalCursor(SwingUtil.ZOOMOUT_CURSOR); |
384 |
zoomBackIndex--; |
break; |
385 |
getButton(ACTION_ZOOM_FORWARD).setEnabled(true); |
default: |
386 |
getButton(ACTION_ZOOM_BACK).setEnabled( zoomBackIndex > 1 ); |
// Set map actions to default |
387 |
|
mapPane.setWindowSelectionState(JMapPane.NONE); |
388 |
mapPane.setMapArea( lastZooms.get(zoomBackIndex-1) ); |
mapPane.setState(JMapPane.NONE); |
389 |
mapPane.refresh(); |
mapPane.setNormalCursor(null); |
390 |
} |
break; |
391 |
|
} |
392 |
// Perform the action "Zoom forward": Redo the last zoom |
mapPane.updateCursor(); |
393 |
if ( action == ACTION_ZOOM_FORWARD ) { |
} |
394 |
if (zoomBackIndex < lastZooms.size()) { |
|
395 |
zoomBackForwardButtonInAction = true; |
/** |
396 |
zoomBackIndex++; |
* @param id |
397 |
getButton(ACTION_ZOOM_BACK).setEnabled(true); |
* The ID of the Component to remove. The change will not be |
398 |
getButton(ACTION_ZOOM_FORWARD).setEnabled(zoomBackIndex < lastZooms.size()); |
* visible until {@link #initToolBar()} is called. |
399 |
|
* @return <code>null</code> or the component that has been removed. |
400 |
mapPane.setMapArea( lastZooms.get(zoomBackIndex-1) ); |
*/ |
401 |
mapPane.refresh(); |
public JComponent removeId(int id) { |
402 |
} |
return toolAndActionButtons.remove(id); |
403 |
} |
} |
404 |
} |
|
405 |
|
/** |
406 |
|
* Performs the action of an action button. |
407 |
/** |
* |
408 |
* Adds a tool to the tool bar. Does nothing if a tool or action with the |
* @param tool |
409 |
* specified ID already exists! |
* the action |
410 |
* @param buttonAction action for the toggle button |
* @param e |
411 |
* @param resetToolBar indicates whether the toolbar GUI is reset after adding |
* the event of the button |
412 |
* the button (if adding several actions it useful only to |
*/ |
413 |
* reset the GUI for the last added tool) |
protected void performActionButton(int action, ActionEvent e) { |
414 |
*/ |
if (mapPane == null) |
415 |
public void addTool(MapPaneToolBarAction buttonAction, boolean resetToolBar) { |
return; |
416 |
if ( isButtonIDUsed(buttonAction.getID()) ) { |
|
417 |
LOGGER.warn("addTool(.) ignored because ID already used for tool or action: "+buttonAction.getID()); |
// Perform the action "Zoom back": Revert the last zoom |
418 |
return; |
if (action == ACTION_ZOOM_BACK) { |
419 |
} |
if (zoomBackIndex <= 1) |
420 |
JToggleButton button = new JToggleButton(buttonAction); |
return; |
421 |
button.setBorder( BorderFactory.createRaisedBevelBorder() ); |
|
422 |
toolButtonGroup.add(button); |
zoomBackForwardButtonInAction = true; |
423 |
toolAndActionButtons.put(buttonAction.getID(), button); |
zoomBackIndex--; |
424 |
if ( resetToolBar ) |
getButton(ACTION_ZOOM_FORWARD).setEnabled(true); |
425 |
initToolBar(); |
getButton(ACTION_ZOOM_BACK).setEnabled(zoomBackIndex > 1); |
426 |
} |
|
427 |
|
mapPane.setMapArea(lastZooms.get(zoomBackIndex - 1)); |
428 |
/** |
mapPane.refresh(); |
429 |
* Adds a tool to the tool bar and resets the toolbar GUI. |
} |
430 |
* @param buttonAction action for the toggle button |
|
431 |
*/ |
// Perform the action "Zoom forward": Re-do the last zoom |
432 |
public void addTool(MapPaneToolBarAction buttonAction) { |
if (action == ACTION_ZOOM_FORWARD) { |
433 |
addTool(buttonAction, true); |
if (zoomBackIndex < lastZooms.size()) { |
434 |
} |
zoomBackForwardButtonInAction = true; |
435 |
|
zoomBackIndex++; |
436 |
/** |
getButton(ACTION_ZOOM_BACK).setEnabled(true); |
437 |
* Adds an action to the tool bar. Does nothing if a tool or action with the |
getButton(ACTION_ZOOM_FORWARD).setEnabled( |
438 |
* specified ID already exists! |
zoomBackIndex < lastZooms.size()); |
439 |
* @param buttonAction action for the button |
|
440 |
* @param resetToolBar indicates whether the toolbar GUI is reset after adding |
mapPane.setMapArea(lastZooms.get(zoomBackIndex - 1)); |
441 |
* the button (if adding several actions it useful only to |
mapPane.refresh(); |
442 |
* reset the GUI for the last added tool) |
} |
443 |
*/ |
} |
444 |
public void addAction(MapPaneToolBarAction buttonAction, boolean resetToolBar) { |
} |
445 |
if ( isButtonIDUsed(buttonAction.getID()) ) { |
|
446 |
LOGGER.warn("addAction(.) ignored because ID already used for tool or action: "+buttonAction.getID()); |
/** |
447 |
return; |
* Adds a tool to the tool bar. Does nothing if a tool or action with the |
448 |
} |
* specified ID already exists! |
449 |
JButton button = new JButton(buttonAction); |
* |
450 |
button.setBorder( BorderFactory.createRaisedBevelBorder() ); |
* @param buttonAction |
451 |
toolAndActionButtons.put( buttonAction.getID(), button ); |
* action for the toggle button |
452 |
if ( resetToolBar ) |
* @param resetToolBar |
453 |
initToolBar(); |
* indicates whether the toolbar GUI is reset after adding the |
454 |
} |
* button (if adding several actions it useful only to reset the |
455 |
|
* GUI for the last added tool) |
456 |
|
*/ |
457 |
private void addSeparator(int id, Separator separator) { |
public void addTool(MapPaneToolBarAction buttonAction, boolean resetToolBar) { |
458 |
if ( isButtonIDUsed(id) ) { |
if (isButtonIDUsed(buttonAction.getID())) { |
459 |
LOGGER.warn("addSeparator(.) ignored because ID already used for tool or action. "); |
LOGGER |
460 |
return; |
.warn("addTool(.) ignored because ID already used for tool or action: " |
461 |
} |
+ buttonAction.getID()); |
462 |
toolAndActionButtons.put( id, separator); |
return; |
463 |
} |
} |
464 |
|
JToggleButton button = new JToggleButton(buttonAction); |
465 |
/** |
button.setBorder(BorderFactory.createRaisedBevelBorder()); |
466 |
* Adds an action to the tool bar and resets the toolbar GUI. |
toolButtonGroup.add(button); |
467 |
* @param buttonAction action for the toggle button |
toolAndActionButtons.put(buttonAction.getID(), button); |
468 |
*/ |
if (resetToolBar) |
469 |
public void addAction(MapPaneToolBarAction buttonAction) { |
initToolBar(); |
470 |
addAction(buttonAction, true); |
} |
471 |
} |
|
472 |
|
|
473 |
/** |
|
474 |
* Returns the button for a specific tool or action. |
/** |
475 |
* @param id the constant for any button in the {@link MapPaneToolBar} |
* Adds a tool to the tool bar and resets the toolbar GUI. |
476 |
* @return a {@link JButton} if {@code id} specifies an {@linkplain #getActionButton(int) action button} |
* |
477 |
* or {@link JToogleButton} if {@code id} specifies a {@linkplain #getToolButton(int) tool button} |
* @param buttonAction |
478 |
*/ |
* action for the toggle button |
479 |
public AbstractButton getButton(int id) { |
*/ |
480 |
AbstractButton button = (AbstractButton)toolAndActionButtons.get(id); |
public void addTool(MapPaneToolBarAction buttonAction) { |
481 |
if ( button == null ) |
addTool(buttonAction, true); |
482 |
LOGGER.warn("Unknown tool or action ID: "+id); |
} |
483 |
return button; |
|
484 |
} |
/** |
485 |
|
* Adds an action to the tool bar. Does nothing if a tool or action with the |
486 |
/** |
* specified ID already exists! |
487 |
* Returns the button for a specific tool. |
* |
488 |
* @param tool the constant for a tool |
* @param buttonAction |
489 |
*/ |
* action for the button |
490 |
public JToggleButton getToolButton(int tool) { |
* @param resetToolBar |
491 |
AbstractButton button = getButton(tool); |
* indicates whether the toolbar GUI is reset after adding the |
492 |
if ( button != null && !(button instanceof JToggleButton) ) { |
* button (if adding several actions it useful only to reset the |
493 |
LOGGER.warn("ID specifies no tool: "+tool); |
* GUI for the last added tool) |
494 |
button = null; |
*/ |
495 |
} |
public void addAction(MapPaneToolBarAction buttonAction, |
496 |
return (JToggleButton)button; |
boolean resetToolBar) { |
497 |
} |
if (isButtonIDUsed(buttonAction.getID())) { |
498 |
|
LOGGER |
499 |
/** |
.warn("addAction(.) ignored because ID already used for tool or action: " |
500 |
* Returns the button for a specific action. |
+ buttonAction.getID()); |
501 |
* @param action the constant an action |
return; |
502 |
*/ |
} |
503 |
public JButton getActionButton(int action) { |
JButton button = new JButton(buttonAction); |
504 |
AbstractButton button = getButton(action); |
button.setBorder(BorderFactory.createRaisedBevelBorder()); |
505 |
if ( button != null && !(button instanceof JButton) ) { |
toolAndActionButtons.put(buttonAction.getID(), button); |
506 |
LOGGER.warn("ID specifies no action: "+action); |
if (resetToolBar) |
507 |
button = null; |
initToolBar(); |
508 |
} |
} |
509 |
return (JButton)button; |
|
510 |
|
/** |
511 |
} |
* Adds any JComponent to the tool bar. Does nothing if a tool or action with the |
512 |
|
* specified ID already exists! |
513 |
/** |
* |
514 |
* Sets the selected tool. |
* @param component A {@link JComponent} that shall be added |
515 |
* @param tool ID of the tool |
* @param id The ID associaded with the {@link JComponent} |
516 |
*/ |
* @param resetToolBar |
517 |
public void setSelectedTool(Integer tool) { |
* indicates whether the toolbar GUI is reset after adding the |
518 |
if ( tool == null ) |
* button (if adding several actions it useful only to reset the |
519 |
toolButtonGroup.setUnselected(); |
* GUI for the last added tool) |
520 |
|
*/ |
521 |
JToggleButton button = getToolButton(tool); |
public void addJComponent(JComponent component, int id, |
522 |
if ( button == null ) |
boolean resetToolBar) { |
523 |
return; |
|
524 |
button.setSelected( true ); |
if (isButtonIDUsed(id)) { |
525 |
button.getAction().actionPerformed(null); |
LOGGER |
526 |
} |
.warn("addAction(.) ignored because ID already used for tool or action: " |
527 |
|
+ id); |
528 |
/** |
return; |
529 |
* Returns the selected tool. |
} |
530 |
* @return -1 if no tool is active |
|
531 |
*/ |
toolAndActionButtons.put(id, component); |
532 |
public int getSelectedTool() { |
if (resetToolBar) |
533 |
if ( toolButtonGroup.getSelectedButton() == null ) |
initToolBar(); |
534 |
return -1; |
} |
535 |
return selectedTool; |
|
536 |
} |
public void addSeparator(int id, Separator separator) { |
537 |
|
if (isButtonIDUsed(id)) { |
538 |
/** |
LOGGER |
539 |
* Sets whether a tool or action is activated or not. The visible property |
.warn("addSeparator(.) ignored because ID already used for tool or action. "); |
540 |
* of the button is not affected. |
return; |
541 |
* @param id tool or actionID |
} |
542 |
* @param enabled if {@code true} the tool becomes available |
toolAndActionButtons.put(id, separator); |
543 |
*/ |
} |
544 |
public void setButtonEnabled(int id, boolean enabled) { |
|
545 |
AbstractButton button = getButton(id); |
/** |
546 |
if ( button == null ) |
* Adds an action to the tool bar and resets the toolbar GUI. |
547 |
return; |
* |
548 |
button.setEnabled( enabled ); |
* @param buttonAction |
549 |
} |
* action for the toggle button |
550 |
|
*/ |
551 |
/** |
public void addAction(MapPaneToolBarAction buttonAction) { |
552 |
* Sets whether a tool or action is activated or not. |
addAction(buttonAction, true); |
553 |
* @param id tool or actionID |
} |
554 |
* @param enabled if {@code true} the tool becomes available |
|
555 |
* @param hideOnDisable if {@code true} the button is also hidden if |
/** |
556 |
* {@code enabled} is {@code false} |
* Returns the button for a specific tool or action. |
557 |
*/ |
* |
558 |
public void setButtonEnabled(int id, boolean enabled, boolean hideOnDisable) { |
* @param id |
559 |
AbstractButton button = getButton(id); |
* the constant for any button in the {@link MapPaneToolBar} |
560 |
if ( button == null ) |
* @return a {@link JButton} if {@code id} specifies an |
561 |
return; |
* {@linkplain #getActionButton(int) action button} or |
562 |
button.setEnabled( enabled ); |
* {@link JToogleButton} if {@code id} specifies a |
563 |
// if button is enabled, it becomes visible anyway |
* {@linkplain #getToolButton(int) tool button} |
564 |
// if button is disabled and the "hide" option is set, it is also hidden |
*/ |
565 |
if ( enabled ) |
public AbstractButton getButton(int id) { |
566 |
button.setVisible( true ); |
AbstractButton button = (AbstractButton) toolAndActionButtons.get(id); |
567 |
else |
if (button == null) |
568 |
button.setVisible( !hideOnDisable ); |
LOGGER.warn("Unknown tool or action ID: " + id); |
569 |
} |
return button; |
570 |
|
} |
571 |
/** |
|
572 |
* Checks whether a ID is already used for a tool or action. |
/** |
573 |
* @param tool tool ID |
* Returns the button for a specific tool. |
574 |
*/ |
* |
575 |
public boolean isButtonIDUsed(int id) { |
* @param tool |
576 |
return toolAndActionButtons.get(id) != null; |
* the constant for a tool |
577 |
} |
*/ |
578 |
|
public JToggleButton getToolButton(int tool) { |
579 |
/** |
AbstractButton button = getButton(tool); |
580 |
* Checks whether a tool is activated. |
if (button != null && !(button instanceof JToggleButton)) { |
581 |
* @param tool tool ID |
LOGGER.warn("ID specifies no tool: " + tool); |
582 |
* @return {@code false} if an unknown ID is specified |
button = null; |
583 |
*/ |
} |
584 |
public boolean isButtonEnabled(int id) { |
return (JToggleButton) button; |
585 |
AbstractButton button = getButton(id); |
} |
586 |
if ( button != null ) |
|
587 |
return button.isEnabled(); |
/** |
588 |
return false; |
* Returns the button for a specific action. |
589 |
} |
* |
590 |
|
* @param action |
591 |
/** |
* the constant an action |
592 |
* Sets the activation for all tools. |
*/ |
593 |
* @param enabled if {@code true} all tools becomes available |
public JButton getActionButton(int action) { |
594 |
* @param hideOnDisable if {@code true} the buttons are also hidden if |
AbstractButton button = getButton(action); |
595 |
* {@code enabled} is {@code false} |
if (button != null && !(button instanceof JButton)) { |
596 |
*/ |
LOGGER.warn("ID specifies no action: " + action); |
597 |
public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) { |
button = null; |
598 |
for (int tool : toolAndActionButtons.keySet()) |
} |
599 |
setButtonEnabled(tool,enabled,hideOnDisable); |
return (JButton) button; |
600 |
} |
|
601 |
|
} |
602 |
/** |
|
603 |
* Sets the activation for all actions. |
/** |
604 |
* @param enabled if {@code true} all actions becomes available |
* Sets the selected tool. |
605 |
* @param hideOnDisable if {@code true} the buttons are also hidden if |
* |
606 |
* {@code enabled} is {@code false} |
* @param tool |
607 |
*/ |
* ID of the tool |
608 |
public void setAllActionsEnabled(boolean enabled, boolean hideOnDisable) { |
*/ |
609 |
for (int id : toolAndActionButtons.keySet()){ |
public void setSelectedTool(Integer tool) { |
610 |
if (toolAndActionButtons.get(id) instanceof JButton){ |
if (tool == null) |
611 |
setButtonEnabled(id,enabled,hideOnDisable); |
toolButtonGroup.setUnselected(); |
612 |
} |
|
613 |
} |
JToggleButton button = getToolButton(tool); |
614 |
|
if (button == null) |
615 |
} |
return; |
616 |
|
button.setSelected(true); |
617 |
/** |
button.getAction().actionPerformed(null); |
618 |
* Returns the maximum ID of tools. |
|
619 |
*/ |
selectedTool = tool; |
620 |
public int getMaxToolID() { |
} |
621 |
return toolAndActionButtons.lastKey(); |
|
622 |
} |
/** |
623 |
|
* Returns the selected tool. |
624 |
/** |
* |
625 |
* Returns the minimum ID of tools. |
* @return -1 if no tool is active |
626 |
*/ |
*/ |
627 |
public int getMinToolID() { |
public int getSelectedTool() { |
628 |
return toolAndActionButtons.firstKey(); |
if (toolButtonGroup.getSelectedButton() == null) |
629 |
} |
return -1; |
630 |
// |
return selectedTool; |
631 |
// /** |
} |
632 |
// * Returns the maximum ID of actions. |
|
633 |
// */ |
/** |
634 |
// public int getMaxActionID() { |
* Sets whether a tool or action is activated or not. The visible property |
635 |
// return actionButtons.lastKey(); |
* of the button is not affected. |
636 |
// } |
* |
637 |
// |
* @param id |
638 |
// /** |
* tool or actionID |
639 |
// * Returns the minimum ID of actions. |
* @param enabled |
640 |
// */ |
* if {@code true} the tool becomes available |
641 |
// public int getMinActionID() { |
*/ |
642 |
// return actionButtons.firstKey(); |
public void setButtonEnabled(int id, boolean enabled) { |
643 |
// } |
AbstractButton button = getButton(id); |
644 |
|
if (button == null) |
645 |
/** |
return; |
646 |
* Extends the {@link AbstractAction} with maintaining an ID and |
button.setEnabled(enabled); |
647 |
* the {@link MapPaneToolBar} the actions controls. |
} |
648 |
* Additionally this class automatically calls {@link MapPaneToolBar#performToolButton(int, ActionEvent)} |
|
649 |
* or {@link MapPaneToolBar#performActionButton(int, ActionEvent)} |
/** |
650 |
* depending on whether the action is added via {@link MapPaneToolBar#addTool(MapPaneToolBarAction)} |
* Sets whether a tool or action is activated or not. |
651 |
* or {@link MapPaneToolBar#addAction(MapPaneToolBarAction)}. |
* |
652 |
* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany) |
* @param id |
653 |
*/ |
* tool or actionID |
654 |
public static class MapPaneToolBarAction extends AbstractAction { |
* @param enabled |
655 |
/** The ID of the action */ |
* if {@code true} the tool becomes available |
656 |
protected int id = -1; |
* @param hideOnDisable |
657 |
/** The tool bar, this action is made for. */ |
* if {@code true} the button is also hidden if {@code enabled} |
658 |
protected MapPaneToolBar toolBar = null; |
* is {@code false} |
659 |
|
*/ |
660 |
/** |
public void setButtonEnabled(int id, boolean enabled, boolean hideOnDisable) { |
661 |
* Creates a new action with a dummy description and no icon. |
AbstractButton button = getButton(id); |
662 |
* @param id unique ID for the action |
if (button == null) |
663 |
* @param toolBar toolbar this action is made for |
return; |
664 |
*/ |
button.setEnabled(enabled); |
665 |
public MapPaneToolBarAction(int id, MapPaneToolBar toolBar) { |
// if button is enabled, it becomes visible anyway |
666 |
this(id,toolBar,""+id); |
// if button is disabled and the "hide" option is set, it is also hidden |
667 |
} |
if (enabled) |
668 |
|
button.setVisible(true); |
669 |
/** |
else |
670 |
* Creates a new action without an icon. |
button.setVisible(!hideOnDisable); |
671 |
* @param id unique ID for the action |
} |
672 |
* @param toolBar toolbar this action is made for |
|
673 |
* @param name description used for buttons or menus |
/** |
674 |
*/ |
* Checks whether a ID is already used for a tool or action. |
675 |
public MapPaneToolBarAction(int id, MapPaneToolBar toolBar, String name) { |
* |
676 |
this(id,toolBar,name,null); |
* @param tool |
677 |
} |
* tool ID |
678 |
|
*/ |
679 |
/** |
public boolean isButtonIDUsed(int id) { |
680 |
* Creates a new action. |
return toolAndActionButtons.get(id) != null; |
681 |
* @param id unique ID for the action |
} |
682 |
* @param toolBar toolbar this action is made for |
|
683 |
* @param name description used for buttons or menus |
/** |
684 |
* @param icon icon used for buttons or menus |
* Checks whether a tool is activated. |
685 |
*/ |
* |
686 |
public MapPaneToolBarAction(int id, MapPaneToolBar toolBar, String name, Icon icon) { |
* @param tool |
687 |
super(name,icon); |
* tool ID |
688 |
this.id = id; |
* @return {@code false} if an unknown ID is specified |
689 |
this.toolBar = toolBar; |
*/ |
690 |
} |
public boolean isButtonEnabled(int id) { |
691 |
|
AbstractButton button = getButton(id); |
692 |
/** |
if (button != null) |
693 |
* Calls {@link MapPaneToolBar#performToolButton(int, ActionEvent)} |
return button.isEnabled(); |
694 |
* or {@link MapPaneToolBar#performActionButton(int, ActionEvent)} |
return false; |
695 |
* depending on whether the action is added to the toolbar via |
} |
696 |
* {@link MapPaneToolBar#addTool(MapPaneToolBarAction)} |
|
697 |
* or {@link MapPaneToolBar#addAction(MapPaneToolBarAction)}. |
/** |
698 |
*/ |
* Sets the activation for all tools. |
699 |
public void actionPerformed(ActionEvent e) { |
* |
700 |
if ( toolBar.toolAndActionButtons.get(id) instanceof JToggleButton) |
* @param enabled |
701 |
toolBar.performToolButton(id, e); |
* if {@code true} all tools becomes available |
702 |
else if ( toolBar.toolAndActionButtons.get(id) instanceof JButton ) |
* @param hideOnDisable |
703 |
toolBar.performActionButton(id, e); |
* if {@code true} the buttons are also hidden if {@code enabled} |
704 |
} |
* is {@code false} |
705 |
|
*/ |
706 |
/** |
public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) { |
707 |
* Returns the (unique) id of this action. |
for (int tool : toolAndActionButtons.keySet()) |
708 |
* @return |
setButtonEnabled(tool, enabled, hideOnDisable); |
709 |
*/ |
} |
710 |
public int getID() { |
|
711 |
return id; |
/** |
712 |
} |
* Sets the activation for all actions. |
713 |
} |
* |
714 |
} |
* @param enabled |
715 |
|
* 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ü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 |
|
} |