/[schmitzm]/trunk/src/skrueger/geotools/MapView.java

Diff of /trunk/src/skrueger/geotools/MapView.java

Parent Directory | Revision Log | View Patch Patch

-revision 153 by alfonx,
Sat Jun 20 12:48:24 2009 UTC
+revision 1195 by alfonx,
Tue Nov  2 10:33:32 2010 UTC
 Line 1
- package skrueger.geotools;
+ /*******************************************************************************
+  * Copyright (c) 2009 Martin O. J. Schmitz.
- import java.awt.BorderLayout;
+  *
- import java.awt.Window;
+  * This file is part of the SCHMITZM library - a collection of utility
+  * classes based on Java 1.6, focusing (not only) on Java Swing
- import javax.swing.BorderFactory;
+  * and the Geotools library.
- import javax.swing.JComponent;
+  *
- import javax.swing.JPanel;
+  * The SCHMITZM project is hosted at:
- import javax.swing.JSplitPane;
+  * http://wald.intevation.org/projects/schmitzm/
+  *
- import org.apache.log4j.Logger;
+  * This program is free software; you can redistribute it and/or
+  * modify it under the terms of the GNU Lesser General Public License
- import schmitzm.geotools.gui.GeoMapPane;
+  * as published by the Free Software Foundation; either version 3
- import schmitzm.geotools.gui.JMapPane;
+  * of the License, or (at your option) any later version.
- import schmitzm.geotools.gui.MapContextControlPane;
+  *
- import schmitzm.geotools.gui.MapPaneStatusBar;
+  * This program is distributed in the hope that it will be useful,
- import schmitzm.geotools.styling.ColorMapManager;
+  * 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.
-  * Achtung! Dieser code ist verwuestet
+  *
-  * TODO DOKU und initialize schöner machen. SK
+  * 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
- public class MapView extends JPanel {
+  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-         private static final Logger LOGGER = Logger.getLogger(MapView.class);
+  * or try this link: http://www.gnu.org/licenses/lgpl.html
+  *
-         public final JSplitPane splitPane = new JSplitPane(
+  * Contributors:
-                         JSplitPane.HORIZONTAL_SPLIT);
+  *     Martin O. J. Schmitz - initial API and implementation
+  *     Stefan A. Tzeggai - additional utility classes
-         protected MapPaneStatusBar statusBar = null;
+  ******************************************************************************/
+ package skrueger.geotools;
-         /**
-          * Komponente, in der die Karten, der Massstab und das Koordinaten-Raster
+ import java.awt.BorderLayout;
-          * dargestellt werden
+ import java.awt.Component;
-          */
-         protected final GeoMapPane geoMapPane = new GeoMapPane();
+ import javax.swing.BorderFactory;
+ import javax.swing.JComponent;
-         private MapPaneToolBar jToolBar;
+ import javax.swing.JPanel;
+ import javax.swing.JSplitPane;
-         /**
-          * Creates a new {@link MapView}. A {@link MapView} is a combination of a
+ import net.miginfocom.swing.MigLayout;
-          * {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left,
-          * and some buttons floating over the {@link JMapPane}
+ import org.apache.log4j.Logger;
-          */
-         public MapView(Window parentGui, MapPaneToolBar toolBar) {
+ import schmitzm.geotools.gui.GeoMapPane;
-                 super(new BorderLayout());
+ import schmitzm.geotools.gui.MapContextControlPane;
-                 // Call initialize() by yourself afterwards.
+ import schmitzm.geotools.gui.MapPaneStatusBar;
-                 // Needed because variables for the overwritten methods
+ import schmitzm.geotools.gui.SelectableXMapPane;
-                 // are not yet set.
+ import schmitzm.geotools.styling.ColorMapManager;
-                 getGeoMapPane().getMapPane().setWaitCursorComponent(parentGui);
-                 if ( toolBar == null )
+ /**
-                   toolBar = new MapPaneToolBar(getMapPane());
+  * Achtung! Dieser code ist verwuestet TODO DOKU und initialize schöner machen.
-                 jToolBar = toolBar;
+  * SK
-         }
+  */
+ public class MapView extends JPanel {
-     /**
+         private static final Logger LOGGER = Logger.getLogger(MapView.class);
-      * Creates a new {@link MapView}. A {@link MapView} is a combination of a
-      * {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left,
+         private final JSplitPane splitPane = new JSplitPane(
-      * and some buttons floating over the {@link JMapPane}
+                         JSplitPane.HORIZONTAL_SPLIT);
-      */
-     public MapView(Window parentGui) {
+         protected MapPaneStatusBar statusBar = null;
-       this(parentGui, null);
+         /**
-     }
+          * Komponente, in der die Karten, der Massstab und das Koordinaten-Raster
+          * dargestellt werden.
-         /**
+          */
-          * Calls #getSidePanel() which can be overwritten.
+         protected final GeoMapPane geoMapPane = new GeoMapPane();
-          *
-          * @see #adjustSizeOfGeoMapPane()
+         private MapPaneToolBar jToolBar;
-          */
-         public void initialize() {
+         /**
-                 // horizontales SplitPane initialisieren
+          * Creates a new {@link MapView}. A {@link MapView} is a combination of a
- // SK 19.6.09: Removed because we are not using it. Probably a test.
+          * {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and
- //              // Status-Zeile
+          * some buttons floating over the {@link SelectableXMapPane}
- //              statusBar = new MapPaneStatusBar(getGeoMapPane()
+          */
- //                              .getMapPane());
+         public MapView(Component parentGui, MapPaneToolBar toolBar) {
- //              statusBar.setBorder(BorderFactory.createCompoundBorder(BorderFactory
+                 super(new BorderLayout());
- //                              .createLoweredBevelBorder(), BorderFactory.createEmptyBorder(2,
+                 // Call initialize() by yourself afterwards.
- //                              5, 2, 5)));
+                 // Needed because variables for the overwritten methods
- //              this.add(statusBar, BorderLayout.SOUTH);
+                 // are not yet set.
+                 jToolBar = toolBar;
-                 splitPane.setDividerLocation(-1);
-                 splitPane.setDividerSize(5);
+                 // By default the MapPane will render with antialiasing on
+                 getGeoMapPane().getMapPane().setAntiAliasing(true);
-                 splitPane.setResizeWeight(0.0);
+         }
-                 splitPane.add(getSidePane());
+         /**
-                 /***********************************************************************
+          * Creates a new {@link MapView}. A {@link MapView} is a combination of a
-                  * To the right side we now add a JPanel that consists of a toolbar and
+          * {@link GeoMapPane}, a {@link MapContextManagerInterface} on the left, and
-                  * a gmp
+          * some buttons floating over the {@link SelectableXMapPane}
-                  */
+          */
-                 JPanel newRight = new JPanel(new BorderLayout());
+         public MapView(Component parentGui) {
-                 newRight.add(getToolBar(), BorderLayout.NORTH);
+                 this(parentGui, null);
-                 newRight.add(getGeoMapPane(), BorderLayout.CENTER);
+         }
-                 splitPane.add(newRight);
+         /**
-                 this.add(splitPane, BorderLayout.CENTER);
+          * 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/>
-         /**
+          *
-          * Returns the tool bar which controls the active mouse actions on the map.
+          * This method initialized the variables {@link #statusBar} and
-          * @return
+          * {@link #splitPane}
-          */
+          *
-         public MapPaneToolBar getToolBar() {
+          * @see #adjustSizeOfGeoMapPane()
-           return jToolBar;
+          */
-         }
+         public void initialize() {
+                 // horizontales SplitPane initialisieren
-         /**
-          * Returns the split pane which divides the layer list from the map panel.
+                 // Status-Line to show Coordinates and Rastervalues.
-          */
+                 statusBar = new MapPaneStatusBar(getGeoMapPane().getMapPane());
-         public JSplitPane getSplitPane() {
+                 statusBar.setBorder(BorderFactory.createCompoundBorder(
-                 return this.splitPane;
+                                 BorderFactory.createLoweredBevelBorder(),
-         }
+                                 BorderFactory.createEmptyBorder(2, 5, 2, 5)));
+                 this.add(statusBar, BorderLayout.SOUTH);
-         /**
+                 /**
-          * Sets the active tool.
+                  * The layout of the split pane can be configured in the atlas.
-          * Simply calls {@link MapPaneToolBar#setSelectedTool(Integer)}.
+                  * setDividerLocation(-1); has no effect here because the component is
-          * @param tool
+                  * not visible yet.
-          *            One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants
+                  */
-          */
+                 getSplitPane().setDividerSize(5);
-         public void setSelectedTool(Integer tool) {
-           jToolBar.setSelectedTool(tool);
+                 getSplitPane().setResizeWeight(0.0);
-         }
+                 getSplitPane().add(getSidePane());
-     /**
+                 /***********************************************************************
-      * Sets whether a tool is activated or not.
+                  * To the right side we now add a JPanel that consists of a toolbar and
-      * Simply calls {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}.
+                  * a gmp
-      * @param tool tool ID
+                  */
-      * @param enabled if {@code true} the tool becomes available
+                 JPanel newRight = new JPanel(new MigLayout("center, wrap 1", "[grow]",
-      * @param hideOnDisable if {@code true} the button is also hidden if
+                                 "[][grow]"));
-      *                      {@code enabled} is {@code false}
+                 newRight.add(getToolBar());
-      */
+                 newRight.add(getGeoMapPane(), "growx, growy");
-         public void setToolEnabled(Integer tool, boolean enabled, boolean hideOnDisable) {
+                 getSplitPane().add(newRight);
-            jToolBar.setButtonEnabled(tool,enabled,hideOnDisable);
-         }
+                 this.add(getSplitPane(), BorderLayout.CENTER);
-     /**
+         }
-      * Sets the activation for all tools.
-      * Simply calls {@link MapPaneToolBar#setAllToolsEnabled(boolean, boolean)}.
+         /**
-      * @param enabled if {@code true} all tool becomes available
+          * Returns the tool bar which controls the active mouse actions on the map.
-      * @param hideOnDisable if {@code true} the buttons are also hidden if
+          *
-      *                      {@code enabled} is {@code false}
+          * @return never <code>null</code>, will rather create a default
-      */
+          */
-     public void setAllToolsEnabled(boolean enabled, boolean hideOnDisable) {
+         public MapPaneToolBar getToolBar() {
-       jToolBar.setAllToolsEnabled(enabled, hideOnDisable);
+                 if (jToolBar == null) {
-     }
+                         jToolBar = new MapPaneToolBar(getMapPane());
+                 }
-     /**
+                 return jToolBar;
-          * 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
+          * Returns the split pane which divides the layer list from the map panel.
           */
-         public boolean isToolEnabled(Integer tool) {
+         public JSplitPane getSplitPane() {
-           return jToolBar.isButtonEnabled(tool);
+                 return splitPane;
          }
          /**
-          * called by initialize() to fill the left of the XULUMapView Supposed to be
+          * Sets the active tool. Simply calls
-          * overwritten by AtlasMapView or DesignMapView
+          * {@link MapPaneToolBar#setSelectedTool(Integer)}.
-          */
+          *
-         public JComponent getSidePane() {
+          * @param tool
-                 return new MapContextControlPane(getGeoMapPane().getMapPane(),
+          *            One of {@link #TOOL_INFO}, {@link #TOOL_PAN} .. constants
-                                 new ColorMapManager());
+          */
-         }
+         public void setSelectedTool(Integer tool) {
+                 jToolBar.setSelectedTool(tool);
-         /**
+         }
-          * Liefert die Status-Zeile, in der die Koordinaten und Raster-Werte
-          * angezeigt werden.
+         /**
-          */
+          * Sets whether a tool is activated or not. Simply calls
-         public MapPaneStatusBar getStatusBar() {
+          * {@link MapPaneToolBar#setButtonEnabled(int, boolean, boolean)}.
-           return this.statusBar;
+          *
-         }
+          * @param tool
+          *            tool ID
-         /**
+          * @param enabled
-          * Liefert den Karten-Bereich der Komponente.
+          *            if {@code true} the tool becomes available
-          */
+          * @param hideOnDisable
-         public final JMapPane getMapPane() {
+          *            if {@code true} the button is also hidden if {@code enabled}
-                 return getGeoMapPane().getMapPane();
+          *            is {@code false}
-         }
+          */
+         public void setToolEnabled(Integer tool, boolean enabled,
-         public GeoMapPane getGeoMapPane() {
+                         boolean hideOnDisable) {
-                 return geoMapPane;
+                 jToolBar.setButtonEnabled(tool, enabled, hideOnDisable);
          }
-         public int getSelectedTool() {
+         /**
-                 return jToolBar.getSelectedTool();
+          * 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();
+         }
+ }

 Legend:



Removed from v.153
 


changed lines


 
Added in v.1195
 Legend:



Removed from v.153
 


changed lines


 
Added in v.1195
-Removed from v.153
+Added in v.1195

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26