KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > html > Map


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;MAP&gt; tag.
64
65     @version $Id: Map.java,v 1.4 2003/04/27 09:22:57 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 Map extends MultiPartElement implements Printable, FocusEvents, MouseEvents, KeyEvents
70 {
71     /**
72         Private initialization routine.
73     */
74     {
75         setElementType("map");
76     }
77     /**
78         Basic constructor.
79     */
80     public Map()
81     {
82     }
83
84     /**
85         Basic constructor.
86         @param element Adds an Element to the element.
87     */
88     public Map(Element element)
89     {
90         addElement(element);
91     }
92
93     /**
94         Basic constructor.
95         @param element Adds an Element to the element.
96     */
97     public Map(String JavaDoc element)
98     {
99         addElement(element);
100     }
101
102     /**
103         Basic constructor.
104         @param element Adds an Element to the element.
105         @param name sets the NAME="" attribute
106     */
107     public Map(Element element, String JavaDoc name)
108     {
109         addElement(element);
110         setName ( name );
111     }
112
113     /**
114         Basic constructor.
115         @param element Adds an Element to the element.
116         @param name sets the NAME="" attribute
117     */
118     public Map(String JavaDoc element, String JavaDoc name)
119     {
120         addElement(element);
121         setName ( name );
122     }
123
124     /**
125         Sets the NAME="" attribute
126         @param name the NAME="" attribute
127     */
128     public Map setName(String JavaDoc name)
129     {
130         addAttribute("name",name);
131         return this;
132     }
133
134     /**
135         Adds an Element to the element.
136         @param hashcode name of element for hash table
137         @param element Adds an Element to the element.
138      */
139     public Map addElement(String JavaDoc hashcode,Element element)
140     {
141         addElementToRegistry(hashcode,element);
142         return(this);
143     }
144
145     /**
146         Adds an Element to the element.
147         @param hashcode name of element for hash table
148         @param element Adds an Element to the element.
149      */
150     public Map addElement(String JavaDoc hashcode,String JavaDoc element)
151     {
152         addElementToRegistry(hashcode,element);
153         return(this);
154     }
155
156     /**
157         Adds an Element to the element.
158         @param element Adds an Element to the element.
159      */
160     public Map addElement(Element element)
161     {
162         addElementToRegistry(element);
163         return(this);
164     }
165
166     /**
167         Adds an Element to the element.
168         @param element Adds an Element to the element.
169      */
170     public Map addElement(String JavaDoc element)
171     {
172         addElementToRegistry(element);
173         return(this);
174     }
175     /**
176         Removes an Element from the element.
177         @param hashcode the name of the element to be removed.
178     */
179     public Map removeElement(String JavaDoc hashcode)
180     {
181         removeElementFromRegistry(hashcode);
182         return(this);
183     }
184
185     /**
186         The onfocus event occurs when an element receives focus either by the
187         pointing device or by tabbing navigation. This attribute may be used
188         with the following elements: LABEL, INPUT, SELECT, TEXTAREA, and
189         BUTTON.
190         
191         @param The script
192     */
193     public void setOnFocus(String JavaDoc script)
194     {
195         addAttribute ( "onFocus", script );
196     }
197
198     /**
199         The onblur event occurs when an element loses focus either by the
200         pointing device or by tabbing navigation. It may be used with the same
201         elements as onfocus.
202         
203         @param The script
204     */
205     public void setOnBlur(String JavaDoc script)
206     {
207         addAttribute ( "onBlur", script );
208     }
209
210     /**
211         The onclick event occurs when the pointing device button is clicked
212         over an element. This attribute may be used with most elements.
213         
214         @param The script
215     */
216     public void setOnClick(String JavaDoc script)
217     {
218         addAttribute ( "onClick", script );
219     }
220     /**
221         The ondblclick event occurs when the pointing device button is double
222         clicked over an element. This attribute may be used with most elements.
223
224         @param The script
225     */
226     public void setOnDblClick(String JavaDoc script)
227     {
228         addAttribute ( "onDblClick", script );
229     }
230     /**
231         The onmousedown event occurs when the pointing device button is pressed
232         over an element. This attribute may be used with most elements.
233
234         @param The script
235     */
236     public void setOnMouseDown(String JavaDoc script)
237     {
238         addAttribute ( "onMouseDown", script );
239     }
240     /**
241         The onmouseup event occurs when the pointing device button is released
242         over an element. This attribute may be used with most elements.
243
244         @param The script
245     */
246     public void setOnMouseUp(String JavaDoc script)
247     {
248         addAttribute ( "onMouseUp", script );
249     }
250     /**
251         The onmouseover event occurs when the pointing device is moved onto an
252         element. This attribute may be used with most elements.
253
254         @param The script
255     */
256     public void setOnMouseOver(String JavaDoc script)
257     {
258         addAttribute ( "onMouseOver", script );
259     }
260     /**
261         The onmousemove event occurs when the pointing device is moved while it
262         is over an element. This attribute may be used with most elements.
263
264         @param The script
265     */
266     public void setOnMouseMove(String JavaDoc script)
267     {
268         addAttribute ( "onMouseMove", script );
269     }
270     /**
271         The onmouseout event occurs when the pointing device is moved away from
272         an element. This attribute may be used with most elements.
273
274         @param The script
275     */
276     public void setOnMouseOut(String JavaDoc script)
277     {
278         addAttribute ( "onMouseOut", script );
279     }
280
281     /**
282         The onkeypress event occurs when a key is pressed and released over an
283         element. This attribute may be used with most elements.
284         
285         @param The script
286     */
287     public void setOnKeyPress(String JavaDoc script)
288     {
289         addAttribute ( "onKeyPress", script );
290     }
291
292     /**
293         The onkeydown event occurs when a key is pressed down over an element.
294         This attribute may be used with most elements.
295         
296         @param The script
297     */
298     public void setOnKeyDown(String JavaDoc script)
299     {
300         addAttribute ( "onKeyDown", script );
301     }
302
303     /**
304         The onkeyup event occurs when a key is released over an element. This
305         attribute may be used with most elements.
306         
307         @param The script
308     */
309     public void setOnKeyUp(String JavaDoc script)
310     {
311         addAttribute ( "onKeyUp", script );
312     }
313 }
314
Popular Tags