KickJava   Java API By Example, From Geeks To Geeks.

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


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