KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > html > Body


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 /**
63     This class creates a &lt;BODY&gt;&lt;/BODY&gt; tag.
64
65     @version $Id: Body.java,v 1.4 2003/04/27 09:20:40 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 */
69 public class Body extends MultiPartElement implements Printable, PageEvents, MouseEvents, KeyEvents
70 {
71     /**
72         Private initialization routine.
73     */
74     {
75         setElementType("body");
76     }
77
78     /**
79         Basic constructor. Use the set* methods to set the values
80         of the attributes.
81     */
82     public Body()
83     {
84     }
85
86     /**
87         Use the set* methods to set the values
88         of the attributes.
89         @param color the BGCOLOR="" attribute
90     */
91     public Body(String JavaDoc color)
92     {
93         setBgColor(color);
94     }
95
96     /**
97         Sets the BGCOLOR="" attribute
98         @param color the BGCOLOR="" attribute
99     */
100     public Body setBgColor(String JavaDoc color)
101     {
102         addAttribute("bgcolor",HtmlColor.convertColor(color));
103         return this;
104     }
105
106     /**
107         Sets the BACKGROUND="" attribute
108         @param url the BACKGROUND="" attribute
109     */
110     public Body setBackground(String JavaDoc url)
111     {
112         addAttribute("background",url);
113         return this;
114     }
115
116     /**
117         Sets the TEXT="" attribute
118         @param text the TEXT="" attribute
119     */
120     public Body setText(String JavaDoc text)
121     {
122         addAttribute("text",text);
123         return this;
124     }
125
126     /**
127         Sets the LINK="" attribute
128         @param color the LINK="" attribute
129     */
130     public Body setLink(String JavaDoc color)
131     {
132         addAttribute("link",HtmlColor.convertColor(color));
133         return this;
134     }
135
136     /**
137         Sets the VLINK="" attribute
138         @param color the VLINK="" attribute
139     */
140     public Body setVlink(String JavaDoc color)
141     {
142         addAttribute("vlink",HtmlColor.convertColor(color));
143         return this;
144     }
145
146     /**
147         Sets the ALINK="" attribute
148         @param color the ALINK="" attribute
149     */
150     public Body setAlink(String JavaDoc color)
151     {
152         addAttribute("alink",HtmlColor.convertColor(color));
153         return this;
154     }
155
156     /**
157         Adds an Element to the element.
158         @param hashcode name of element for hash table
159         @param element Adds an Element to the element.
160      */
161     public Body addElement(String JavaDoc hashcode,Element element)
162     {
163         addElementToRegistry(hashcode,element);
164         return(this);
165     }
166
167     /**
168         Adds an Element to the element.
169         @param hashcode name of element for hash table
170         @param element Adds an Element to the element.
171      */
172     public Body addElement(String JavaDoc hashcode,String JavaDoc element)
173     {
174         addElementToRegistry(hashcode,element);
175         return(this);
176     }
177
178     /**
179         Adds an Element to the element.
180         @param element Adds an Element to the element.
181      */
182     public Body addElement(Element element)
183     {
184         addElementToRegistry(element);
185         return(this);
186     }
187     /**
188         Adds an Element to the element.
189         @param element Adds an Element to the element.
190      */
191     public Body addElement(String JavaDoc element)
192     {
193         addElementToRegistry(element);
194         return(this);
195     }
196     /**
197         Removes an Element from the element.
198         @param hashcode the name of the element to be removed.
199     */
200     public Body removeElement(String JavaDoc hashcode)
201     {
202         removeElementFromRegistry(hashcode);
203         return(this);
204     }
205
206     /**
207         The onload event occurs when the user agent finishes loading a window
208         or all frames within a FRAMESET. This attribute may be used with BODY
209         and FRAMESET elements.
210         
211         @param The script
212     */
213     public void setOnLoad(String JavaDoc script)
214     {
215         addAttribute ( "onLoad", script );
216     }
217
218     /**
219         The onunload event occurs when the user agent removes a document from a
220         window or frame. This attribute may be used with BODY and FRAMESET
221         elements.
222         
223         @param The script
224     */
225     public void setOnUnload(String JavaDoc script)
226     {
227         addAttribute ( "onUnload", script );
228     }
229
230     /**
231         The onclick event occurs when the pointing device button is clicked
232         over an element. This attribute may be used with most elements.
233         
234         @param The script
235     */
236     public void setOnClick(String JavaDoc script)
237     {
238         addAttribute ( "onClick", script );
239     }
240     /**
241         The ondblclick event occurs when the pointing device button is double
242         clicked over an element. This attribute may be used with most elements.
243
244         @param The script
245     */
246     public void setOnDblClick(String JavaDoc script)
247     {
248         addAttribute ( "onDblClick", script );
249     }
250     /**
251         The onmousedown event occurs when the pointing device button is pressed
252         over an element. This attribute may be used with most elements.
253
254         @param The script
255     */
256     public void setOnMouseDown(String JavaDoc script)
257     {
258         addAttribute ( "onMouseDown", script );
259     }
260     /**
261         The onmouseup event occurs when the pointing device button is released
262         over an element. This attribute may be used with most elements.
263
264         @param The script
265     */
266     public void setOnMouseUp(String JavaDoc script)
267     {
268         addAttribute ( "onMouseUp", script );
269     }
270     /**
271         The onmouseover event occurs when the pointing device is moved onto an
272         element. This attribute may be used with most elements.
273
274         @param The script
275     */
276     public void setOnMouseOver(String JavaDoc script)
277     {
278         addAttribute ( "onMouseOver", script );
279     }
280     /**
281         The onmousemove event occurs when the pointing device is moved while it
282         is over an element. This attribute may be used with most elements.
283
284         @param The script
285     */
286     public void setOnMouseMove(String JavaDoc script)
287     {
288         addAttribute ( "onMouseMove", script );
289     }
290     /**
291         The onmouseout event occurs when the pointing device is moved away from
292         an element. This attribute may be used with most elements.
293
294         @param The script
295     */
296     public void setOnMouseOut(String JavaDoc script)
297     {
298         addAttribute ( "onMouseOut", script );
299     }
300
301     /**
302         The onkeypress event occurs when a key is pressed and released over an
303         element. This attribute may be used with most elements.
304         
305         @param The script
306     */
307     public void setOnKeyPress(String JavaDoc script)
308     {
309         addAttribute ( "onKeyPress", script );
310     }
311
312     /**
313         The onkeydown event occurs when a key is pressed down over an element.
314         This attribute may be used with most elements.
315         
316         @param The script
317     */
318     public void setOnKeyDown(String JavaDoc script)
319     {
320         addAttribute ( "onKeyDown", script );
321     }
322
323     /**
324         The onkeyup event occurs when a key is released over an element. This
325         attribute may be used with most elements.
326         
327         @param The script
328     */
329     public void setOnKeyUp(String JavaDoc script)
330     {
331         addAttribute ( "onKeyUp", script );
332     }
333 }
334
Popular Tags