KickJava   Java API By Example, From Geeks To Geeks.

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


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;acronym&gt; tag.
64
65     @version $Id: acronym.java,v 1.2 2003/04/27 09:41:09 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 acronym extends MultiPartElement implements Printable, MouseEvents, KeyEvents
71 {
72     /**
73         Private initialization routine.
74     */
75     {
76         setElementType("acronym");
77         setCase(LOWERCASE);
78         setAttributeQuote(true);
79     }
80     /**
81         Basic constructor.
82     */
83     public acronym()
84     {
85     }
86
87     /**
88         Basic constructor.
89         @param element Adds an Element to the element.
90     */
91     public acronym(Element element)
92     {
93         addElement(element);
94     }
95
96     /**
97         Basic constructor.
98         @param element Adds an Element to the element.
99     */
100     public acronym(String JavaDoc element)
101     {
102         addElement(element);
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         Adds an Element to the element.
118         @param hashcode name of element for hash table
119         @param element Adds an Element to the element.
120      */
121     public acronym addElement(String JavaDoc hashcode,Element element)
122     {
123         addElementToRegistry(hashcode,element);
124         return(this);
125     }
126
127     /**
128         Adds an Element to the element.
129         @param hashcode name of element for hash table
130         @param element Adds an Element to the element.
131      */
132     public acronym addElement(String JavaDoc hashcode,String JavaDoc element)
133     {
134         addElementToRegistry(hashcode,element);
135         return(this);
136     }
137     /**
138         Adds an Element to the element.
139         @param element Adds an Element to the element.
140      */
141     public acronym addElement(Element element)
142     {
143         addElementToRegistry(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 acronym addElement(String JavaDoc element)
152     {
153         addElementToRegistry(element);
154         return(this);
155     }
156     /**
157         Removes an Element from the element.
158         @param hashcode the name of the element to be removed.
159     */
160     public acronym removeElement(String JavaDoc hashcode)
161     {
162         removeElementFromRegistry(hashcode);
163         return(this);
164     }
165     
166     /**
167         The onclick event occurs when the pointing device button is clicked
168         over an element. This attribute may be used with most elements.
169         
170         @param The script
171     */
172     public void setOnClick(String JavaDoc script)
173     {
174         addAttribute ( "onclick", script );
175     }
176     /**
177         The ondblclick event occurs when the pointing device button is double
178         clicked over an element. This attribute may be used with most elements.
179
180         @param The script
181     */
182     public void setOnDblClick(String JavaDoc script)
183     {
184         addAttribute ( "ondblclick", script );
185     }
186     /**
187         The onmousedown event occurs when the pointing device button is pressed
188         over an element. This attribute may be used with most elements.
189
190         @param The script
191     */
192     public void setOnMouseDown(String JavaDoc script)
193     {
194         addAttribute ( "onmousedown", script );
195     }
196     /**
197         The onmouseup event occurs when the pointing device button is released
198         over an element. This attribute may be used with most elements.
199
200         @param The script
201     */
202     public void setOnMouseUp(String JavaDoc script)
203     {
204         addAttribute ( "onmouseup", script );
205     }
206     /**
207         The onmouseover event occurs when the pointing device is moved onto an
208         element. This attribute may be used with most elements.
209
210         @param The script
211     */
212     public void setOnMouseOver(String JavaDoc script)
213     {
214         addAttribute ( "onmouseover", script );
215     }
216     /**
217         The onmousemove event occurs when the pointing device is moved while it
218         is over an element. This attribute may be used with most elements.
219
220         @param The script
221     */
222     public void setOnMouseMove(String JavaDoc script)
223     {
224         addAttribute ( "onmousemove", script );
225     }
226     /**
227         The onmouseout event occurs when the pointing device is moved away from
228         an element. This attribute may be used with most elements.
229
230         @param The script
231     */
232     public void setOnMouseOut(String JavaDoc script)
233     {
234         addAttribute ( "onmouseout", script );
235     }
236
237     /**
238         The onkeypress event occurs when a key is pressed and released over an
239         element. This attribute may be used with most elements.
240         
241         @param The script
242     */
243     public void setOnKeyPress(String JavaDoc script)
244     {
245         addAttribute ( "onkeypress", script );
246     }
247
248     /**
249         The onkeydown event occurs when a key is pressed down over an element.
250         This attribute may be used with most elements.
251         
252         @param The script
253     */
254     public void setOnKeyDown(String JavaDoc script)
255     {
256         addAttribute ( "onkeydown", script );
257     }
258
259     /**
260         The onkeyup event occurs when a key is released over an element. This
261         attribute may be used with most elements.
262         
263         @param The script
264     */
265     public void setOnKeyUp(String JavaDoc script)
266     {
267         addAttribute ( "onkeyup", script );
268     }
269 }
270
Popular Tags