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 com.sun.rave.designtime;
043:
044: /**
045: * <p>A DesignEvent represents a single event listener method (and possibly handler) on a single
046: * instance of a DesignBean at design-time.</p>
047: *
048: * <P><B>IMPLEMENTED BY CREATOR</B> - This interface is implemented by Creator for use by the
049: * component (bean) author.</P>
050: *
051: * @author Joe Nuxoll
052: * @version 1.0
053: */
054: public interface DesignEvent {
055:
056: /**
057: * Returns the EventDescriptor that defines the meta-data for this DesignEvent
058: *
059: * @return The EventDescriptor that defines teh meta-data for this DesignEvent
060: */
061: public EventDescriptor getEventDescriptor();
062:
063: /**
064: * Returns the DesignBean that owns this DesignEvent
065: *
066: * @return the DesignBean that owns this DesignEvent
067: */
068: public DesignBean getDesignBean();
069:
070: /**
071: * Returns the default event handler method name. For example on a Button component's 'click'
072: * event, the default handler name might be "button1_click".
073: *
074: * @return the default event handler method name, same as setHandlerName would use if passed null
075: */
076: public String getDefaultHandlerName();
077:
078: /**
079: * Sets the method name for this DesignEvent. If the event is not currently 'hooked', this will
080: * 'hook' it and add the required wiring to direct the event handler code to this method name.
081: * If 'null' is passed as the handlerName, then the default event handler method name will be
082: * used.
083: *
084: * @param handlerMethodName The desired event handler method name - may be null to use default
085: * event handler method name
086: * @return <code>true</code> if the event was successfully 'hooked', and the specified name was unique
087: */
088: public boolean setHandlerName(String handlerMethodName);
089:
090: /**
091: * Returns the current event method handler name, or null if the event is currently not 'hooked'
092: *
093: * @return the current event method handler name, or null if the event is currently not 'hooked'
094: */
095: public String getHandlerName();
096:
097: /**
098: * Returns <code>true</code> if this DesignEvent is currently 'hooked', or <code>false</code>
099: * if it is not.
100: *
101: * @return <code>true</code> if this DesignEvent is currently 'hooked', or <code>false</code>
102: * if it is not
103: */
104: public boolean isHandled();
105:
106: /**
107: * Removes and unwires an event handler method from this DesignEvent, if one exists. Returns
108: * <code>true</code> if successful, <code>false</code> if not.
109: *
110: * @return <code>true</code> if successful, <code>false</code> if not
111: */
112: public boolean removeHandler();
113:
114: /**
115: * Sets the Java source for the method body of the handler method. This is expected to be valid
116: * Java source to be injected into the body of this event handler method. If it is not, an
117: * IllegalArgumentException is thrown.
118: *
119: * @param methodBody The Java source for the method body of this event handler method
120: * @throws IllegalArgumentException thrown if the Java source is invalid
121: */
122: public void setHandlerMethodSource(String methodBody)
123: throws IllegalArgumentException;
124:
125: /**
126: * Returns the Java source code from the body of the handler method
127: *
128: * @return the Java source code from the body of the handler method
129: */
130: public String getHandlerMethodSource();
131: }
|