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: 02.01.2004 project: WiSer-Framework
039: *
040: * <p>
041: * Common interface to a file-chooser-widget. This widgtes allows file-selection
042: * selections on the file-system. This Component works only on the client side of an application.
043: * If you need a server side file chooser please use the plugin.
044: * </p>
045: */
046: public interface IUnFileChooser extends IUnComponent {
047: /**
048: * @author Dirk
049: *
050: * date: 29.05.2007 project: WiSer-Framework
051: *
052: * <p>
053: * Factory is a convenience class to create components of the surrounding interface's type without
054: * taking care for the WidgetServer MultiChannel API. It's use is similar to a
055: * constructor.
056: * </p>
057: */
058: public static class Factory {
059: /**
060: * Creates a standard version of this component as described in the factory.
061: * If you create masses of components for e.g. within a renderer use
062: * <i> create(IUnApplication xAppl)</i> for performance
063: * reasons.
064: *
065: * @return new component
066: */
067: public static IUnFileChooser create() {
068: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
069: .pcmf_getObjByName(IUnApplication.MY_APPL);
070: return (l_appl.pcmf_getComponentFactory()
071: .pcmf_createFileChooser(l_appl.pcmf_getApplType(),
072: "", "", l_appl));
073: }
074:
075: /**
076: * Creates a special version of this component as described in the factory
077: * configuration under the descriptor xFactoryDesc. If you create masses of
078: * components for e.g. within a renderer use <i>
079: * create(IUnApplication xAppl, String xFactoryDesc)</i> for performance
080: * reasons.
081: *
082: * @param xFactoryDesc
083: * descriptor
084: * @return new component
085: */
086: public static IUnFileChooser create(String xFactoryDesc) {
087: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
088: .pcmf_getObjByName(IUnApplication.MY_APPL);
089: return (l_appl.pcmf_getComponentFactory()
090: .pcmf_createFileChooserPlugin(l_appl
091: .pcmf_getApplType(), "", "", l_appl,
092: xFactoryDesc));
093: }
094:
095: /**
096: * Creates a standard version of this component as described in the factory
097: * within the given application-context. If you create masses of components
098: * for e.g. within a renderer use this method for performance reasons.
099: *
100: * @param xAppl
101: * application in which context the component is created
102: * @return new component
103: */
104: public static IUnFileChooser create(IUnApplication xAppl) {
105: return (xAppl.pcmf_getComponentFactory()
106: .pcmf_createFileChooser(xAppl.pcmf_getApplType(),
107: "", "", xAppl));
108: }
109:
110: /**
111: * Creates a special version of this component as described in the factory
112: * configuration under the descriptor xFactoryDesc. If you create masses of
113: * components for e.g. within a renderer use this function for performance
114: * reasons.
115: *
116: * @param xFactoryDesc
117: * descriptor
118: * @param xAppl
119: * application in which context the component is created
120: * @return new component
121: */
122: public static IUnFileChooser create(IUnApplication xAppl,
123: String xFactoryDesc) {
124: return (xAppl.pcmf_getComponentFactory()
125: .pcmf_createFileChooserPlugin(xAppl
126: .pcmf_getApplType(), "", "", xAppl,
127: xFactoryDesc));
128: }
129: }
130:
131: /**
132: * <p>
133: * Opens a file-selection dialog to select a file to be read.
134: * </p>
135: */
136: public void pcmf_selectReadFile();
137:
138: /**
139: * <p>
140: * Selects whether the readfile is uploaded to the server or not
141: * </p>
142: */
143: public void pcmf_setUploadReadFile(boolean xUpload);
144:
145: /**
146: * <p>
147: * Opens a file-selection dialog to select a file to be written.
148: * </p>
149: */
150: public void pcmf_selectWriteFile();
151:
152: /**
153: * <p>
154: * Opens a file-selection dialog
155: * </p>
156: */
157: public void pcmf_selectFile();
158:
159: /**
160: * <p>
161: * Returns the selection mode
162: * </p>
163: * <p>
164: *
165: * @return 'r' read-mode
166: * @return 's' select-mode
167: * @return 'w' write-mode
168: * </p>
169: */
170: public char pcmf_getMode();
171: }
|