KickJava   Java API By Example, From Geeks To Geeks.

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


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 an param Element
64
65     @version $Id: param.java,v 1.2 2003/04/27 09:38:05 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 param extends SinglePartElement implements Printable
71 {
72     // Convience variables.
73
74     public final static String JavaDoc ref = "ref";
75     public final static String JavaDoc data = "data";
76     public final static String JavaDoc object = "object";
77
78     /**
79         private initializer.
80     */
81     {
82         setElementType("param");
83         setCase(LOWERCASE);
84         setAttributeQuote(true);
85         setBeginEndModifier('/');
86     }
87
88     /**
89         Default constructor. use set* methods.
90     */
91     public param()
92     {
93     }
94
95     /**
96         Sets the name of this parameter.
97         @param name sets the name of this parameter.
98     */
99     public param setName(String JavaDoc name)
100     {
101         addAttribute("name",name);
102         return(this);
103     }
104
105     /**
106         Sets the value of this attribute.
107         @param value sets the value attribute.
108     */
109     public param setValue(String JavaDoc value)
110     {
111         addAttribute("value",value);
112         return(this);
113     }
114
115     /**
116         Sets the valuetype of this parameter.
117         @param valuetype sets the name of this parameter.<br>
118         ref|data|object convience varaibles provided as param.ref,param.data,param.object
119     */
120     public param setValueType(String JavaDoc valuetype)
121     {
122         addAttribute("value",valuetype);
123         return(this);
124     }
125
126     /**
127         Sets the mime type of this object
128         @param the mime type of this object
129     */
130     public param setType(String JavaDoc cdata)
131     {
132         addAttribute("type",cdata);
133         return(this);
134     }
135
136     /**
137         Sets the lang="" and xml:lang="" attributes
138         @param lang the lang="" and xml:lang="" attributes
139     */
140     public Element setLang(String JavaDoc lang)
141     {
142         addAttribute("lang",lang);
143         addAttribute("xml:lang",lang);
144         return this;
145     }
146
147     /**
148         Adds an Element to the element.
149         @param hashcode name of element for hash table
150         @param element Adds an Element to the element.
151      */
152     public param addElement(String JavaDoc hashcode,Element element)
153     {
154         addElementToRegistry(hashcode,element);
155         return(this);
156     }
157
158     /**
159         Adds an Element to the element.
160         @param hashcode name of element for hash table
161         @param element Adds an Element to the element.
162      */
163     public param addElement(String JavaDoc hashcode,String JavaDoc element)
164     {
165         addElementToRegistry(hashcode,element);
166         return(this);
167     }
168
169     /**
170         Adds an Element to the element.
171         @param element Adds an Element to the element.
172      */
173     public param addElement(Element element)
174     {
175         addElementToRegistry(element);
176         return(this);
177     }
178
179     /**
180         Adds an Element to the element.
181         @param element Adds an Element to the element.
182      */
183     public param addElement(String JavaDoc element)
184     {
185         addElementToRegistry(element);
186         return(this);
187     }
188     /**
189         Removes an Element from the element.
190         @param hashcode the name of the element to be removed.
191     */
192     public param removeElement(String JavaDoc hashcode)
193     {
194         removeElementFromRegistry(hashcode);
195         return(this);
196     }
197 }
198
Popular Tags