KickJava   Java API By Example, From Geeks To Geeks.

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


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