001: //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/trunk/src/org/deegree/portal/context/GUIArea.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: import java.util.ArrayList;
047: import java.util.HashMap;
048: import java.util.List;
049:
050: /**
051: * this interface describes the content of an area of a GUI. a GUI area contains zero ... n modules
052: * described by the <tt>Module</tt> interface. A GUI area may be can be switched to be invisible.
053: * indicated by the hidden attribute.
054: *
055: * @version $Revision: 9346 $
056: * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
057: */
058: public class GUIArea {
059:
060: public static final int WEST = 0;
061:
062: public static final int EAST = 1;
063:
064: public static final int SOUTH = 2;
065:
066: public static final int NORTH = 3;
067:
068: public static final int CENTER = 4;
069:
070: private HashMap<String, Module> modules = new HashMap<String, Module>();
071:
072: private boolean hidden = false;
073:
074: private int area = 0;
075:
076: private List<Module> list = new ArrayList<Module>();
077:
078: /**
079: * Creates a new GUIArea_Impl object.
080: *
081: * @param area
082: * @param hidden
083: * @param modules
084: */
085: public GUIArea(int area, boolean hidden, Module[] modules) {
086: setArea(area);
087: setHidden(hidden);
088: setModules(modules);
089: }
090:
091: /**
092: * returns area (north, west, east ...) assigned to an instance
093: *
094: * @return area
095: */
096: public int getArea() {
097: return area;
098: }
099:
100: /**
101: * sets the name of a module
102: *
103: * @param area
104: */
105: public void setArea(int area) {
106: this .area = area;
107: }
108:
109: /**
110: * returns true if the GUIArea is hidden.
111: *
112: * @return true if area is hidden
113: */
114: public boolean isHidden() {
115: return hidden;
116: }
117:
118: /**
119: * sets the GUIArea to be hidden or visible.
120: *
121: * @param hidden
122: */
123: public void setHidden(boolean hidden) {
124: this .hidden = hidden;
125: }
126:
127: /**
128: * returns a module identified by its name
129: *
130: * @param name
131: *
132: * @return named module
133: */
134: public Module getModule(String name) {
135: return modules.get(name);
136: }
137:
138: /**
139: * returns all modules of a GUIArea
140: *
141: * @return all modules
142: */
143: public Module[] getModules() {
144: Module[] cl = new Module[list.size()];
145: return list.toArray(cl);
146:
147: }
148:
149: /**
150: * sets the modules of a GUIArea
151: *
152: * @param modules
153: */
154: public void setModules(Module[] modules) {
155: this .modules.clear();
156: this .list.clear();
157:
158: if (modules != null) {
159: for (int i = 0; i < modules.length; i++) {
160: this .modules.put(modules[i].getName(), modules[i]);
161: list.add(modules[i]);
162: }
163: }
164: }
165:
166: /**
167: * adds a module to a GUIArea
168: *
169: * @param module
170: */
171: public void addModul(Module module) {
172: modules.put(module.getName(), module);
173: list.add(module);
174: }
175:
176: /**
177: * reomes a module identified by its name from the GUIArea
178: *
179: * @param name
180: *
181: * @return removed module
182: */
183: public Module removeModule(String name) {
184: Module module = modules.remove(name);
185: list.remove(module);
186: return module;
187: }
188:
189: }
|