KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > dom > events > EventImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57 package org.enhydra.apache.xerces.dom.events;
58
59 import org.w3c.dom.events.Event JavaDoc;
60 import org.w3c.dom.events.EventTarget JavaDoc;
61
62 /** EventImpl is an implementation of the basic "generic" DOM Level 2 Event
63     object. It may be subclassed by more specialized event sets.
64     Note that in our implementation, events are re-dispatchable (dispatch
65     clears the stopPropagation and preventDefault flags before it starts);
66     I believe that is the DOM's intent but I don't see an explicit statement
67     to this effect.
68 */
69 public class EventImpl implements Event JavaDoc
70 {
71     public String JavaDoc type=null;
72     public EventTarget JavaDoc target;
73     public EventTarget JavaDoc currentTarget;
74     public short eventPhase;
75     public boolean initialized=false, bubbles=true, cancelable=false;
76     public boolean stopPropagation=false, preventDefault=false;
77      
78     protected long timeStamp = System.currentTimeMillis();
79
80     /** The DOM doesn't deal with constructors, so instead we have an
81         initializer call to set most of the read-only fields. The
82         others are set, and reset, by the event subsystem during dispatch.
83         <p>
84         Note that init() -- and the subclass-specific initWhatever() calls --
85         may be reinvoked. At least one initialization is required; repeated
86         initializations overwrite the event with new values of their
87         parameters.
88     */
89     public void initEvent(String JavaDoc eventTypeArg, boolean canBubbleArg,
90                         boolean cancelableArg)
91     {
92             type=eventTypeArg;
93             bubbles=canBubbleArg;
94             cancelable=cancelableArg;
95             
96             initialized=true;
97     }
98     
99     /** @return true iff this Event is of a class and type which supports
100         bubbling. In the generic case, this is True.
101         */
102     public boolean getBubbles()
103     {
104         return bubbles;
105     }
106
107     /** @return true iff this Event is of a class and type which (a) has a
108         Default Behavior in this DOM, and (b)allows cancellation (blocking)
109         of that behavior. In the generic case, this is False.
110         */
111     public boolean getCancelable()
112     {
113         return cancelable;
114     }
115
116     /** @return the Node (EventTarget) whose EventListeners are currently
117         being processed. During capture and bubble phases, this may not be
118         the target node. */
119     public EventTarget JavaDoc getCurrentTarget()
120     {
121         return currentTarget;
122     }
123
124     /** @return the current processing phase for this event --
125         CAPTURING_PHASE, AT_TARGET, BUBBLING_PHASE. (There may be
126         an internal DEFAULT_PHASE as well, but the users won't see it.) */
127     public short getEventPhase()
128     {
129         return eventPhase;
130     }
131
132     /** @return the EventTarget (Node) to which the event was originally
133         dispatched.
134         */
135     public EventTarget JavaDoc getTarget()
136     {
137         return target;
138     }
139
140     /** @return event name as a string
141     */
142     public String JavaDoc getType()
143     {
144         return type;
145     }
146
147     public long getTimeStamp() {
148     return timeStamp;
149     }
150
151     /** Causes exit from in-progress event dispatch before the next
152         currentTarget is selected. Replaces the preventBubble() and
153         preventCapture() methods which were present in early drafts;
154         they may be reintroduced in future levels of the DOM. */
155     public void stopPropagation()
156     {
157         stopPropagation=true;
158     }
159
160     /** Prevents any default processing built into the target node from
161         occurring.
162       */
163     public void preventDefault()
164     {
165         preventDefault=true;
166     }
167
168 }
169
Popular Tags