001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package com.sun.perseus.model;
028:
029: import org.w3c.dom.events.Event;
030: import org.w3c.dom.events.EventTarget;
031:
032: /**
033: * Events happen on a specific target and have a specific type.
034: *
035: * @see EventListener
036: * @see EventSupport
037: *
038: * @version $Id: ModelEvent.java,v 1.5 2006/06/29 10:47:33 ln156897 Exp $
039: */
040: public class ModelEvent implements Event {
041: /**
042: * Used when for undefined key char events
043: */
044: public static final char CHAR_UNDEFINED = 0xFFFF;
045:
046: /**
047: * The event's type
048: */
049: protected String type;
050:
051: /**
052: * The event target
053: */
054: protected ModelNode target;
055:
056: /**
057: * The current event target.
058: */
059: protected EventTarget currentTarget;
060:
061: /**
062: * The event's anchor is used to ease the implementation
063: * of hyperlinking.
064: *
065: * @see EventSupport
066: */
067: protected Anchor anchor;
068:
069: /**
070: * Controls whether or not the event's dispatch
071: * should be stopped
072: */
073: protected boolean stopPropagation;
074:
075: /**
076: * Time stamp. The time is in document simple time, i.e., in the
077: * root container's time.
078: */
079: protected Time eventTime = Time.UNRESOLVED;
080:
081: /**
082: * Used to provide the repeat iteration in a repeat event
083: */
084: protected int repeatCount = 0;
085:
086: /**
087: * Used to provide the key character in a key event
088: */
089: protected char keyChar = CHAR_UNDEFINED;
090:
091: /**
092: * @param type the event's type. Should not be null.
093: * @param target the event's target. Should not be null.
094: */
095: public ModelEvent(final String type, final ModelNode target) {
096: if (type == null) {
097: throw new NullPointerException();
098: }
099:
100: this .type = type;
101:
102: if (target == null) {
103: throw new NullPointerException();
104: }
105:
106: this .target = target;
107:
108: // Set the event time.
109: this .eventTime = target.ownerDocument.timeContainerRootSupport
110: .getCurrentTime();
111: }
112:
113: /**
114: * @param type the event's type. Should not be null
115: * @param target the event's target. Should not be null.
116: * @param keyChar the event's character key
117: */
118: public ModelEvent(final String type, final ModelNode target,
119: final char keyChar) {
120: this (type, target);
121: this .keyChar = keyChar;
122: }
123:
124: /**
125: * @return this event's type
126: */
127: public String getType() {
128: return type;
129: }
130:
131: /**
132: * @return the key that was stroked.
133: */
134: public char getKeyChar() {
135: return keyChar;
136: }
137:
138: /**
139: * @return this node's target
140: */
141: public EventTarget getTarget() {
142: return target;
143: }
144:
145: /**
146: * @return this node's current target
147: */
148: public EventTarget getCurrentTarget() {
149: return currentTarget;
150: }
151:
152: /**
153: * Stops propagation of the Event during dispatch. See the
154: * DOM Level 2 Event model specification for details.
155: */
156: public void stopPropagation() {
157: stopPropagation = true;
158: }
159:
160: /**
161: * @return true if propagation should stop. false otherwise
162: */
163: public boolean getStopPropagation() {
164: return stopPropagation;
165: }
166:
167: /**
168: * @param anchor the Event's associated Anchor
169: * @throws IllegalStateException if the anchor property is not null
170: */
171: public void setAnchor(final Anchor anchor) {
172: if (this .anchor == null) {
173: this .anchor = anchor;
174: } else {
175: throw new IllegalStateException();
176: }
177: }
178:
179: /**
180: * @return the current value of the anchor property
181: */
182: public Anchor getAnchor() {
183: return anchor;
184: }
185: }
|