skrueger/geotools/MapView.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Tzeggai - additional utility classes
 ******************************************************************************/
package skrueger.geotools;

import java.awt.BorderLayout;
import java.awt.Component;

import javax.swing.BorderFactory;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JSplitPane;

import net.miginfocom.swing.MigLayout;

import org.apache.log4j.Logger;

import schmitzm.geotools.gui.GeoMapPane;
import schmitzm.geotools.gui.MapContextControlPane;
import schmitzm.geotools.gui.MapPaneStatusBar;
import schmitzm.geotools.gui.SelectableXMapPane;
import schmitzm.geotools.styling.ColorMapManager;

/**
 * TODO Dokument
 */
public class MapView extends JPanel {
        private static final Logger LOGGER = Logger.getLogger(MapView.class);

        private final JSplitPane splitPane = new JSplitPane(
                        JSplitPane.HORIZONTAL_SPLIT);

        protected MapPaneStatusBar statusBar = null;
        /**
         * Komponente, in der die Karten, der Massstab und das Koordinaten-Raster
         * dargestellt werden.
         */
        protected final GeoMapPane geoMapPane = new GeoMapPane();

        private MapPaneToolBar jToolBar;

        /**
         * Creates a new {@link MapView}. A {@link MapView} is a combination of a
         * {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and
         * some buttons floating over the {@link SelectableXMapPane}
         */
        public MapView(Component parentGui, MapPaneToolBar toolBar) {
                super(new BorderLayout());
                // Call initialize() by yourself afterwards.
                // Needed because variables for the overwritten methods
                // are not yet set.
                jToolBar = toolBar;

                // By default the MapPane will render with antialiasing on
                getGeoMapPane().getMapPane().setAntiAliasing(true);
        }

        /**
         * Creates a new {@link MapView}. A {@link MapView} is a combination of a
         * {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and
         * some buttons floating over the {@link SelectableXMapPane}
         */
        public MapView(Component parentGui) {
                this(parentGui, null);
        }

        /**
         * This routine creates the main components of the GUI: The left Side and
         * the map on the right side.<br/>
         * Calls #getSidePanel() which can be overwritten (call super!).<br/>
         * 
         * This method initialized the variables {@link #statusBar} and
         * {@link #splitPane}
         * 
         * @see #adjustSizeOfGeoMapPane()
         */
        public void initialize() {
                // horizontales SplitPane initialisieren

                // Status-Line to show Coordinates and Rastervalues.
                statusBar = new MapPaneStatusBar(getGeoMapPane().getMapPane());
                statusBar.setBorder(BorderFactory.createCompoundBorder(
                                BorderFactory.createLoweredBevelBorder(),
                                BorderFactory.createEmptyBorder(2, 5, 2, 5)));
                this.add(statusBar, BorderLayout.SOUTH);

                /**
                 * The layout of the split pane can be configured in the atlas.
                 * setDividerLocation(-1); has no effect here because the component is
                 * not visible yet.
                 */
                getSplitPane().setDividerSize(5);

                getSplitPane().setResizeWeight(0.0);
                getSplitPane().add(getSidePane());

                /***********************************************************************
                 * To the right side we now add a JPanel that consists of a toolbar and
                 * a gmp
                 */
                JPanel newRight = new JPanel(new MigLayout("center, wrap 1", "[grow]",
                                "[][grow]"));
                newRight.add(getToolBar());
//              / crsName
//              newRight.add(new CrsLabel(getGeoMapPane().getMapPane()), "align right");
                newRight.add(getGeoMapPane(), "growx, growy");
                getSplitPane().add(newRight);

                this.add(getSplitPane(), BorderLayout.CENTER);

        }

        /**
         * Returns the tool bar which controls the active mouse actions on the map.
         * 
         * @return never <code>null</code>, will rather create a default
         */
        public MapPaneToolBar getToolBar() {
                if (jToolBar == null) {
                        jToolBar = new MapPaneToolBar(getMapPane());
                }
                return jToolBar;
        }

        /**
         * Returns the split pane which divides the layer list from the map panel.
         */
        public JSplitPane getSplitPane() {
                return splitPane;
        }

        /**
         * Sets the active tool. Simply calls
         * {@link MapPaneToolBar#setSelectedTool(Integer)}.
         * 
         * @param tool
         *            One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants
         */
        public void setSelectedTool(Integer tool) {
                jToolBar.setSelectedTool(tool);
        }

        /**
         * Sets whether a tool is activated or not. Simply calls
         * {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}.
         * 
         * @param tool
         *            tool ID
         * @param enabled
         *            if {@code true} the tool becomes available
         * @param hideOnDisable
         *            if {@code true} the button is also hidden if {@code enabled}
         *            is {@code false}
         */
        public void setToolEnabled(Integer tool, boolean enabled,
                        boolean hideOnDisable) {
                jToolBar.setButtonEnabled(tool, enabled, hideOnDisable);
        }

        /**
         * Sets the activation for all tools. Simply calls
         * {@link MapPaneToolBar#setAllToolsEnabled(boolean, boolean)}.
         * 
         * @param enabled
         *            if {@code true} all tool becomes available
         * @param hideOnDisable
         *            if {@code true} the buttons are also hidden if {@code enabled}
         *            is {@code false}
         */
        public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) {
                jToolBar.setAllToolsEnabled(enabled, hideOnDisable);
        }

        /**
         * Checks whether a tool is activated. Simply calls
         * {@link MapPaneToolBar#isButtonEnabled(Integer)}.
         * 
         * @param tool
         *            tool ID
         * @return {@code false} if an unknown ID is specified
         */
        public boolean isToolEnabled(Integer tool) {
                return jToolBar.isButtonEnabled(tool);
        }

        /**
         * called by initialize() to fill the left of the XULUMapView Supposed to be
         * overwritten by AtlasMapView or DesignMapView
         */
        public JComponent getSidePane() {
                return new MapContextControlPane(getGeoMapPane().getMapPane(),
                                new ColorMapManager());
        }

        /**
         * Liefert die Status-Zeile, in der die Koordinaten und Raster-Werte
         * angezeigt werden.
         */
        public MapPaneStatusBar getStatusBar() {
                return this.statusBar;
        }

        /**
         * Liefert den Karten-Bereich der Komponente.
         */
        public final SelectableXMapPane getMapPane() {
                return getGeoMapPane().getMapPane();
        }

        public GeoMapPane getGeoMapPane() {
                return geoMapPane;
        }

        public int getSelectedTool() {
                return jToolBar.getSelectedTool();
        }

        /**
         * Help the garbage collection
         */
        public void dispose() {
                if (geoMapPane != null)
                        geoMapPane.dispose();
        }

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