KickJava   Java API By Example, From Geeks To Geeks.

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


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