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. Krüger - 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 org.apache.log4j.Logger;

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

/**
 * Achtung! Dieser code ist verwuestet TODO DOKU und initialize schöner machen.
 * SK
 */
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 JMapPane}
         */
        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.
                getGeoMapPane().getMapPane().setWaitCursorComponent(parentGui);
                jToolBar = toolBar;
        }

        /**
         * 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 JMapPane}
         */
        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 BorderLayout());
                newRight.add(getToolBar(), BorderLayout.NORTH);
                newRight.add(getGeoMapPane(), BorderLayout.CENTER);
                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 JMapPane getMapPane() {
                return getGeoMapPane().getMapPane();
        }

        public GeoMapPane getGeoMapPane() {
                return geoMapPane;
        }

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

}
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. Krüger - 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 org.apache.log4j.Logger;
41
42	import schmitzm.geotools.gui.GeoMapPane;
43	import schmitzm.geotools.gui.JMapPane;
44	import schmitzm.geotools.gui.MapContextControlPane;
45	import schmitzm.geotools.gui.MapPaneStatusBar;
46	import schmitzm.geotools.styling.ColorMapManager;
47
48	/**
49	* Achtung! Dieser code ist verwuestet TODO DOKU und initialize schöner machen.
50	* SK
51	*/
52	public class MapView extends JPanel {
53	private static final Logger LOGGER = Logger.getLogger(MapView.class);
54
55	private final JSplitPane splitPane = new JSplitPane(
56	JSplitPane.HORIZONTAL_SPLIT);
57
58	protected MapPaneStatusBar statusBar = null;
59
60	/**
61	* Komponente, in der die Karten, der Massstab und das Koordinaten-Raster
62	* dargestellt werden.
63	*/
64
65	protected final GeoMapPane geoMapPane = new GeoMapPane();
66
67	private MapPaneToolBar jToolBar;
68
69	/**
70	* Creates a new {@link MapView}. A {@link MapView} is a combination of a
71	* {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and
72	* some buttons floating over the {@link JMapPane}
73	*/
74	public MapView(Component parentGui, MapPaneToolBar toolBar) {
75	super(new BorderLayout());
76	// Call initialize() by yourself afterwards.
77	// Needed because variables for the overwritten methods
78	// are not yet set.
79	getGeoMapPane().getMapPane().setWaitCursorComponent(parentGui);
80	jToolBar = toolBar;
81	}
82
83	/**
84	* Creates a new {@link MapView}. A {@link MapView} is a combination of a
85	* {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and
86	* some buttons floating over the {@link JMapPane}
87	*/
88	public MapView(Component parentGui) {
89	this(parentGui, null);
90	}
91
92	/**
93	* This routine creates the main components of the GUI: The left Side and
94	* the map on the right side.<br/>
95	* Calls #getSidePanel() which can be overwritten (call super!).<br/>
96	*
97	* This method initialized the variables {@link #statusBar} and
98	* {@link #splitPane}
99	*
100	* @see #adjustSizeOfGeoMapPane()
101	*/
102	public void initialize() {
103	// horizontales SplitPane initialisieren
104
105	// Status-Line to show Coordinates and Rastervalues.
106	statusBar = new MapPaneStatusBar(getGeoMapPane().getMapPane());
107	statusBar.setBorder(BorderFactory.createCompoundBorder(BorderFactory
108	.createLoweredBevelBorder(), BorderFactory.createEmptyBorder(2,
109	5, 2, 5)));
110	this.add(statusBar, BorderLayout.SOUTH);
111
112	/**
113	* The layout of the split pane can be configured in the atlas.
114	* setDividerLocation(-1); has no effect here because the component is
115	* not visible yet.
116	*/
117	getSplitPane().setDividerSize(5);
118
119	getSplitPane().setResizeWeight(0.0);
120	getSplitPane().add(getSidePane());
121
122	/***********************************************************************
123	* To the right side we now add a JPanel that consists of a toolbar and
124	* a gmp
125	*/
126	JPanel newRight = new JPanel(new BorderLayout());
127	newRight.add(getToolBar(), BorderLayout.NORTH);
128	newRight.add(getGeoMapPane(), BorderLayout.CENTER);
129	getSplitPane().add(newRight);
130
131	this.add(getSplitPane(), BorderLayout.CENTER);
132	}
133
134	/**
135	* Returns the tool bar which controls the active mouse actions on the map.
136	*
137	* @return never <code>null</code>, will rather create a default
138	*/
139	public MapPaneToolBar getToolBar() {
140	if (jToolBar == null) {
141	jToolBar = new MapPaneToolBar(getMapPane());
142	}
143	return jToolBar;
144	}
145
146	/**
147	* Returns the split pane which divides the layer list from the map panel.
148	*/
149	public JSplitPane getSplitPane() {
150	return splitPane;
151	}
152
153	/**
154	* Sets the active tool. Simply calls
155	* {@link MapPaneToolBar#setSelectedTool(Integer)}.
156	*
157	* @param tool
158	* One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants
159	*/
160	public void setSelectedTool(Integer tool) {
161	jToolBar.setSelectedTool(tool);
162	}
163
164	/**
165	* Sets whether a tool is activated or not. Simply calls
166	* {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}.
167	*
168	* @param tool
169	* tool ID
170	* @param enabled
171	* if {@code true} the tool becomes available
172	* @param hideOnDisable
173	* if {@code true} the button is also hidden if {@code enabled}
174	* is {@code false}
175	*/
176	public void setToolEnabled(Integer tool, boolean enabled,
177	boolean hideOnDisable) {
178	jToolBar.setButtonEnabled(tool, enabled, hideOnDisable);
179	}
180
181	/**
182	* Sets the activation for all tools. Simply calls
183	* {@link MapPaneToolBar#setAllToolsEnabled(boolean, boolean)}.
184	*
185	* @param enabled
186	* if {@code true} all tool becomes available
187	* @param hideOnDisable
188	* if {@code true} the buttons are also hidden if {@code enabled}
189	* is {@code false}
190	*/
191	public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) {
192	jToolBar.setAllToolsEnabled(enabled, hideOnDisable);
193	}
194
195	/**
196	* Checks whether a tool is activated. Simply calls
197	* {@link MapPaneToolBar#isButtonEnabled(Integer)}.
198	*
199	* @param tool
200	* tool ID
201	* @return {@code false} if an unknown ID is specified
202	*/
203	public boolean isToolEnabled(Integer tool) {
204	return jToolBar.isButtonEnabled(tool);
205	}
206
207	/**
208	* called by initialize() to fill the left of the XULUMapView Supposed to be
209	* overwritten by AtlasMapView or DesignMapView
210	*/
211	public JComponent getSidePane() {
212	return new MapContextControlPane(getGeoMapPane().getMapPane(),
213	new ColorMapManager());
214	}
215
216	/**
217	* Liefert die Status-Zeile, in der die Koordinaten und Raster-Werte
218	* angezeigt werden.
219	*/
220	public MapPaneStatusBar getStatusBar() {
221	return this.statusBar;
222	}
223
224	/**
225	* Liefert den Karten-Bereich der Komponente.
226	*/
227	public final JMapPane getMapPane() {
228	return getGeoMapPane().getMapPane();
229	}
230
231	public GeoMapPane getGeoMapPane() {
232	return geoMapPane;
233	}
234
235	public int getSelectedTool() {
236	return jToolBar.getSelectedTool();
237	}
238
239	}