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 java.util.*;
034:
035: import de.ug2t.kernel.*;
036:
037: /**
038: * @author Dirk
039: *
040: * date: 26.11.2003 project: WiSer-Framework
041: *
042: * <p>
043: * This is the common interface to slider widgets
044: * </p>
045: */
046: public interface IUnSlider extends IUnComponent {
047: public static final int SLIDE_HORIZONTAL = 0;
048: public static final int SLIDE_VERTICAL = 1;
049:
050: /**
051: * @author Dirk
052: *
053: * date: 29.05.2007 project: WiSer-Framework
054: *
055: * <p>
056: * Factory is a convenience class to create components of the surrounding
057: * interface's type without taking care for the WidgetServer MultiChannel API.
058: * It's use is similar to a constructor.
059: * </p>
060: */
061: public static class Factory {
062: /**
063: * Creates a standard version of this component as described in the factory.
064: * If you create masses of components for e.g. within a renderer use
065: * <i> create(IUnApplication xAppl)</i> for performance
066: * reasons.
067: *
068: * @param xDir
069: * direction either SLIDE_HORIZONTAL | SLIDE_VERTICAL
070: * @return new component
071: */
072: public static IUnSlider create(int xDir) {
073: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
074: .pcmf_getObjByName(IUnApplication.MY_APPL);
075: return (l_appl.pcmf_getComponentFactory()
076: .pcmf_createSlider(l_appl.pcmf_getApplType(), "",
077: xDir, l_appl));
078: }
079:
080: /**
081: * Creates a special version of this component as described in the factory
082: * configuration under the descriptor xFactoryDesc. If you create masses of
083: * components for e.g. within a renderer use <i>
084: * create(IUnApplication xAppl, String xFactoryDesc)</i> for performance
085: * reasons.
086: *
087: * @param xDir
088: * direction either SLIDE_HORIZONTAL | SLIDE_VERTICAL
089: * @param xFactoryDesc
090: * descriptor
091: * @return new component
092: */
093: public static IUnSlider create(int xDir, String xFactoryDesc) {
094: IUnApplication l_appl = (IUnApplication) KeRegisteredObject
095: .pcmf_getObjByName(IUnApplication.MY_APPL);
096: return (l_appl.pcmf_getComponentFactory()
097: .pcmf_createSliderPlugin(l_appl.pcmf_getApplType(),
098: "", xDir, l_appl, xFactoryDesc));
099: }
100:
101: /**
102: * Creates a standard version of this component as described in the factory
103: * within the given application-context. If you create masses of components
104: * for e.g. within a renderer use this method for performance reasons.
105: *
106: * @param xDir
107: * direction either SLIDE_HORIZONTAL | SLIDE_VERTICAL
108: * @param xAppl
109: * application in which context the component is created
110: * @return new component
111: */
112: public static IUnSlider create(int xDir, IUnApplication xAppl) {
113: return (xAppl.pcmf_getComponentFactory().pcmf_createSlider(
114: xAppl.pcmf_getApplType(), "", xDir, 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 xDir
124: * direction either SLIDE_HORIZONTAL | SLIDE_VERTICAL
125: * @param xFactoryDesc
126: * descriptor
127: * @param xAppl
128: * application in which context the component is created
129: * @return new component
130: */
131: public static IUnSlider create(int xDir, IUnApplication xAppl,
132: String xFactoryDesc) {
133: return (xAppl.pcmf_getComponentFactory()
134: .pcmf_createSliderPlugin(xAppl.pcmf_getApplType(),
135: "", xDir, xAppl, xFactoryDesc));
136: }
137: }
138:
139: /**
140: * <p>
141: * sets the range of the slider
142: * </p>
143: * <p>
144: *
145: * </p>
146: * <p>
147: * </p>
148: */
149: public void pcmf_setRange(int xMinVal, int xMaxVal, int xSteps);
150:
151: /**
152: * <p>
153: * sets the range of the slider with a list of Strings like "min", "middle",
154: * "max"
155: * </p>
156: * <p>
157: *
158: * </p>
159: * <p>
160: * </p>
161: */
162: public void pcmf_setRange(Map xValues);
163:
164: /**
165: * <p>
166: * Commits the added value items
167: * </p>
168: * <p>
169: *
170: * </p>
171: * <p>
172: * </p>
173: */
174: public void pcmf_commitSlider();
175:
176: /**
177: * <p>
178: * Adds a value item
179: * </p>
180: * <p>
181: *
182: * </p>
183: * <p>
184: * </p>
185: */
186: public void pcmf_addValueItem(String xName, Object xValue);
187: }
|