001: //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/trunk/src/org/deegree/portal/context/GeneralExtension.java $
002: /*---------------- FILE HEADER ------------------------------------------
003:
004: This file is part of deegree.
005: Copyright (C) 2001-2008 by:
006: EXSE, Department of Geography, University of Bonn
007: http://www.giub.uni-bonn.de/deegree/
008: lat/lon GmbH
009: http://www.lat-lon.de
010:
011: This library is free software; you can redistribute it and/or
012: modify it under the terms of the GNU Lesser General Public
013: License as published by the Free Software Foundation; either
014: version 2.1 of the License, or (at your option) any later version.
015:
016: This library is distributed in the hope that it will be useful,
017: but WITHOUT ANY WARRANTY; without even the implied warranty of
018: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: Lesser General Public License for more details.
020:
021: You should have received a copy of the GNU Lesser General Public
022: License along with this library; if not, write to the Free Software
023: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024:
025: Contact:
026:
027: Andreas Poth
028: lat/lon GmbH
029: Aennchenstr. 19
030: 53115 Bonn
031: Germany
032: E-Mail: poth@lat-lon.de
033:
034: Prof. Dr. Klaus Greve
035: Department of Geography
036: University of Bonn
037: Meckenheimer Allee 166
038: 53115 Bonn
039: Germany
040: E-Mail: greve@giub.uni-bonn.de
041:
042:
043: ---------------------------------------------------------------------------*/
044: package org.deegree.portal.context;
045:
046: /**
047: * this class encapsulates the deegree specific extensions of the general section of a web map
048: * context document. this is a description of the GUI including the used modules (<tt>Frontend</tt>)
049: * and the parameters to control the map view (<tt>Marshallable</tt>).
050: *
051: * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
052: * @author last edited by: $Author: apoth $
053: *
054: * @version $Revision: 9346 $, $Date: 2007-12-27 08:39:07 -0800 (Thu, 27 Dec 2007) $
055: */
056: public class GeneralExtension {
057: private Frontend frontend = null;
058:
059: private MapParameter mapParameter = null;
060:
061: private IOSettings iOSettings = null;
062:
063: private AuthentificationSettings authSettings = null;
064:
065: private boolean transparent = true;
066:
067: private String bgColor = "0xFFFFFF";
068:
069: private String mode = null;
070:
071: private Node layerTreeRoot = null;
072:
073: /**
074: * Creates a new GeneralExtension object.
075: *
076: * @param frontend
077: * @param mapParameter
078: */
079: public GeneralExtension(IOSettings iOSettings, Frontend frontend,
080: MapParameter mapParameter,
081: AuthentificationSettings authSettings, String mode,
082: Node layerTreeRoot) {
083: setFrontend(frontend);
084: setMapParameter(mapParameter);
085: setIOSettings(iOSettings);
086: setAuthentificationSettings(authSettings);
087: setLayerTreeRoot(layerTreeRoot);
088: this .mode = mode;
089:
090: }
091:
092: /**
093: * returns true if the maps background should be transparent
094: *
095: * @return <code>true</code> if the maps background should be transparent
096: */
097: public boolean isTransparent() {
098: return transparent;
099: }
100:
101: /**
102: * @see #isTransparent()
103: * @param transparent
104: */
105: public void setTransparent(boolean transparent) {
106: this .transparent = transparent;
107: }
108:
109: /**
110: * returns the desired background color of the map
111: *
112: * @return the desired background color of the map
113: */
114: public String getBgColor() {
115: return bgColor;
116: }
117:
118: /**
119: * @see #getBgColor()
120: * @param bgColor
121: */
122: public void setBgColor(String bgColor) {
123: this .bgColor = bgColor;
124: }
125:
126: /**
127: * returns the frontend (GUI) description encapsulating objekt
128: *
129: * @return the frontend (GUI) description encapsulating objekt
130: */
131: public Frontend getFrontend() {
132: return frontend;
133: }
134:
135: /**
136: * sets the frontend (GUI) description encapsulating objekt
137: *
138: * @param frontend
139: * <tt>Frontend</tt>
140: */
141: public void setFrontend(Frontend frontend) {
142: this .frontend = frontend;
143: }
144:
145: /**
146: * returns the parameters describing the control options for the map
147: *
148: * @return <tt>MapParameter</tt> encapsulating several control params
149: */
150: public MapParameter getMapParameter() {
151: return mapParameter;
152: }
153:
154: /**
155: * sets the parameters describing the control options for the map
156: *
157: * @param mapParameter
158: * <tt>MapParameter</tt> encapsulating several control params
159: */
160: public void setMapParameter(MapParameter mapParameter) {
161: this .mapParameter = mapParameter;
162: }
163:
164: /**
165: * @return Returns the iOSettings.
166: */
167: public IOSettings getIOSettings() {
168: return iOSettings;
169: }
170:
171: /**
172: * @param settings
173: * The iOSettings to set.
174: */
175: public void setIOSettings(IOSettings settings) {
176: iOSettings = settings;
177: }
178:
179: public AuthentificationSettings getAuthentificationSettings() {
180: return authSettings;
181: }
182:
183: public void setAuthentificationSettings(
184: AuthentificationSettings authSettings) {
185: this .authSettings = authSettings;
186: }
187:
188: /**
189: * returns the current mode of a map client using a WMC. A mode defines the action that occurs
190: * if a user performs a mouse action on the map
191: *
192: * @return the current mode of a map client using a WMC. A mode defines the action that occurs
193: * if a user performs a mouse action on the map
194: */
195: public String getMode() {
196: return mode;
197: }
198:
199: /**
200: * @see #getMode()
201: * @param mode
202: */
203: public void setMode(String mode) {
204: this .mode = mode;
205: }
206:
207: public void setLayerTreeRoot(Node layerTreeRoot) {
208: this .layerTreeRoot = layerTreeRoot;
209: }
210:
211: public Node getLayerTreeRoot() {
212: return layerTreeRoot;
213: }
214:
215: }
|