KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > xhtml > 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.xhtml;
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.2 2003/04/27 09:36:37 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     @author <a HREF="mailto:bojan@binarix.com">Bojan Smojver</a>
69 */
70 public class ul extends MultiPartElement implements Printable, MouseEvents, KeyEvents
71 {
72     /**
73         Private initialization routine.
74     */
75     {
76         setElementType("ul");
77         setCase(LOWERCASE);
78         setAttributeQuote(true);
79     }
80     /**
81         Basic constructor, use the set* methods.
82     */
83     public ul()
84     {
85     }
86
87     /**
88         Basic constructor, use the set* methods.
89         @param list an array of li elements.
90     */
91     public ul(li[] list)
92     {
93         addElement(list);
94     }
95
96     /**
97         Basic constructor, use the set* methods.
98         @param list an array of string elements to be converted to li.
99     */
100     public ul(String JavaDoc[] list)
101     {
102         addElement(list);
103     }
104
105     /**
106         Sets the lang="" and xml:lang="" attributes
107         @param lang the lang="" and xml:lang="" attributes
108     */
109     public Element setLang(String JavaDoc lang)
110     {
111         addAttribute("lang",lang);
112         addAttribute("xml:lang",lang);
113         return this;
114     }
115
116     /**
117         Add a list to the ul
118         @param list a list of li objects.
119     */
120     public ul addElement(li[] list)
121     {
122         for(int x = 0; x < list.length; x++)
123         {
124             addElement(list[x]);
125         }
126         return(this);
127     }
128
129     /**
130         Adds an Element to the element.
131         @param hashcode name of element for hash table
132         @param element Adds an Element to the element.
133      */
134     public ul addElement(String JavaDoc hashcode,Element element)
135     {
136         addElementToRegistry(hashcode,element);
137         return(this);
138     }
139
140     /**
141         Adds an Element to the element.
142         @param hashcode name of element for hash table
143         @param element Adds an Element to the element.
144      */
145     public ul addElement(String JavaDoc hashcode,String JavaDoc element)
146     {
147         addElementToRegistry(hashcode,element);
148         return(this);
149     }
150
151     /**
152         Adds an Element to the element.
153         @param element Adds an Element to the element.
154      */
155     public ul addElement(Element element)
156     {
157         addElementToRegistry(element);
158         return(this);
159     }
160     
161     /**
162         Adds an Element to the element.
163         @param element Adds an Element to the element.
164      */
165     public ul addElement(String JavaDoc element)
166     {
167         addElementToRegistry(element);
168         return(this);
169     }
170
171      /**
172         Add a list to the ul
173         @param list a list of Strings to be converted to li objects.
174     */
175     public ul addElement(String JavaDoc[] element)
176     {
177         li[] li = new li().addElement(element);
178         addElement(li);
179         return(this);
180     }
181     /**
182         Removes an Element from the element.
183         @param hashcode the name of the element to be removed.
184     */
185     public ul removeElement(String JavaDoc hashcode)
186     {
187         removeElementFromRegistry(hashcode);
188         return(this);
189     }
190
191     /**
192         The onclick event occurs when the pointing device button is clicked
193         over an element. This attribute may be used with most elements.
194         
195         @param The script
196     */
197     public void setOnClick(String JavaDoc script)
198     {
199         addAttribute ( "onclick", script );
200     }
201     /**
202         The ondblclick event occurs when the pointing device button is double
203         clicked over an element. This attribute may be used with most elements.
204
205         @param The script
206     */
207     public void setOnDblClick(String JavaDoc script)
208     {
209         addAttribute ( "ondblclick", script );
210     }
211     /**
212         The onmousedown event occurs when the pointing device button is pressed
213         over an element. This attribute may be used with most elements.
214
215         @param The script
216     */
217     public void setOnMouseDown(String JavaDoc script)
218     {
219         addAttribute ( "onmousedown", script );
220     }
221     /**
222         The onmouseup event occurs when the pointing device button is released
223         over an element. This attribute may be used with most elements.
224
225         @param The script
226     */
227     public void setOnMouseUp(String JavaDoc script)
228     {
229         addAttribute ( "onmouseup", script );
230     }
231     /**
232         The onmouseover event occurs when the pointing device is moved onto an
233         element. This attribute may be used with most elements.
234
235         @param The script
236     */
237     public void setOnMouseOver(String JavaDoc script)
238     {
239         addAttribute ( "onmouseover", script );
240     }
241     /**
242         The onmousemove event occurs when the pointing device is moved while it
243         is over an element. This attribute may be used with most elements.
244
245         @param The script
246     */
247     public void setOnMouseMove(String JavaDoc script)
248     {
249         addAttribute ( "onmousemove", script );
250     }
251     /**
252         The onmouseout event occurs when the pointing device is moved away from
253         an element. This attribute may be used with most elements.
254
255         @param The script
256     */
257     public void setOnMouseOut(String JavaDoc script)
258     {
259         addAttribute ( "onmouseout", script );
260     }
261
262     /**
263         The onkeypress event occurs when a key is pressed and released over an
264         element. This attribute may be used with most elements.
265         
266         @param The script
267     */
268     public void setOnKeyPress(String JavaDoc script)
269     {
270         addAttribute ( "onkeypress", script );
271     }
272
273     /**
274         The onkeydown event occurs when a key is pressed down over an element.
275         This attribute may be used with most elements.
276         
277         @param The script
278     */
279     public void setOnKeyDown(String JavaDoc script)
280     {
281         addAttribute ( "onkeydown", script );
282     }
283
284     /**
285         The onkeyup event occurs when a key is released over an element. This
286         attribute may be used with most elements.
287         
288         @param The script
289     */
290     public void setOnKeyUp(String JavaDoc script)
291     {
292         addAttribute ( "onkeyup", script );
293     }
294 }
295
Popular Tags