KickJava   Java API By Example, From Geeks To Geeks.

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