KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > dom > events > EventImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999-2002 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 com.sun.org.apache.xerces.internal.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 /**
70  * @version $Id: EventImpl.java,v 1.8 2003/05/08 19:52:41 elena Exp $
71  */
72 public class EventImpl implements Event JavaDoc
73 {
74     public String JavaDoc type=null;
75     public EventTarget JavaDoc target;
76     public EventTarget JavaDoc currentTarget;
77     public short eventPhase;
78     public boolean initialized=false, bubbles=true, cancelable=false;
79     public boolean stopPropagation=false, preventDefault=false;
80      
81     protected long timeStamp = System.currentTimeMillis();
82
83     /** The DOM doesn't deal with constructors, so instead we have an
84         initializer call to set most of the read-only fields. The
85         others are set, and reset, by the event subsystem during dispatch.
86         <p>
87         Note that init() -- and the subclass-specific initWhatever() calls --
88         may be reinvoked. At least one initialization is required; repeated
89         initializations overwrite the event with new values of their
90         parameters.
91     */
92     public void initEvent(String JavaDoc eventTypeArg, boolean canBubbleArg,
93                         boolean cancelableArg)
94     {
95             type=eventTypeArg;
96             bubbles=canBubbleArg;
97             cancelable=cancelableArg;
98             
99             initialized=true;
100     }
101     
102     /** @return true iff this Event is of a class and type which supports
103         bubbling. In the generic case, this is True.
104         */
105     public boolean getBubbles()
106     {
107         return bubbles;
108     }
109
110     /** @return true iff this Event is of a class and type which (a) has a
111         Default Behavior in this DOM, and (b)allows cancellation (blocking)
112         of that behavior. In the generic case, this is False.
113         */
114     public boolean getCancelable()
115     {
116         return cancelable;
117     }
118
119     /** @return the Node (EventTarget) whose EventListeners are currently
120         being processed. During capture and bubble phases, this may not be
121         the target node. */
122     public EventTarget JavaDoc getCurrentTarget()
123     {
124         return currentTarget;
125     }
126
127     /** @return the current processing phase for this event --
128         CAPTURING_PHASE, AT_TARGET, BUBBLING_PHASE. (There may be
129         an internal DEFAULT_PHASE as well, but the users won't see it.) */
130     public short getEventPhase()
131     {
132         return eventPhase;
133     }
134
135     /** @return the EventTarget (Node) to which the event was originally
136         dispatched.
137         */
138     public EventTarget JavaDoc getTarget()
139     {
140         return target;
141     }
142
143     /** @return event name as a string
144     */
145     public String JavaDoc getType()
146     {
147         return type;
148     }
149
150     public long getTimeStamp() {
151     return timeStamp;
152     }
153
154     /** Causes exit from in-progress event dispatch before the next
155         currentTarget is selected. Replaces the preventBubble() and
156         preventCapture() methods which were present in early drafts;
157         they may be reintroduced in future levels of the DOM. */
158     public void stopPropagation()
159     {
160         stopPropagation=true;
161     }
162
163     /** Prevents any default processing built into the target node from
164         occurring.
165       */
166     public void preventDefault()
167     {
168         preventDefault=true;
169     }
170
171 }
172
Popular Tags