1 |
package skrueger.geotools; |
/******************************************************************************* |
2 |
|
* Copyright (c) 2009 Martin O. J. Schmitz. |
3 |
import java.awt.BorderLayout; |
* |
4 |
import java.awt.Window; |
* This file is part of the SCHMITZM library - a collection of utility |
5 |
|
* classes based on Java 1.6, focusing (not only) on Java Swing |
6 |
import javax.swing.BorderFactory; |
* and the Geotools library. |
7 |
import javax.swing.JComponent; |
* |
8 |
import javax.swing.JPanel; |
* The SCHMITZM project is hosted at: |
9 |
import javax.swing.JSplitPane; |
* http://wald.intevation.org/projects/schmitzm/ |
10 |
|
* |
11 |
import org.apache.log4j.Logger; |
* This program is free software; you can redistribute it and/or |
12 |
|
* modify it under the terms of the GNU Lesser General Public License |
13 |
import schmitzm.geotools.gui.GeoMapPane; |
* as published by the Free Software Foundation; either version 3 |
14 |
import schmitzm.geotools.gui.JMapPane; |
* of the License, or (at your option) any later version. |
15 |
import schmitzm.geotools.gui.MapContextControlPane; |
* |
16 |
import schmitzm.geotools.gui.MapPaneStatusBar; |
* This program is distributed in the hope that it will be useful, |
17 |
import schmitzm.geotools.styling.ColorMapManager; |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
18 |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
19 |
/** |
* GNU General Public License for more details. |
20 |
* Achtung! Dieser code ist verwuestet |
* |
21 |
*/ |
* You should have received a copy of the GNU Lesser General Public License (license.txt) |
22 |
|
* 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 |
* TODO DOKU und initialize schöner machen. SK |
* or try this link: http://www.gnu.org/licenses/lgpl.html |
25 |
*/ |
* |
26 |
public class MapView extends JPanel { |
* Contributors: |
27 |
private static final Logger LOGGER = Logger.getLogger(MapView.class); |
* Martin O. J. Schmitz - initial API and implementation |
28 |
|
* Stefan A. Tzeggai - additional utility classes |
29 |
private final JSplitPane splitPane = new JSplitPane( |
******************************************************************************/ |
30 |
JSplitPane.HORIZONTAL_SPLIT); |
package skrueger.geotools; |
31 |
|
|
32 |
protected MapPaneStatusBar statusBar = null; |
import java.awt.BorderLayout; |
33 |
|
import java.awt.Component; |
34 |
/** |
|
35 |
* Komponente, in der die Karten, der Massstab und das Koordinaten-Raster |
import javax.swing.BorderFactory; |
36 |
* dargestellt werden |
import javax.swing.JComponent; |
37 |
*/ |
import javax.swing.JPanel; |
38 |
protected final GeoMapPane geoMapPane = new GeoMapPane(); |
import javax.swing.JSplitPane; |
39 |
|
|
40 |
private MapPaneToolBar jToolBar; |
import net.miginfocom.swing.MigLayout; |
41 |
|
|
42 |
/** |
import org.apache.log4j.Logger; |
43 |
* Creates a new {@link MapView}. A {@link MapView} is a combination of a |
|
44 |
* {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, |
import schmitzm.geotools.gui.GeoMapPane; |
45 |
* and some buttons floating over the {@link JMapPane} |
import schmitzm.geotools.gui.MapContextControlPane; |
46 |
*/ |
import schmitzm.geotools.gui.MapPaneStatusBar; |
47 |
public MapView(Window parentGui, MapPaneToolBar toolBar) { |
import schmitzm.geotools.gui.SelectableXMapPane; |
48 |
super(new BorderLayout()); |
import schmitzm.geotools.styling.ColorMapManager; |
49 |
// Call initialize() by yourself afterwards. |
|
50 |
// Needed because variables for the overwritten methods |
/** |
51 |
// are not yet set. |
* Achtung! Dieser code ist verwuestet TODO DOKU und initialize schöner machen. |
52 |
getGeoMapPane().getMapPane().setWaitCursorComponent(parentGui); |
* SK |
53 |
if ( toolBar == null ) |
*/ |
54 |
toolBar = new MapPaneToolBar(getMapPane()); |
public class MapView extends JPanel { |
55 |
jToolBar = toolBar; |
private static final Logger LOGGER = Logger.getLogger(MapView.class); |
56 |
} |
|
57 |
|
private final JSplitPane splitPane = new JSplitPane( |
58 |
/** |
JSplitPane.HORIZONTAL_SPLIT); |
59 |
* Creates a new {@link MapView}. A {@link MapView} is a combination of a |
|
60 |
* {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, |
protected MapPaneStatusBar statusBar = null; |
61 |
* and some buttons floating over the {@link JMapPane} |
|
62 |
*/ |
/** |
63 |
public MapView(Window parentGui) { |
* Komponente, in der die Karten, der Massstab und das Koordinaten-Raster |
64 |
this(parentGui, null); |
* dargestellt werden. |
65 |
} |
*/ |
66 |
|
|
67 |
/** |
protected final GeoMapPane geoMapPane = new GeoMapPane(); |
68 |
* Calls #getSidePanel() which can be overwritten. |
|
69 |
* |
private MapPaneToolBar jToolBar; |
70 |
* @see #adjustSizeOfGeoMapPane() |
|
71 |
*/ |
/** |
72 |
public void initialize() { |
* Creates a new {@link MapView}. A {@link MapView} is a combination of a |
73 |
// horizontales SplitPane initialisieren |
* {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and |
74 |
|
* some buttons floating over the {@link SelectableXMapPane} |
75 |
// Status-Zeile |
*/ |
76 |
statusBar = new MapPaneStatusBar(getGeoMapPane() |
public MapView(Component parentGui, MapPaneToolBar toolBar) { |
77 |
.getMapPane()); |
super(new BorderLayout()); |
78 |
statusBar.setBorder(BorderFactory.createCompoundBorder(BorderFactory |
// Call initialize() by yourself afterwards. |
79 |
.createLoweredBevelBorder(), BorderFactory.createEmptyBorder(2, |
// Needed because variables for the overwritten methods |
80 |
5, 2, 5))); |
// are not yet set. |
81 |
this.add(statusBar, BorderLayout.SOUTH); |
jToolBar = toolBar; |
82 |
|
|
83 |
splitPane.setDividerLocation(0.4); |
// By default the MapPane will render with antialiasing on |
84 |
splitPane.setDividerSize(5); |
getGeoMapPane().getMapPane() |
85 |
|
.setAntiAliasing(true); |
86 |
splitPane.add(getSidePane()); |
} |
87 |
|
|
88 |
/*********************************************************************** |
/** |
89 |
* To the right side we now add a JPanel that consists of a toolbar and |
* Creates a new {@link MapView}. A {@link MapView} is a combination of a |
90 |
* a gmp |
* {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and |
91 |
*/ |
* some buttons floating over the {@link SelectableXMapPane} |
92 |
JPanel newRight = new JPanel(new BorderLayout()); |
*/ |
93 |
newRight.add(getToolBar(), BorderLayout.NORTH); |
public MapView(Component parentGui) { |
94 |
newRight.add(getGeoMapPane(), BorderLayout.CENTER); |
this(parentGui, null); |
95 |
splitPane.add(newRight); |
} |
96 |
|
|
97 |
this.add(splitPane, BorderLayout.CENTER); |
/** |
98 |
} |
* This routine creates the main components of the GUI: The left Side and |
99 |
|
* the map on the right side.<br/> |
100 |
/** |
* Calls #getSidePanel() which can be overwritten (call super!).<br/> |
101 |
* Returns the tool bar which controls the active mouse actions on the map. |
* |
102 |
* @return |
* This method initialized the variables {@link #statusBar} and |
103 |
*/ |
* {@link #splitPane} |
104 |
public MapPaneToolBar getToolBar() { |
* |
105 |
return jToolBar; |
* @see #adjustSizeOfGeoMapPane() |
106 |
} |
*/ |
107 |
|
public void initialize() { |
108 |
/** |
// horizontales SplitPane initialisieren |
109 |
* Returns the split pane which divides the layer list from the map panel. |
|
110 |
*/ |
// Status-Line to show Coordinates and Rastervalues. |
111 |
public JSplitPane getSplitPane() { |
statusBar = new MapPaneStatusBar(getGeoMapPane().getMapPane()); |
112 |
return this.splitPane; |
statusBar.setBorder(BorderFactory.createCompoundBorder(BorderFactory |
113 |
} |
.createLoweredBevelBorder(), BorderFactory.createEmptyBorder(2, |
114 |
|
5, 2, 5))); |
115 |
|
this.add(statusBar, BorderLayout.SOUTH); |
116 |
/** |
|
117 |
* Sets the active tool. |
/** |
118 |
* Simply calls {@link MapPaneToolBar#setSelectedTool(Integer)}. |
* The layout of the split pane can be configured in the atlas. |
119 |
* @param tool |
* setDividerLocation(-1); has no effect here because the component is |
120 |
* One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants |
* not visible yet. |
121 |
*/ |
*/ |
122 |
public void setSelectedTool(Integer tool) { |
getSplitPane().setDividerSize(5); |
123 |
jToolBar.setSelectedTool(tool); |
|
124 |
} |
getSplitPane().setResizeWeight(0.0); |
125 |
|
getSplitPane().add(getSidePane()); |
126 |
/** |
|
127 |
* Sets whether a tool is activated or not. |
/*********************************************************************** |
128 |
* Simply calls {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}. |
* To the right side we now add a JPanel that consists of a toolbar and |
129 |
* @param tool tool ID |
* a gmp |
130 |
* @param enabled if {@code true} the tool becomes available |
*/ |
131 |
* @param hideOnDisable if {@code true} the button is also hidden if |
JPanel newRight = new JPanel(new MigLayout("center, wrap 1","[grow]","[][grow]")); |
132 |
* {@code enabled} is {@code false} |
newRight.add(getToolBar()); |
133 |
*/ |
newRight.add(getGeoMapPane(),"growx, growy"); |
134 |
public void setToolEnabled(Integer tool, boolean enabled, boolean hideOnDisable) { |
getSplitPane().add(newRight); |
135 |
jToolBar.setButtonEnabled(tool,enabled,hideOnDisable); |
|
136 |
} |
this.add(getSplitPane(), BorderLayout.CENTER); |
137 |
|
|
138 |
/** |
} |
139 |
* Sets the activation for all tools. |
|
140 |
* Simply calls {@link MapPaneToolBar#setAllToolsEnabled(boolean, boolean)}. |
/** |
141 |
* @param enabled if {@code true} all tool becomes available |
* Returns the tool bar which controls the active mouse actions on the map. |
142 |
* @param hideOnDisable if {@code true} the buttons are also hidden if |
* |
143 |
* {@code enabled} is {@code false} |
* @return never <code>null</code>, will rather create a default |
144 |
*/ |
*/ |
145 |
public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) { |
public MapPaneToolBar getToolBar() { |
146 |
jToolBar.setAllToolsEnabled(enabled, hideOnDisable); |
if (jToolBar == null) { |
147 |
} |
jToolBar = new MapPaneToolBar(getMapPane()); |
148 |
|
} |
149 |
/** |
return jToolBar; |
150 |
* Checks whether a tool is activated. |
} |
151 |
* Simply calls {@link MapPaneToolBar#isButtonEnabled(Integer)}. |
|
152 |
* @param tool tool ID |
/** |
153 |
* @return {@code false} if an unknown ID is specified |
* Returns the split pane which divides the layer list from the map panel. |
154 |
*/ |
*/ |
155 |
public boolean isToolEnabled(Integer tool) { |
public JSplitPane getSplitPane() { |
156 |
return jToolBar.isButtonEnabled(tool); |
return splitPane; |
157 |
} |
} |
158 |
|
|
159 |
/** |
/** |
160 |
* called by initialize() to fill the left of the XULUMapView Supposed to be |
* Sets the active tool. Simply calls |
161 |
* overwritten by AtlasMapView or DesignMapView |
* {@link MapPaneToolBar#setSelectedTool(Integer)}. |
162 |
*/ |
* |
163 |
public JComponent getSidePane() { |
* @param tool |
164 |
return new MapContextControlPane(getGeoMapPane().getMapPane(), |
* One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants |
165 |
new ColorMapManager()); |
*/ |
166 |
} |
public void setSelectedTool(Integer tool) { |
167 |
|
jToolBar.setSelectedTool(tool); |
168 |
/** |
} |
169 |
* Liefert die Status-Zeile, in der die Koordinaten und Raster-Werte |
|
170 |
* angezeigt werden. |
/** |
171 |
*/ |
* Sets whether a tool is activated or not. Simply calls |
172 |
public MapPaneStatusBar getStatusBar() { |
* {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}. |
173 |
return this.statusBar; |
* |
174 |
} |
* @param tool |
175 |
|
* tool ID |
176 |
/** |
* @param enabled |
177 |
* Liefert den Karten-Bereich der Komponente. |
* if {@code true} the tool becomes available |
178 |
*/ |
* @param hideOnDisable |
179 |
public final JMapPane getMapPane() { |
* if {@code true} the button is also hidden if {@code enabled} |
180 |
return getGeoMapPane().getMapPane(); |
* is {@code false} |
181 |
} |
*/ |
182 |
|
public void setToolEnabled(Integer tool, boolean enabled, |
183 |
public GeoMapPane getGeoMapPane() { |
boolean hideOnDisable) { |
184 |
return geoMapPane; |
jToolBar.setButtonEnabled(tool, enabled, hideOnDisable); |
185 |
} |
} |
186 |
|
|
187 |
public int getSelectedTool() { |
/** |
188 |
return jToolBar.getSelectedTool(); |
* Sets the activation for all tools. Simply calls |
189 |
} |
* {@link MapPaneToolBar#setAllToolsEnabled(boolean, boolean)}. |
190 |
|
* |
191 |
} |
* @param enabled |
192 |
|
* if {@code true} all tool becomes available |
193 |
|
* @param hideOnDisable |
194 |
|
* if {@code true} the buttons are also hidden if {@code enabled} |
195 |
|
* is {@code false} |
196 |
|
*/ |
197 |
|
public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) { |
198 |
|
jToolBar.setAllToolsEnabled(enabled, hideOnDisable); |
199 |
|
} |
200 |
|
|
201 |
|
/** |
202 |
|
* Checks whether a tool is activated. Simply calls |
203 |
|
* {@link MapPaneToolBar#isButtonEnabled(Integer)}. |
204 |
|
* |
205 |
|
* @param tool |
206 |
|
* tool ID |
207 |
|
* @return {@code false} if an unknown ID is specified |
208 |
|
*/ |
209 |
|
public boolean isToolEnabled(Integer tool) { |
210 |
|
return jToolBar.isButtonEnabled(tool); |
211 |
|
} |
212 |
|
|
213 |
|
/** |
214 |
|
* called by initialize() to fill the left of the XULUMapView Supposed to be |
215 |
|
* overwritten by AtlasMapView or DesignMapView |
216 |
|
*/ |
217 |
|
public JComponent getSidePane() { |
218 |
|
return new MapContextControlPane(getGeoMapPane().getMapPane(), |
219 |
|
new ColorMapManager()); |
220 |
|
} |
221 |
|
|
222 |
|
/** |
223 |
|
* Liefert die Status-Zeile, in der die Koordinaten und Raster-Werte |
224 |
|
* angezeigt werden. |
225 |
|
*/ |
226 |
|
public MapPaneStatusBar getStatusBar() { |
227 |
|
return this.statusBar; |
228 |
|
} |
229 |
|
|
230 |
|
/** |
231 |
|
* Liefert den Karten-Bereich der Komponente. |
232 |
|
*/ |
233 |
|
public final SelectableXMapPane getMapPane() { |
234 |
|
return getGeoMapPane().getMapPane(); |
235 |
|
} |
236 |
|
|
237 |
|
public GeoMapPane getGeoMapPane() { |
238 |
|
return geoMapPane; |
239 |
|
} |
240 |
|
|
241 |
|
public int getSelectedTool() { |
242 |
|
return jToolBar.getSelectedTool(); |
243 |
|
} |
244 |
|
|
245 |
|
/** |
246 |
|
* Help the garbage collection |
247 |
|
*/ |
248 |
|
public void dispose() { |
249 |
|
if (geoMapPane != null) |
250 |
|
geoMapPane.dispose(); |
251 |
|
} |
252 |
|
|
253 |
|
} |