KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > html > UL


1 /*
2  * ====================================================================
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Jakarta Element Construction Set",
29  * "Jakarta ECS" , and "Apache Software Foundation" must not be used
30  * to endorse or promote products derived
31  * from this software without prior written permission. For written
32  * permission, please contact apache@apache.org.
33  *
34  * 5. Products derived from this software may not be called "Apache",
35  * "Jakarta Element Construction Set" nor "Jakarta ECS" nor may "Apache"
36  * appear in their names without prior written permission of the Apache Group.
37  *
38  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
39  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
40  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
41  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
44  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
45  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
46  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
48  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49  * SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This software consists of voluntary contributions made by many
53  * individuals on behalf of the Apache Software Foundation. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  *
57  */
58 package org.apache.ecs.html;
59
60 import org.apache.ecs.*;
61
62 /**
63     This class creates a &lt;UL&gt; tag.
64
65     @version $Id: UL.java,v 1.4 2003/04/27 09:22:57 rdonkin Exp $
66     @author <a HREF="mailto:snagy@servletapi.com">Stephan Nagy</a>
67     @author <a HREF="mailto:jon@clearink.com">Jon S. Stevens</a>
68 */
69 public class UL extends MultiPartElement implements Printable, MouseEvents, KeyEvents
70 {
71     /**
72         Private initialization routine.
73     */
74     {
75         setElementType("ul");
76     }
77     /**
78         Basic constructor, use the set* methods.
79     */
80     public UL()
81     {
82     }
83
84     /**
85         Basic constructor, use the set* methods.
86         @param list an array of LI elements.
87     */
88     public UL(LI[] list)
89     {
90         addElement(list);
91     }
92
93     /**
94         Basic constructor, use the set* methods.
95         @param list an array of string elements to be converted to li.
96     */
97     public UL(String JavaDoc[] list)
98     {
99         addElement(list);
100     }
101
102     /**
103         Add a list to the UL
104         @param list a list of LI objects.
105     */
106     public UL addElement(LI[] list)
107     {
108         for(int x = 0; x < list.length; x++)
109         {
110             addElement(list[x]);
111         }
112         return(this);
113     }
114
115     /**
116         Adds an Element to the element.
117         @param hashcode name of element for hash table
118         @param element Adds an Element to the element.
119      */
120     public UL addElement(String JavaDoc hashcode,Element element)
121     {
122         addElementToRegistry(hashcode,element);
123         return(this);
124     }
125
126     /**
127         Adds an Element to the element.
128         @param hashcode name of element for hash table
129         @param element Adds an Element to the element.
130      */
131     public UL addElement(String JavaDoc hashcode,String JavaDoc element)
132     {
133         addElementToRegistry(hashcode,element);
134         return(this);
135     }
136
137     /**
138         Adds an Element to the element.
139         @param element Adds an Element to the element.
140      */
141     public UL addElement(Element element)
142     {
143         addElementToRegistry(element);
144         return(this);
145     }
146     
147     /**
148         Adds an Element to the element.
149         @param element Adds an Element to the element.
150      */
151     public UL addElement(String JavaDoc element)
152     {
153         addElementToRegistry(element);
154         return(this);
155     }
156
157     /**
158         Add a list to the UL
159         @param list a list of Strings to be converted to li objects.
160     */
161     public UL addElement(String JavaDoc[] element)
162     {
163         LI[] li = new LI().addElement(element);
164         addElement(li);
165         return(this);
166     }
167     /**
168         Removes an Element from the element.
169         @param hashcode the name of the element to be removed.
170     */
171     public UL removeElement(String JavaDoc hashcode)
172     {
173         removeElementFromRegistry(hashcode);
174         return(this);
175     }
176
177     /**
178         The onclick event occurs when the pointing device button is clicked
179         over an element. This attribute may be used with most elements.
180         
181         @param The script
182     */
183     public void setOnClick(String JavaDoc script)
184     {
185         addAttribute ( "onClick", script );
186     }
187     /**
188         The ondblclick event occurs when the pointing device button is double
189         clicked over an element. This attribute may be used with most elements.
190
191         @param The script
192     */
193     public void setOnDblClick(String JavaDoc script)
194     {
195         addAttribute ( "onDblClick", script );
196     }
197     /**
198         The onmousedown event occurs when the pointing device button is pressed
199         over an element. This attribute may be used with most elements.
200
201         @param The script
202     */
203     public void setOnMouseDown(String JavaDoc script)
204     {
205         addAttribute ( "onMouseDown", script );
206     }
207     /**
208         The onmouseup event occurs when the pointing device button is released
209         over an element. This attribute may be used with most elements.
210
211         @param The script
212     */
213     public void setOnMouseUp(String JavaDoc script)
214     {
215         addAttribute ( "onMouseUp", script );
216     }
217     /**
218         The onmouseover event occurs when the pointing device is moved onto an
219         element. This attribute may be used with most elements.
220
221         @param The script
222     */
223     public void setOnMouseOver(String JavaDoc script)
224     {
225         addAttribute ( "onMouseOver", script );
226     }
227     /**
228         The onmousemove event occurs when the pointing device is moved while it
229         is over an element. This attribute may be used with most elements.
230
231         @param The script
232     */
233     public void setOnMouseMove(String JavaDoc script)
234     {
235         addAttribute ( "onMouseMove", script );
236     }
237     /**
238         The onmouseout event occurs when the pointing device is moved away from
239         an element. This attribute may be used with most elements.
240
241         @param The script
242     */
243     public void setOnMouseOut(String JavaDoc script)
244     {
245         addAttribute ( "onMouseOut", script );
246     }
247
248     /**
249         The onkeypress event occurs when a key is pressed and released over an
250         element. This attribute may be used with most elements.
251         
252         @param The script
253     */
254     public void setOnKeyPress(String JavaDoc script)
255     {
256         addAttribute ( "onKeyPress", script );
257     }
258
259     /**
260         The onkeydown event occurs when a key is pressed down over an element.
261         This attribute may be used with most elements.
262         
263         @param The script
264     */
265     public void setOnKeyDown(String JavaDoc script)
266     {
267         addAttribute ( "onKeyDown", script );
268     }
269
270     /**
271         The onkeyup event occurs when a key is released over an element. This
272         attribute may be used with most elements.
273         
274         @param The script
275     */
276     public void setOnKeyUp(String JavaDoc script)
277     {
278         addAttribute ( "onKeyUp", script );
279     }
280 }
281
Popular Tags