KickJava   Java API By Example, From Geeks To Geeks.

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