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());
                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	alfonx	244	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5	alfonx	256	* classes based on Java 1.6, focusing (not only) on Java Swing
6	alfonx	244	* 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	alfonx	862	* Stefan A. Tzeggai - additional utility classes
29	alfonx	244	******************************************************************************/
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	alfonx	417	import net.miginfocom.swing.MigLayout;
41
42	alfonx	244	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	alfonx	509	import schmitzm.geotools.gui.SelectableXMapPane;
48	alfonx	244	import schmitzm.geotools.styling.ColorMapManager;
49
50			/**
51	alfonx	1220	* TODO Dokument
52	alfonx	244	*/
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	alfonx	509	* some buttons floating over the {@link SelectableXMapPane}
72	alfonx	244	*/
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	alfonx	1195
80	alfonx	1065	// By default the MapPane will render with antialiasing on
81	alfonx	1195	getGeoMapPane().getMapPane().setAntiAliasing(true);
82	alfonx	244	}
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	alfonx	509	* some buttons floating over the {@link SelectableXMapPane}
88	alfonx	244	*/
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	alfonx	1195	statusBar.setBorder(BorderFactory.createCompoundBorder(
109			BorderFactory.createLoweredBevelBorder(),
110			BorderFactory.createEmptyBorder(2, 5, 2, 5)));
111	alfonx	244	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	alfonx	1195	JPanel newRight = new JPanel(new MigLayout("center, wrap 1", "[grow]",
128			"[][grow]"));
129	alfonx	417	newRight.add(getToolBar());
130	alfonx	1195	newRight.add(getGeoMapPane(), "growx, growy");
131	alfonx	244	getSplitPane().add(newRight);
132
133			this.add(getSplitPane(), BorderLayout.CENTER);
134	alfonx	1195
135	alfonx	244	}
136
137			/**
138			* Returns the tool bar which controls the active mouse actions on the map.
139			*
140	alfonx	414	* @return never <code>null</code>, will rather create a default
141	alfonx	244	*/
142			public MapPaneToolBar getToolBar() {
143	alfonx	414	if (jToolBar == null) {
144			jToolBar = new MapPaneToolBar(getMapPane());
145			}
146	alfonx	244	return jToolBar;
147			}
148
149			/**
150			* Returns the split pane which divides the layer list from the map panel.
151			*/
152			public JSplitPane getSplitPane() {
153			return splitPane;
154			}
155
156			/**
157			* Sets the active tool. Simply calls
158			* {@link MapPaneToolBar#setSelectedTool(Integer)}.
159			*
160			* @param tool
161			* One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants
162			*/
163			public void setSelectedTool(Integer tool) {
164			jToolBar.setSelectedTool(tool);
165			}
166
167			/**
168			* Sets whether a tool is activated or not. Simply calls
169			* {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}.
170			*
171			* @param tool
172			* tool ID
173			* @param enabled
174			* if {@code true} the tool becomes available
175			* @param hideOnDisable
176			* if {@code true} the button is also hidden if {@code enabled}
177			* is {@code false}
178			*/
179			public void setToolEnabled(Integer tool, boolean enabled,
180			boolean hideOnDisable) {
181			jToolBar.setButtonEnabled(tool, enabled, hideOnDisable);
182			}
183
184			/**
185			* Sets the activation for all tools. Simply calls
186			* {@link MapPaneToolBar#setAllToolsEnabled(boolean, boolean)}.
187			*
188			* @param enabled
189			* if {@code true} all tool becomes available
190			* @param hideOnDisable
191			* if {@code true} the buttons are also hidden if {@code enabled}
192			* is {@code false}
193			*/
194			public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) {
195			jToolBar.setAllToolsEnabled(enabled, hideOnDisable);
196			}
197
198			/**
199			* Checks whether a tool is activated. Simply calls
200			* {@link MapPaneToolBar#isButtonEnabled(Integer)}.
201			*
202			* @param tool
203			* tool ID
204			* @return {@code false} if an unknown ID is specified
205			*/
206			public boolean isToolEnabled(Integer tool) {
207			return jToolBar.isButtonEnabled(tool);
208			}
209
210			/**
211			* called by initialize() to fill the left of the XULUMapView Supposed to be
212			* overwritten by AtlasMapView or DesignMapView
213			*/
214			public JComponent getSidePane() {
215			return new MapContextControlPane(getGeoMapPane().getMapPane(),
216			new ColorMapManager());
217			}
218
219			/**
220			* Liefert die Status-Zeile, in der die Koordinaten und Raster-Werte
221			* angezeigt werden.
222			*/
223			public MapPaneStatusBar getStatusBar() {
224			return this.statusBar;
225			}
226
227			/**
228			* Liefert den Karten-Bereich der Komponente.
229			*/
230	alfonx	509	public final SelectableXMapPane getMapPane() {
231	alfonx	244	return getGeoMapPane().getMapPane();
232			}
233
234			public GeoMapPane getGeoMapPane() {
235			return geoMapPane;
236			}
237
238			public int getSelectedTool() {
239			return jToolBar.getSelectedTool();
240			}
241
242	alfonx	520	/**
243			* Help the garbage collection
244			*/
245			public void dispose() {
246			if (geoMapPane != null)
247			geoMapPane.dispose();
248			}
249
250	alfonx	244	}