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 java.util.*;
034:
035: import de.ug2t.kernel.*;
036: import de.ug2t.unifiedGui.*;
037:
038: /**
039: * @author Dirk
040: *
041: * date: 20.02.2005
042: *
043: * <p>
044: * Purpose:
045: * </p>
046: */
047: public interface IUnListComponent {
048: /**
049: * <p>
050: * Gets the associated gui-object which implements all common methods
051: * </p>
052: * <p>
053: *
054: * @return gui-object
055: * </p>
056: * <p>
057: * </p>
058: */
059: public UnComponent pcmf_getUnComponent();
060:
061: /**
062: * <p>
063: * Adds a value to the list which is shown by the comboBox.
064: * </p>
065: * <p>
066: *
067: * </p>
068: * <p>
069: *
070: * @param xValue
071: * represents the value wich is assigned to the comboBox-object when
072: * the correspondent display-string was selected
073: * @param xString
074: * represents the value which is displayed in the selection list.
075: * xString can also be a repository-reference to display an other
076: * (gui-)object within the list
077: * </p>
078: */
079: public void pcmf_addValue(String xValue, String xString);
080:
081: /**
082: * <p>
083: * Adds a value to the list which is shown by the comboBox.
084: * </p>
085: * <p>
086: *
087: * </p>
088: * <p>
089: *
090: * @param xValue
091: * represents the value which is assigned to the comboBox-object when
092: * the correspondent display-string was selected
093: * @param xObj
094: * can be every registrable object, including other widgets.
095: * </p>
096: */
097: public void pcmf_addValueObj(String xValue, KeRegisteredObject xObj);
098:
099: /**
100: * <p>
101: * Removes a value from the selection list of the comboBox
102: * </p>
103: * <p>
104: *
105: * </p>
106: * <p>
107: *
108: * @param xValue
109: * value to remove, include repository-references
110: * </p>
111: */
112: public void pcmf_removeValue(String xValue);
113:
114: /**
115: * <p>
116: * Gets all list-items collected in a HashMap. The list-values are stored
117: * within the map's key values while the screen-items are stored within the
118: * map's values
119: * </p>
120: * <p>
121: *
122: * @return HashMap with value-pairs
123: * </p>
124: * <p>
125: * </p>
126: */
127: public HashMap pcmf_getValues();
128:
129: /**
130: * <p>
131: * Clears the widget
132: * </p>
133: * <p>
134: *
135: * </p>
136: * <p>
137: * </p>
138: */
139:
140: public void pcmf_clearListWidget();
141:
142: /**
143: * <p>
144: * Clears the widget and releases all elements
145: * </p>
146: * <p>
147: *
148: * </p>
149: * <p>
150: * </p>
151: */
152: public void pcmf_clearAndReleaseListWidget();
153:
154: /**
155: * <p>
156: * Begins a transaction (may not be implemented)
157: * </p>
158: * <p>
159: *
160: * </p>
161: * <p>
162: * </p>
163: */
164: public void pcmf_beginTr();
165:
166: /**
167: * <p>
168: * Commits a transaction (may not be implemented)
169: * </p>
170: * <p>
171: *
172: * </p>
173: * <p>
174: * </p>
175: */
176: public void pcmf_commitTr();
177: }
|