KickJava   Java API By Example, From Geeks To Geeks.

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