KickJava   Java API By Example, From Geeks To Geeks.

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


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;ins&gt; tag.
64
65     @version $Id: ins.java,v 1.2 2003/04/27 09:39:23 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 ins extends MultiPartElement implements Printable, MouseEvents, KeyEvents
71 {
72     /**
73         Private initializer.
74     */
75     {
76         setElementType("ins");
77         setCase(LOWERCASE);
78         setAttributeQuote(true);
79     }
80
81     /**
82         Default constructor use set* methods.
83     */
84     public ins()
85     {
86     }
87
88     /**
89         Set the url that designates a source doument or message.
90         @param url set the url that designates a source document or message.
91     */
92     public ins setCite(String JavaDoc url)
93     {
94         addAttribute("cite",url);
95         return(this);
96     }
97
98     /**
99         Sets the date and time the change was made.
100         @param datetime the date and time the change was made.
101     */
102     public ins setDateTime(String JavaDoc datetime)
103     {
104         addAttribute("datetime",datetime);
105         return(this);
106     }
107
108     /**
109         Sets the lang="" and xml:lang="" attributes
110         @param lang the lang="" and xml:lang="" attributes
111     */
112     public Element setLang(String JavaDoc lang)
113     {
114         addAttribute("lang",lang);
115         addAttribute("xml:lang",lang);
116         return this;
117     }
118
119     /**
120         Adds an Element to the element.
121         @param hashcode name of element for hash table
122         @param element Adds an Element to the element.
123      */
124     public ins addElement(String JavaDoc hashcode,Element element)
125     {
126         addElementToRegistry(hashcode,element);
127         return(this);
128     }
129
130     /**
131         Adds an Element to the element.
132         @param hashcode name of element for hash table
133         @param element Adds an Element to the element.
134      */
135     public ins addElement(String JavaDoc hashcode,String JavaDoc element)
136     {
137         addElementToRegistry(hashcode,element);
138         return(this);
139     }
140
141     /**
142         Adds an Element to the element.
143         @param element Adds an Element to the element.
144     */
145     public ins addElement(Element element)
146     {
147         addElementToRegistry(element);
148         return(this);
149     }
150
151     /**
152         Adds an Element to the element.
153         @param element Adds an Element to the element.
154     */
155     public ins addElement(String JavaDoc element)
156     {
157         addElementToRegistry(element);
158         return(this);
159     }
160     /**
161         Removes an Element from the element.
162         @param hashcode the name of the element to be removed.
163     */
164     public ins removeElement(String JavaDoc hashcode)
165     {
166         removeElementFromRegistry(hashcode);
167         return(this);
168     }
169
170     /**
171         The onclick event occurs when the pointing device button is clicked
172         over an element. This attribute may be used with most elements.
173         
174         @param The script
175     */
176     public void setOnClick(String JavaDoc script)
177     {
178         addAttribute ( "onclick", script );
179     }
180     /**
181         The ondblclick event occurs when the pointing device button is double
182         clicked over an element. This attribute may be used with most elements.
183
184         @param The script
185     */
186     public void setOnDblClick(String JavaDoc script)
187     {
188         addAttribute ( "ondblclick", script );
189     }
190     /**
191         The onmousedown event occurs when the pointing device button is pressed
192         over an element. This attribute may be used with most elements.
193
194         @param The script
195     */
196     public void setOnMouseDown(String JavaDoc script)
197     {
198         addAttribute ( "onmousedown", script );
199     }
200     /**
201         The onmouseup event occurs when the pointing device button is released
202         over an element. This attribute may be used with most elements.
203
204         @param The script
205     */
206     public void setOnMouseUp(String JavaDoc script)
207     {
208         addAttribute ( "onmouseup", script );
209     }
210     /**
211         The onmouseover event occurs when the pointing device is moved onto an
212         element. This attribute may be used with most elements.
213
214         @param The script
215     */
216     public void setOnMouseOver(String JavaDoc script)
217     {
218         addAttribute ( "onmouseover", script );
219     }
220     /**
221         The onmousemove event occurs when the pointing device is moved while it
222         is over an element. This attribute may be used with most elements.
223
224         @param The script
225     */
226     public void setOnMouseMove(String JavaDoc script)
227     {
228         addAttribute ( "onmousemove", script );
229     }
230     /**
231         The onmouseout event occurs when the pointing device is moved away from
232         an element. This attribute may be used with most elements.
233
234         @param The script
235     */
236     public void setOnMouseOut(String JavaDoc script)
237     {
238         addAttribute ( "onmouseout", script );
239     }
240
241     /**
242         The onkeypress event occurs when a key is pressed and released over an
243         element. This attribute may be used with most elements.
244         
245         @param The script
246     */
247     public void setOnKeyPress(String JavaDoc script)
248     {
249         addAttribute ( "onkeypress", script );
250     }
251
252     /**
253         The onkeydown event occurs when a key is pressed down over an element.
254         This attribute may be used with most elements.
255         
256         @param The script
257     */
258     public void setOnKeyDown(String JavaDoc script)
259     {
260         addAttribute ( "onkeydown", script );
261     }
262
263     /**
264         The onkeyup event occurs when a key is released over an element. This
265         attribute may be used with most elements.
266         
267         @param The script
268     */
269     public void setOnKeyUp(String JavaDoc script)
270     {
271         addAttribute ( "onkeyup", script );
272     }
273 }
274
Popular Tags