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 create a border around other widgets or
042: * widget-groups.
043: * </p>
044: */
045: public interface IUnBorder extends IUnContainer, IUnLayouted,
046: IUnComponent, IUnPanel {
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 IUnBorder create() {
068: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
069: .pcmf_getObjByName(IUnApplication.MY_APPL);
070: return (l_appl.pcmf_getComponentFactory()
071: .pcmf_createBorder(l_appl.pcmf_getApplType(), "",
072: false, 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 IUnBorder create(String xFactoryDesc) {
087: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
088: .pcmf_getObjByName(IUnApplication.MY_APPL);
089: return (l_appl.pcmf_getComponentFactory()
090: .pcmf_createBorderPlugin(l_appl.pcmf_getApplType(),
091: "", false, l_appl, xFactoryDesc));
092: }
093:
094: /**
095: * Creates a standard version of this component as described in the factory
096: * within the given application-context. If you create masses of components
097: * for e.g. within a renderer use this method for performance reasons.
098: *
099: * @param xAppl
100: * application in which context the component is created
101: * @return new component
102: */
103: public static IUnBorder create(IUnApplication xAppl) {
104: return (xAppl.pcmf_getComponentFactory().pcmf_createBorder(
105: xAppl.pcmf_getApplType(), "", false, xAppl));
106: }
107:
108: /**
109: * Creates a special version of this component as described in the factory
110: * configuration under the descriptor xFactoryDesc. If you create masses of
111: * components for e.g. within a renderer use this function for performance
112: * reasons.
113: *
114: * @param xFactoryDesc
115: * descriptor
116: * @param xAppl
117: * application in which context the component is created
118: * @return new component
119: */
120: public static IUnBorder create(IUnApplication xAppl,
121: String xFactoryDesc) {
122: return (xAppl.pcmf_getComponentFactory()
123: .pcmf_createBorderPlugin(xAppl.pcmf_getApplType(),
124: "", false, xAppl, xFactoryDesc));
125: }
126: }
127:
128: /**
129: * <p>
130: * Sets the width of the border-line
131: * </p>
132: * <p>
133: *
134: * </p>
135: * <p>
136: *
137: * @param xBorder
138: * width in pixel
139: * </p>
140: */
141: public void pcmf_setBorderLine(int xBorder);
142:
143: /**
144: * <p>
145: * Sets the color of the border-line
146: * </p>
147: * <p>
148: *
149: * </p>
150: * <p>
151: *
152: * @param xColor
153: * color as predefined color-string like red, green, yellow, ...
154: * </p>
155: */
156: public void pcmf_setBoColor(String xColor);
157:
158: /**
159: * <p>
160: * Sets the style of the border-line
161: * </p>
162: * <p>
163: *
164: * </p>
165: * <p>
166: *
167: * @param xStyle
168: * is either IUnComponent.INSETS_BORDER, IUnComponent.OUTSETS_BORDER,
169: * IUnComponent.LINE_BORDER
170: * </p>
171: */
172: public void pcmf_setBoStyle(int xStyle);
173: }
|