KickJava   Java API By Example, From Geeks To Geeks.

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


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