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: public interface IUnHtmlPane extends IUnScrollController, IUnComponent {
036: /**
037: * @author Dirk
038: *
039: * date: 29.05.2007 project: WiSer-Framework
040: *
041: * <p>
042: * Factory is a convenience class to create components of the surrounding
043: * interface's type without taking care for the WidgetServer MultiChannel API.
044: * It's use is similar to a constructor.
045: * </p>
046: */
047: public static class Factory {
048: /**
049: * Creates a standard version of this component as described in the factory.
050: * If you create masses of components for e.g. within a renderer use
051: * <i> create(IUnApplication xAppl)</i> for performance
052: * reasons.
053: *
054: * @param xHtml
055: * html code to display
056: * @return new component
057: */
058: public static IUnHtmlPane create(String xHtml) {
059: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
060: .pcmf_getObjByName(IUnApplication.MY_APPL);
061: return (l_appl.pcmf_getComponentFactory()
062: .pcmf_createHtmlPane(l_appl.pcmf_getApplType(), "",
063: xHtml, l_appl));
064: }
065:
066: /**
067: * Creates a special version of this component as described in the factory
068: * configuration under the descriptor xFactoryDesc. If you create masses of
069: * components for e.g. within a renderer use <i>
070: * create(IUnApplication xAppl, String xFactoryDesc)</i> for performance
071: * reasons.
072: *
073: * @param xHtml
074: * html code to display
075: * @param xFactoryDesc
076: * descriptor
077: * @return new component
078: */
079: public static IUnHtmlPane create(String xHtml,
080: String xFactoryDesc) {
081: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
082: .pcmf_getObjByName(IUnApplication.MY_APPL);
083: return (l_appl.pcmf_getComponentFactory()
084: .pcmf_createHtmlPanePlugin(l_appl
085: .pcmf_getApplType(), "", xHtml, l_appl,
086: xFactoryDesc));
087: }
088:
089: /**
090: * Creates a standard version of this component as described in the factory
091: * within the given application-context. If you create masses of components
092: * for e.g. within a renderer use this method for performance reasons.
093: *
094: * @param xHtml
095: * html code to display
096: * @param xAppl
097: * application in which context the component is created
098: * @return new component
099: */
100: public static IUnHtmlPane create(String xHtml,
101: IUnApplication xAppl) {
102: return (xAppl.pcmf_getComponentFactory()
103: .pcmf_createHtmlPane(xAppl.pcmf_getApplType(), "",
104: xHtml, xAppl));
105: }
106:
107: /**
108: * Creates a special version of this component as described in the factory
109: * configuration under the descriptor xFactoryDesc. If you create masses of
110: * components for e.g. within a renderer use this function for performance
111: * reasons.
112: *
113: * @param xHtml
114: * html code to display
115: * @param xFactoryDesc
116: * descriptor
117: * @param xAppl
118: * application in which context the component is created
119: * @return new component
120: */
121: public static IUnHtmlPane create(String xHtml,
122: IUnApplication xAppl, String xFactoryDesc) {
123: return (xAppl.pcmf_getComponentFactory()
124: .pcmf_createHtmlPanePlugin(
125: xAppl.pcmf_getApplType(), "", xHtml, xAppl,
126: xFactoryDesc));
127: }
128: }
129:
130: /**
131: * <p>
132: * Sets the html string
133: * </p>
134: * <p>
135: *
136: * </p>
137: * <p>
138: *
139: * @param xHtml
140: * String
141: * </p>
142: */
143: public void pcmf_setHtmlString(String xHtml);
144:
145: /**
146: * <p>
147: * Sets a file to read the html from
148: * </p>
149: * <p>
150: *
151: * </p>
152: * <p>
153: *
154: * @param xHtml
155: * file
156: * </p>
157: */
158: public void pcmf_setHtmlFile(String xFile);
159:
160: /**
161: * <p>
162: * Enables or disables the scroll capability of the panel
163: * </p>
164: * <p>
165: *
166: * </p>
167: * <p>
168: *
169: * @param xScroll
170: * true enables scrolling, false disables scrolling
171: * </p>
172: */
173: public void pcmf_setScroll(boolean xScroll);
174:
175: /**
176: * <p>
177: * Gets the scroll capability of the panel
178: * </p>
179: * <p>
180: *
181: * </p>
182: * <p>
183: * </p>
184: */
185: public boolean pcmf_getScroll();
186: }
|