KickJava   Java API By Example, From Geeks To Geeks.

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