Source code

001/*
002 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.event;
027
028// PENDING_DOC_REVIEW
029/**
030 * Represents an event target.
031 */
032public interface EventTarget {
033    /**
034     * Construct an event dispatch chain for this target. The event dispatch
035     * chain contains event dispatchers which might be interested in processing
036     * of events targeted at this {@code EventTarget}. This event target is
037     * not automatically added to the chain, so if it wants to process events,
038     * it needs to add an {@code EventDispatcher} for itself to the chain.
039     * <p>
040     * In the case the event target is part of some hierarchy, the chain for it
041     * is usually built from event dispatchers collected from the root of the
042     * hierarchy to the event target.
043     * <p>
044     * The event dispatch chain is constructed by modifications to the provided
045     * initial event dispatch chain. The returned chain should have the initial
046     * chain at its end so the dispatchers should be prepended to the initial
047     * chain.
048     * <p>
049     * The caller shouldn't assume that the initial chain remains unchanged nor
050     * that the returned value will reference a different chain.
051     *
052     * @param tail the initial chain to build from
053     * @return the resulting event dispatch chain for this target
054     */
055    EventDispatchChain buildEventDispatchChain(EventDispatchChain tail);
056}