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: import org.netbeans.modules.uml.core.coreapplication.ICoreProduct;
045: import org.netbeans.modules.uml.core.support.umlsupport.ProductRetriever;
046:
047: public class EventDispatchHelper implements IEventDispatchHelper
048:
049: {
050: protected IEventDispatcher m_dispatcher;
051:
052: public EventDispatchHelper() {
053: }
054:
055: public IEventDispatcher getEventDispatcher() {
056: return m_dispatcher;
057: }
058:
059: public void setEventDispatcher(IEventDispatcher value) {
060: m_dispatcher = value;
061: }
062:
063: /**
064: *
065: * Creates a payload given the passed in trigger name.
066: *
067: * @param triggerName[in] Name of the trigger whose payload we are creating
068: * @param payload[out] The created payload. Can be 0
069: *
070: * @return S_OK, else EFR_S_EVENTDISPATCHER_NOT_INITIALIZED if the m_Dispatcher member
071: * has not been properly initialized.
072: *
073: */
074: protected IEventPayload preparePayload(String triggerName) {
075: IEventPayload payload = null;
076: if (m_dispatcher != null) {
077: payload = m_dispatcher.createPayload(triggerName);
078: }
079: return payload;
080: }
081:
082: /**
083: *
084: * Retrieves a particular dispatcher.
085: *
086: * @param name[in] The name of the dispatcher to retrieve
087: * @param disp[out] The found dispatcher
088: *
089: * @return HRESULT
090: *
091: */
092: protected IEventDispatcher retrieveDispatcher(String name) {
093: IEventDispatcher disp = null;
094: ICoreProduct prod = ProductRetriever.retrieveProduct();
095: if (prod != null) {
096: IEventDispatchController cont = prod
097: .getEventDispatchController();
098: if (cont != null) {
099: disp = cont.retrieveDispatcher(name);
100: }
101: }
102: return disp;
103: }
104:
105: }
|