javauis/m2g_qt/javasrc/org/w3c/dom/events/EventTarget.java
author hgs
Fri, 15 Oct 2010 12:29:39 +0300
changeset 80 d6dafc5d983f
parent 56 abc41079b313
permissions -rw-r--r--
v2.2.19_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     1
/*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     3
* All rights reserved.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     8
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    11
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    12
* Contributors:
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    13
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    14
* Description:
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    15
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    16
*/
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    17
package org.w3c.dom.events;
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    18
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    19
import org.w3c.dom.DOMException;
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    20
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    21
/**
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    22
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    23
* This interface represents an event target, and is a subset of the EventTarget interface
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    24
* defined in the <a href="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/idl-definitions.html">
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    25
* DOM Level 2 Event model</a>.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    26
* <br>
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    27
* This interface is implemented by an object (SVGElements) that can notify listeners about events and allows
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    28
* registration and removal of {@link org.w3c.dom.events.EventListener EventListener} objects.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    29
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    30
*
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    31
*/
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    32
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    33
public interface EventTarget
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    34
{
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    35
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    36
    /**
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    37
     * This method registers the specified listener with the event target. If an EventListener is added to an EventTarget
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    38
     * while it is processing an event, it will not be triggered by the current actions. If multiple identical EventListeners
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    39
     * are registered on the same EventTarget with the same parameters the duplicate instances are discarded. They do not cause
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    40
     * the EventListener to be called twice and since they are discarded they do not need to be removed with the removeEventListener
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    41
     * method.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    42
     *
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    43
     * @param type The type of event to listen to.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    44
     * @param listener Will be notified when an event of the desired type happens on this target or one of its descendant.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    45
     * @param useCapture If true, the listener will be called during the event flow capture phase. Otherwise, the listener
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    46
     * will be called during the bubble phase. If the event's target is this target, then the listener will be called during the 'at target' phase of event flow.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    47
     *
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    48
     * @throws DOMException with error code NOT_SUPPORTED_ERR if useCapture is true since capture phase is not supported in SVG Tiny.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    49
     * @throws NullPointerException if <code>listener</code> is null.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    50
     * @throws NullPointerException if <code>type</code> is null.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    51
     */
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    52
    public void addEventListener(String type, EventListener listener, boolean useCapture);
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    53
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    54
    /**
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    55
     * This method removes the specified listener from the event target. If an EventListener is removed
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    56
     * from an EventTarget while it is processing an event, it will not be triggered by the current actions. Calling removeEventListener
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    57
     * with arguments which do not identify any currently registered EventListener on the EventTarget has no effect.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    58
     *
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    59
     * @param type The type of event that was listened to.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    60
     * @param listener The listener that was previously registered.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    61
     * @param useCapture If true, the listener was listening to events in the capture phase of event flow, otherwise the listener
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    62
     * was listening to events in the bubble phase.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    63
     *
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    64
     * @throws DOMException with error code NOT_SUPPORTED_ERR if useCapture is true since capture phase is not supported in SVG Tiny.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    65
     * @throws NullPointerException if <code>listener</code> is null.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    66
     * @throws NullPointerException if <code>type</code> is null.
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    67
     */
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    68
    public void removeEventListener(String type, EventListener listener, boolean useCapture);
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    69
abc41079b313 v2.2.7_1
hgs
parents:
diff changeset
    70
}