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: /**
032: * @author Dirk
033: *
034: * date: 15.05.2007 project: WiSer-Framework
035: *
036: * <p>
037: * IUnAnchoredPopUp is the common interface to a popup which is anchored in a fixed place
038: * </p>
039: */package de.ug2t.unifiedGui.interfaces;
040:
041: import de.ug2t.kernel.*;
042: import de.ug2t.unifiedGui.*;
043:
044: /**
045: * @author Dirk
046: *
047: * date: 23.05.2007 project: WiSer-Framework
048: *
049: * <p>
050: * IUnAnchoredPop is the common interface to anchored popups for all supported
051: * channels. An anchored popup is a popup this is anchored at a specific
052: * position in the layout (similar to the comboBox popup)
053: * </p>
054: */
055: public interface IUnAnchoredPopUp extends IUnComponent, IUnIconView {
056: /**
057: * @author Dirk
058: *
059: * date: 29.05.2007 project: WiSer-Framework
060: *
061: * <p>
062: * Factory is a convenience class to create components of the surrounding interface's type without
063: * taking care for the WidgetServer MultiChannel API. It's use is similar to a
064: * constructor.
065: * </p>
066: */
067: public static class Factory {
068: /**
069: * Creates a standard version of this component as described in the factory.
070: * If you create masses of components for e.g. within a renderer use
071: * <i> create(IUnApplication xAppl)</i> for performance
072: * reasons.
073: *
074: * @return new component
075: */
076: public static IUnAnchoredPopUp create() {
077: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
078: .pcmf_getObjByName(IUnApplication.MY_APPL);
079: return (l_appl.pcmf_getComponentFactory()
080: .pcmf_createAPopup(l_appl.pcmf_getApplType(), "",
081: l_appl));
082: }
083:
084: /**
085: * Creates a special version of this component as described in the factory
086: * configuration under the descriptor xFactoryDesc. If you create masses of
087: * components for e.g. within a renderer use <i>
088: * create(IUnApplication xAppl, String xFactoryDesc)</i> for performance
089: * reasons.
090: *
091: * @param xFactoryDesc
092: * descriptor
093: * @return new component
094: */
095: public static IUnAnchoredPopUp create(String xFactoryDesc) {
096: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
097: .pcmf_getObjByName(IUnApplication.MY_APPL);
098: return (l_appl.pcmf_getComponentFactory()
099: .pcmf_createAPopupPlugin(l_appl.pcmf_getApplType(),
100: "", l_appl, 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 xAppl
109: * application in which context the component is created
110: * @return new component
111: */
112: public static IUnAnchoredPopUp create(IUnApplication xAppl) {
113: return (xAppl.pcmf_getComponentFactory().pcmf_createAPopup(
114: xAppl.pcmf_getApplType(), "", xAppl));
115: }
116:
117: /**
118: * Creates a special version of this component as described in the factory
119: * configuration under the descriptor xFactoryDesc. If you create masses of
120: * components for e.g. within a renderer use this function for performance
121: * reasons.
122: *
123: * @param xFactoryDesc
124: * descriptor
125: * @param xAppl
126: * application in which context the component is created
127: * @return new component
128: */
129: public static IUnAnchoredPopUp create(IUnApplication xAppl,
130: String xFactoryDesc) {
131: return (xAppl.pcmf_getComponentFactory()
132: .pcmf_createAPopupPlugin(xAppl.pcmf_getApplType(),
133: "", xAppl, xFactoryDesc));
134: }
135: }
136:
137: /**
138: * <p>
139: * Sets the component which is displayed as popup
140: * </p>
141: * <p>
142: *
143: * @param xBorder
144: * popup component
145: * </p>
146: */
147: public void pcmf_setComponent(IUnComponent xComp);
148:
149: /**
150: * <p>
151: * Sets the component which is displayed as popup
152: * </p>
153: * <p>
154: *
155: * @param xBorder
156: * popup component
157: * </p>
158: */
159: public void pcmf_setComponent(UnComponent xComp);
160:
161: /**
162: * <p>
163: * Sets the horizontal offset of the of the popup component
164: * </p>
165: * <p>
166: *
167: * @param xOffs
168: * offset in pixel
169: * </p>
170: */
171: public void pcmf_setPopUpHorizontalOffset(int xOffs);
172:
173: /**
174: * <p>
175: * Sets the vertical offset of the of the popup component
176: * </p>
177: * <p>
178: *
179: * @param xOffs
180: * offset in pixel
181: * </p>
182: */
183: public void pcmf_setPopUpVerticalOffset(int xOffs);
184:
185: /**
186: * <p>
187: * Returns the horizontal offset of the popup component
188: * </p>
189: */
190: public int pcmf_getPopUpHorizontalOffset();
191:
192: /**
193: * <p>
194: * Returns the vertical offset of the popup component
195: * </p>
196: */
197: public int pcmf_getPopUpVerticalOffset();
198:
199: /**
200: * <p>
201: * Informs the caller whether the dialog is currently displayed or not.
202: * </p>
203: */
204: public boolean pcmf_isDisplay();
205:
206: /**
207: * <p>
208: * This function activates the popup, that means the next render positions the
209: * dialogue of the active page.
210: * </p>
211: */
212: public void pcmf_displayPopup();
213:
214: /**
215: * <p>
216: * Deactivates an activated popup.
217: * </p>
218: */
219: public void pcmf_hidePopup();
220:
221: }
|