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.kernel.*;
034:
035: /**
036: * @author Dirk
037: *
038: * date: 26.11.2003 project: WiSer-Framework
039: *
040: * <p>
041: * This is the common interface to comboBox widgets. This widgets makes a
042: * difference between the values which are displayed in the selection list and
043: * the corresponding value which is assign to the widget-value in case of
044: * selection.
045: * </p>
046: */
047: public interface IUnComboBox extends IUnInputComponent, IUnComponent,
048: IUnListSelectComponent, IUnListComponent {
049: /**
050: * @author Dirk
051: *
052: * date: 29.05.2007 project: WiSer-Framework
053: *
054: * <p>
055: * Factory is a convenience class to create components of the surrounding interface's type without
056: * taking care for the WidgetServer MultiChannel API. It's use is similar to a
057: * constructor.
058: * </p>
059: */
060: public static class Factory {
061: /**
062: * Creates a standard version of this component as described in the factory.
063: * If you create masses of components for e.g. within a renderer use
064: * <i> create(IUnApplication xAppl)</i> for performance
065: * reasons.
066: *
067: * @return new component
068: */
069: public static IUnComboBox create() {
070: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
071: .pcmf_getObjByName(IUnApplication.MY_APPL);
072: return (l_appl.pcmf_getComponentFactory()
073: .pcmf_createComboBox(l_appl.pcmf_getApplType(), "",
074: "", "", l_appl));
075: }
076:
077: /**
078: * Creates a special version of this component as described in the factory
079: * configuration under the descriptor xFactoryDesc. If you create masses of
080: * components for e.g. within a renderer use <i>
081: * create(IUnApplication xAppl, String xFactoryDesc)</i> for performance
082: * reasons.
083: *
084: * @param xFactoryDesc
085: * descriptor
086: * @return new component
087: */
088: public static IUnComboBox create(String xFactoryDesc) {
089: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
090: .pcmf_getObjByName(IUnApplication.MY_APPL);
091: return (l_appl.pcmf_getComponentFactory()
092: .pcmf_createComboBoxPlugin(l_appl
093: .pcmf_getApplType(), "", "", "", l_appl,
094: xFactoryDesc));
095: }
096:
097: /**
098: * Creates a standard version of this component as described in the factory
099: * within the given application-context. If you create masses of components
100: * for e.g. within a renderer use this method for performance reasons.
101: *
102: * @param xAppl
103: * application in which context the component is created
104: * @return new component
105: */
106: public static IUnComboBox create(IUnApplication xAppl) {
107: return (xAppl.pcmf_getComponentFactory()
108: .pcmf_createComboBox(xAppl.pcmf_getApplType(), "",
109: "", "", xAppl));
110: }
111:
112: /**
113: * Creates a special version of this component as described in the factory
114: * configuration under the descriptor xFactoryDesc. If you create masses of
115: * components for e.g. within a renderer use this function for performance
116: * reasons.
117: *
118: * @param xFactoryDesc
119: * descriptor
120: * @param xAppl
121: * application in which context the component is created
122: * @return new component
123: */
124: public static IUnComboBox create(IUnApplication xAppl,
125: String xFactoryDesc) {
126: return (xAppl.pcmf_getComponentFactory()
127: .pcmf_createComboBoxPlugin(
128: xAppl.pcmf_getApplType(), "", "", "",
129: xAppl, xFactoryDesc));
130: }
131: }
132:
133: /**
134: * <p>
135: * Clears the comboBox
136: * </p>
137: * <p>
138: *
139: * </p>
140: * <p>
141: * </p>
142: */
143: public void pcmf_clearComboBox();
144:
145: /**
146: * <p>
147: * Clears the comboBox and deletes the values if they are registred
148: * </p>
149: * <p>
150: *
151: * </p>
152: * <p>
153: * </p>
154: */
155: public void pcmf_clearAndReleaseComboBox();
156: };
|