KickJava   Java API By Example, From Geeks To Geeks.

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


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;frameset&gt; tag.
64
65     @version $Id: frameset.java,v 1.2 2003/04/27 09:40:37 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 frameset extends MultiPartElement implements Printable, PageEvents
71 {
72     /**
73         Private initialization routine.
74     */
75     {
76         setElementType("frameset");
77         setCase(LOWERCASE);
78         setAttributeQuote(true);
79     }
80     
81     /**
82         Basic constructor.
83     */
84     public frameset()
85     {
86     }
87
88     /**
89         Basic constructor.
90         @param element Adds an Element to the element.
91     */
92     public frameset(Element element)
93     {
94         addElement(element);
95     }
96
97     /**
98         Basic constructor.
99         @param element Adds an Element to the element.
100     */
101     public frameset(String JavaDoc element)
102     {
103         addElement(element);
104     }
105
106     /**
107         Basic constructor.
108         @param rows Sets the rows="" attribute
109         @param cols Sets the cols="" attribute
110     */
111     public frameset(String JavaDoc rows, String JavaDoc cols)
112     {
113         setRows(rows);
114         setCols(cols);
115     }
116
117     /**
118         Basic constructor.
119         @param rows Sets the rows="" attribute
120         @param cols Sets the cols="" attribute
121         @param element Adds an Element to the element.
122     */
123     public frameset(String JavaDoc rows, String JavaDoc cols, Element element)
124     {
125         addElement(element);
126         setRows(rows);
127         setCols(cols);
128     }
129
130     /**
131         Basic constructor.
132         @param rows Sets the rows="" attribute
133         @param cols Sets the cols="" attribute
134         @param element Adds an Element to the element.
135     */
136     public frameset(String JavaDoc rows, String JavaDoc cols, String JavaDoc element)
137     {
138         addElement(element);
139         setRows(rows);
140         setCols(cols);
141     }
142
143     /**
144         Sets the rows="" attribute
145         @param rows Sets the rows="" attribute
146     */
147     public frameset setRows(int rows)
148     {
149         setRows(Integer.toString(rows));
150         return(this);
151     }
152
153     /**
154         Sets the rows="" attribute
155         @param rows Sets the rows="" attribute
156     */
157     public frameset setRows(String JavaDoc rows)
158     {
159         addAttribute("rows",rows);
160         return(this);
161     }
162
163     /**
164         Sets the cols="" attribute
165         @param cols Sets the cols="" attribute
166     */
167     public frameset setCols(int cols)
168     {
169         setCols(Integer.toString(cols));
170         return(this);
171     }
172
173     /**
174         Sets the cols="" attribute
175         @param cols Sets the cols="" attribute
176     */
177     public frameset setCols(String JavaDoc cols)
178     {
179         addAttribute("cols",cols);
180         return(this);
181     }
182
183     /**
184         Sets the lang="" and xml:lang="" attributes
185         @param lang the lang="" and xml:lang="" attributes
186     */
187     public Element setLang(String JavaDoc lang)
188     {
189         addAttribute("lang",lang);
190         addAttribute("xml:lang",lang);
191         return this;
192     }
193
194     /**
195         Adds an Element to the element.
196         @param hashcode name of element for hash table
197         @param element Adds an Element to the element.
198      */
199     public frameset addElement(String JavaDoc hashcode,Element element)
200     {
201         addElementToRegistry(hashcode,element);
202         return(this);
203     }
204
205     /**
206         Adds an Element to the element.
207         @param hashcode name of element for hash table
208         @param element Adds an Element to the element.
209      */
210     public frameset addElement(String JavaDoc hashcode,String JavaDoc element)
211     {
212         addElementToRegistry(hashcode,element);
213         return(this);
214     }
215     /**
216         Adds an Element to the element.
217         @param element Adds an Element to the element.
218      */
219     public frameset addElement(Element element)
220     {
221         addElementToRegistry(element);
222         return(this);
223     }
224
225     /**
226         Adds an Element to the element.
227         @param element Adds an Element to the element.
228      */
229     public frameset addElement(String JavaDoc element)
230     {
231         addElementToRegistry(element);
232         return(this);
233     }
234     /**
235         Removes an Element from the element.
236         @param hashcode the name of the element to be removed.
237     */
238     public frameset removeElement(String JavaDoc hashcode)
239     {
240         removeElementFromRegistry(hashcode);
241         return(this);
242     }
243
244     /**
245         The onload event occurs when the user agent finishes loading a window
246         or all frames within a frameset. This attribute may be used with body
247         and frameset elements.
248         
249         @param The script
250     */
251     public void setOnLoad(String JavaDoc script)
252     {
253         addAttribute ( "onload", script );
254     }
255
256     /**
257         The onunload event occurs when the user agent removes a document from a
258         window or frame. This attribute may be used with body and frameset
259         elements.
260         
261         @param The script
262     */
263     public void setOnUnload(String JavaDoc script)
264     {
265         addAttribute ( "onunload", script );
266     }
267 }
268
Popular Tags