001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.core.eventframework;
043:
044: public interface IEventDispatcher {
045: /**
046: * Registers an event sink to handle frameework events.
047: */
048: public void registerForEventFrameworkEvents(
049: IEventFrameworkEventsSink handler);
050:
051: /**
052: * Removes a sink listening for framework events.
053: */
054: public void revokeEventFrameworkSink(
055: IEventFrameworkEventsSink handler);
056:
057: /**
058: * Calling this method will result in the firing of any listeners who register for element modified events.
059: */
060: public boolean firePreEventContextPushed(IEventContext pContext,
061: IEventPayload payLoad);
062:
063: /**
064: * Calling this method will result in the firing of any listeners who register for element modified events.
065: */
066: public void fireEventContextPushed(IEventContext pContext,
067: IEventPayload payLoad);
068:
069: /**
070: * Fired before an event context is popped off the dispatcher.
071: */
072: public boolean firePreEventContextPopped(IEventContext pContext,
073: IEventPayload payLoad);
074:
075: /**
076: * Fired after an event context is popped off the dispatcher.
077: */
078: public void fireEventContextPopped(IEventContext pContext,
079: IEventPayload payLoad);
080:
081: /**
082: * Calling this method will result in the firing of any listeners who register for element modified events.
083: */
084: public void fireEventDispatchCancelled(Object[] pListeners,
085: Object listenerWhoCancelled, IEventPayload payLoad);
086:
087: /**
088: * Makes the EventContext of the passed in name the current EventContext.
089: */
090: public void pushEventContext(String pContext);
091:
092: /**
093: * Makes the EventContext of the passed in name the current EventContext.
094: */
095: public IEventContext pushEventContext2(String context);
096:
097: /**
098: * Pushes the passed in EventContext onto this dispatcher.
099: */
100: public void pushEventContext3(IEventContext pContext);
101:
102: /**
103: * Pops the current context off the stack.
104: */
105: public void popEventContext();
106:
107: /**
108: * Pops the current context off the stack, returning it.
109: */
110: public IEventContext popEventContext2();
111:
112: /**
113: * Retrieves the current context on this dispatcher.
114: */
115: public IEventContext getCurrentContext();
116:
117: /**
118: * Retrieves the name of the current context on this dispatcher.
119: */
120: public String getCurrentContextName();
121:
122: /**
123: * Removes any EventContext with the passed in name, regardless of position in the stack.
124: */
125: public void removeEventContextByName(String name);
126:
127: /**
128: * Removes any EventContext that contains in IEventFilter matching the passed in ID, regardless of stack position.
129: */
130: public void removeEventContextByFilterID(String filterID);
131:
132: /**
133: * Creates a specific payload depending on the name of the trigger passed in.
134: */
135: public IEventPayload createPayload(String triggerName);
136:
137: /**
138: * Sets / Gets the flag that determines whether or not any event should be fired.
139: */
140: public boolean getPreventAllEvents();
141:
142: /**
143: * Sets / Gets the flag that determines whether or not any event should be fired.
144: */
145: public void setPreventAllEvents(boolean value);
146:
147: /**
148: * Returns the number of sinks registered to this dispatcher
149: */
150: public int getNumRegisteredSinks();
151:
152: }
|