KickJava   Java API By Example, From Geeks To Geeks.

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


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