KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > xhtml > ol


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