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 checkBox widgets
042: * </p>
043: */
044: public interface IUnCheckBox extends IUnInputComponent, IUnIconView,
045: IUnComponent, IUnKeyAccess {
046: public static String CHECKED = "CHECKED";
047: public static String NOTCHECKED = "NOTCHECKED";
048:
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
056: * interface's type without taking care for the WidgetServer MultiChannel API.
057: * It's use is similar to a 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: * @param xLabel
068: * the label of the CheckBox
069: * @return new component
070: */
071: public static IUnCheckBox create(String xLabel) {
072: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
073: .pcmf_getObjByName(IUnApplication.MY_APPL);
074: return (l_appl.pcmf_getComponentFactory()
075: .pcmf_createCheckBox(l_appl.pcmf_getApplType(),
076: IUnCheckBox.NOTCHECKED, xLabel, l_appl));
077: }
078:
079: /**
080: * Creates a special version of this component as described in the factory
081: * configuration under the descriptor xFactoryDesc. If you create masses of
082: * components for e.g. within a renderer use <i>
083: * create(IUnApplication xAppl, String xFactoryDesc)</i> for performance
084: * reasons.
085: *
086: * @param xLabel
087: * the label of the CheckBox
088: * @param xFactoryDesc
089: * descriptor
090: * @return new component
091: */
092: public static IUnCheckBox create(String xLabel,
093: String xFactoryDesc) {
094: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
095: .pcmf_getObjByName(IUnApplication.MY_APPL);
096: return (l_appl.pcmf_getComponentFactory()
097: .pcmf_createCheckBoxPlugin(l_appl
098: .pcmf_getApplType(),
099: IUnCheckBox.NOTCHECKED, xLabel, l_appl,
100: xFactoryDesc));
101: }
102:
103: /**
104: * Creates a standard version of this component as described in the factory
105: * within the given application-context. If you create masses of components
106: * for e.g. within a renderer use this method for performance reasons.
107: *
108: * @param xLabel
109: * the label of the CheckBox
110: * @param xAppl
111: * application in which context the component is created
112: * @return new component
113: */
114: public static IUnCheckBox create(String xLabel,
115: IUnApplication xAppl) {
116: return (xAppl.pcmf_getComponentFactory()
117: .pcmf_createCheckBox(xAppl.pcmf_getApplType(),
118: IUnCheckBox.NOTCHECKED, xLabel, xAppl));
119: }
120:
121: /**
122: * Creates a special version of this component as described in the factory
123: * configuration under the descriptor xFactoryDesc. If you create masses of
124: * components for e.g. within a renderer use this function for performance
125: * reasons.
126: *
127: * @param xLabel
128: * the label of the CheckBox
129: * @param xFactoryDesc
130: * descriptor
131: * @param xAppl
132: * application in which context the component is created
133: * @return new component
134: */
135: public static IUnCheckBox create(String xLabel,
136: IUnApplication xAppl, String xFactoryDesc) {
137: return (xAppl.pcmf_getComponentFactory()
138: .pcmf_createCheckBoxPlugin(
139: xAppl.pcmf_getApplType(),
140: IUnCheckBox.NOTCHECKED, xLabel, xAppl,
141: xFactoryDesc));
142: }
143: }
144:
145: /**
146: * <p>
147: * Sets the label
148: * </p>
149: * <p>
150: *
151: * </p>
152: * <p>
153: *
154: * @param xLabel
155: * new label
156: * </p>
157: */
158: public void pcmf_setLabel(String xLabel);
159:
160: /**
161: * <p>
162: * Gets the label
163: * </p>
164: * <p>
165: *
166: * </p>
167: * <p>
168: *
169: * @return current label
170: * </p>
171: */
172: public String pcmf_getLabel();
173: }
|