001: // @@
002: // @@
003: /*
004: * Wi.Ser Framework
005: *
006: * Version: 1.8.1, 20-September-2007
007: * Copyright (C) 2005 Dirk von der Weiden <dvdw@imail.de>
008: *
009: * This library is free software; you can redistribute it and/or
010: * modify it under the terms of the GNU Lesser General Public
011: * License as published by the Free Software Foundation; either
012: * version 2 of the License, or (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: * Lesser General Public License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library located in LGPL.txt in the
021: * license directory; if not, write to the
022: * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
023: * Boston, MA 02111-1307, USA.
024: *
025: * If this agreement does not cover your requirements, please contact us
026: * via email to get detailed information about the commercial license
027: * or our service offerings!
028: *
029: */
030: // @@
031: package de.ug2t.unifiedGui.interfaces;
032:
033: import de.ug2t.unifiedGui.*;
034:
035: /**
036: * @author Dirk
037: *
038: * date: 25.01.2004 project: WiSer-Framework
039: *
040: * <p>
041: * IUnContainer is the common interface to all container classes of JmcFrame.
042: * </p>
043: */
044: public interface IUnContainer {
045: /**
046: * <p>
047: * Adds a widget to the container.
048: * </p>
049: * <p>
050: *
051: * </p>
052: * <p>
053: *
054: * @param xName
055: * name of the widget within this container
056: * @param xObj
057: * widget
058: * </p>
059: */
060: public void pcmf_addWidget(String xName, UnComponent xObj);
061:
062: /**
063: * <p>
064: * Adds a widget to the container.
065: * </p>
066: * <p>
067: *
068: * </p>
069: * <p>
070: *
071: * @param xName
072: * name of the widget within this container
073: * @param xObj
074: * widget
075: * </p>
076: */
077: public void pcmf_addWidget(String xName, IUnComponent xObj);
078:
079: /**
080: * <p>
081: * Removes a widget from the container.
082: * </p>
083: * <p>
084: *
085: * @return the removed widget or null if there was no widget of this name in
086: * the container
087: * </p>
088: * <p>
089: * @param xName
090: * name of the widget which will be removed from the container
091: * </p>
092: */
093: public UnComponent pcmf_removeWidget(String xName);
094:
095: /**
096: * <p>
097: * Removes a widget from the container.
098: * </p>
099: * <p>
100: *
101: * @return the removed widget or null if the widget was not inserted in the
102: * container
103: * </p>
104: * <p>
105: * @param xObj
106: * widget which will be removed from the container
107: * </p>
108: */
109: public UnComponent pcmf_removeWidget(UnComponent xObj);
110:
111: /**
112: * <p>
113: * Removes a widget from the container.
114: * </p>
115: * <p>
116: *
117: * @return the removed widget or null if the widget was not inserted in the
118: * container
119: * </p>
120: * <p>
121: * @param xObj
122: * widget which will be removed from the container
123: * </p>
124: */
125: public IUnComponent pcmf_removeWidget(IUnComponent xObj);
126:
127: /**
128: * <p>
129: * Gets a widget from the container.
130: * </p>
131: * <p>
132: *
133: * @return widget
134: * </p>
135: * <p>
136: * @param xName
137: * name of the widget to get within the container
138: * </p>
139: */
140: public UnComponent pcmf_getWidget(String xName);
141:
142: /**
143: * <p>
144: * Gets a widget from the container.
145: * </p>
146: * <p>
147: *
148: * @return widget
149: * </p>
150: * <p>
151: * @param xName
152: * name of the widget to get within the container
153: * </p>
154: */
155: public IUnComponent pcmf_getWidgetbyName(String xName);
156:
157: /**
158: * <p>
159: * Tests if a widget is inserted in the container.
160: * </p>
161: * <p>
162: *
163: * @return true if the widget was found, otherwise false
164: * </p>
165: * <p>
166: * @param xObj
167: * widget to test
168: * </p>
169: */
170: public boolean pcmf_contains(UnComponent xObj);
171:
172: /**
173: * <p>
174: * Tests if a widget is inserted in the container.
175: * </p>
176: * <p>
177: *
178: * @return true if the widget was found, otherwise false
179: * </p>
180: * <p>
181: * @param xObj
182: * widget to test
183: * </p>
184: */
185: public boolean pcmf_contains(IUnComponent xObj);
186: }
|