KickJava   Java API By Example, From Geeks To Geeks.

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


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