KickJava   Java API By Example, From Geeks To Geeks.

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


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;colgroup&gt; object.
64
65     @version $Id: colgroup.java,v 1.2 2003/04/27 09:40:47 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 colgroup extends MultiPartElement implements Printable
71 {
72     /**
73         private initializer.
74     */
75     {
76         setElementType("colgroup");
77         setCase(LOWERCASE);
78         setAttributeQuote(true);
79     }
80     public colgroup()
81     {
82     }
83
84     /**
85         Sets the span="" attribute.
86         @param span sets the span="" attribute.
87     */
88     public colgroup setSpan(String JavaDoc span)
89     {
90         addAttribute("span",span);
91         return(this);
92     }
93
94     /**
95         Sets the span="" attribute.
96         @param span sets the span="" attribute.
97     */
98     public colgroup setSpan(int span)
99     {
100         addAttribute("span",Integer.toString(span));
101         return(this);
102     }
103
104     /**
105         Supplies user agents with a recommended cell width. (Pixel Values)
106         @param width how many pixels to make cell
107     */
108     public colgroup setWidth(int width)
109     {
110         addAttribute("width",Integer.toString(width));
111         return(this);
112     }
113     
114     /**
115         Supplies user agents with a recommended cell width. (Pixel Values)
116         @param width how many pixels to make cell
117     */
118     public colgroup setWidth(String JavaDoc width)
119     {
120         addAttribute("width",width);
121         return(this);
122     }
123
124     /**
125         Sets the align="" attribute convience variables are provided in the AlignType interface
126         @param align Sets the align="" attribute
127     */
128     public colgroup setAlign(String JavaDoc align)
129     {
130         addAttribute("align",align);
131         return(this);
132     }
133
134     /**
135         Sets the valign="" attribute convience variables are provided in the AlignType interface
136         @param valign Sets the valign="" attribute
137     */
138     public colgroup setVAlign(String JavaDoc valign)
139     {
140         addAttribute("valign",valign);
141         return(this);
142     }
143
144     /**
145         Sets the char="" attribute.
146         @param character the character to use for alignment.
147     */
148     public colgroup setChar(String JavaDoc character)
149     {
150         addAttribute("char",character);
151         return(this);
152     }
153
154     /**
155         Sets the charoff="" attribute.
156         @param char_off When present this attribute specifies the offset
157         of the first occurrence of the alignment character on each line.
158     */
159     public colgroup setCharOff(int char_off)
160     {
161         addAttribute("charoff",Integer.toString(char_off));
162         return(this);
163     }
164
165     /**
166         Sets the charoff="" attribute.
167         @param char_off When present this attribute specifies the offset
168         of the first occurrence of the alignment character on each line.
169     */
170     public colgroup setCharOff(String JavaDoc char_off)
171     {
172         addAttribute("charoff",char_off);
173         return(this);
174     }
175     
176     /**
177         Sets the lang="" and xml:lang="" attributes
178         @param lang the lang="" and xml:lang="" attributes
179     */
180     public Element setLang(String JavaDoc lang)
181     {
182         addAttribute("lang",lang);
183         addAttribute("xml:lang",lang);
184         return this;
185     }
186
187     /**
188         Adds an Element to the element.
189         @param hashcode name of element for hash table
190         @param element Adds an Element to the element.
191      */
192     public colgroup addElement(String JavaDoc hashcode,Element element)
193     {
194         addElementToRegistry(hashcode,element);
195         return(this);
196     }
197
198     /**
199         Adds an Element to the element.
200         @param hashcode name of element for hash table
201         @param element Adds an Element to the element.
202      */
203     public colgroup addElement(String JavaDoc hashcode,String JavaDoc element)
204     {
205         addElementToRegistry(hashcode,element);
206         return(this);
207     }
208     /**
209         Adds an Element to the element.
210         @param element Adds an Element to the element.
211      */
212     public colgroup addElement(Element element)
213     {
214         addElementToRegistry(element);
215         return(this);
216     }
217
218     /**
219         Adds an Element to the element.
220         @param element Adds an Element to the element.
221      */
222     public colgroup addElement(String JavaDoc element)
223     {
224         addElementToRegistry(element);
225         return(this);
226     }
227     /**
228         Removes an Element from the element.
229         @param hashcode the name of the element to be removed.
230     */
231     public colgroup removeElement(String JavaDoc hashcode)
232     {
233         removeElementFromRegistry(hashcode);
234         return(this);
235     }
236 }
237
Popular Tags