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-2006 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.form;
043:
044: import org.openide.nodes.Node;
045:
046: /**
047: *
048: * @author Ian Formanek
049: */
050: public abstract class CodeGenerator {
051:
052: /**
053: * initializes a CodeGenerator for a given FormModel
054: * @param formModel a FormModel object
055: */
056: public abstract void initialize(FormModel formModel);
057:
058: /**
059: * Alows the code generator to provide synthetic properties for specified
060: * component which are specific to the code generation method. E.g. a
061: * JavaCodeGenerator will return variableName property, as it generates
062: * global Java variable for every component
063: * @param component The RADComponent for which the properties are to be
064: * obtained
065: * @return synthetic properties for the given component.
066: */
067: public Node.Property[] getSyntheticProperties(RADComponent component) {
068: return new Node.Property[0];
069: }
070:
071: /**
072: * Generates the specified event handler, if it does not exist yet.
073: * @param handlerName The name of the event handler
074: * @param paramTypes the list of event handler parameter types
075: * @param bodyText the body text of the event handler or null for default
076: *(empty) one
077: * @return true if the event handler have not existed yet and was creaated,
078: * false otherwise
079: */
080:
081: // public abstract boolean generateEventHandler(String handlerName,
082: // String[] paramTypes,
083: // String[] exceptTypes,
084: // String bodyText);
085: /**
086: * Changes the text of the specified event handler, if it already exists.
087: * @param handlerName The name of the event handler
088: * @param paramTypes the list of event handler parameter types
089: * @param bodyText the new body text of the event handler or null for default
090: *(empty) one
091: * @return true if the event handler existed and was modified, false
092: * otherwise
093: */
094:
095: // public abstract boolean changeEventHandler(final String handlerName,
096: // final String[] paramTypes,
097: // final String[] exceptTypes,
098: // final String bodyText);
099: /**
100: * Removes the specified event handler - removes the whole method together
101: * with the user code!
102: * @param handlerName The name of the event handler
103: */
104:
105: // public abstract boolean deleteEventHandler(String handlerName);
106: /**
107: * Renames the specified event handler to the given new name.
108: * @param oldHandlerName The old name of the event handler
109: * @param newHandlerName The new name of the event handler
110: * @param paramTypes the list of event handler parameter types
111: */
112:
113: // public abstract boolean renameEventHandler(String oldHandlerName,
114: // String newHandlerName,
115: // String[] exceptTypes,
116: // String[] paramTypes);
117: /**
118: * Gets the body (text) of event handler of given name.
119: * @param handlerName name of the event handler
120: * @return text of the event handler body
121: */
122:
123: // public abstract String getEventHandlerText(String handlerName);
124: /** Focuses the specified event handler in the editor. */
125:
126: // public abstract void gotoEventHandler(String handlerName);
127: /**
128: * Returns whether the specified event handler is empty (with no user
129: * code). Empty handlers can be deleted without user confirmation.
130: * @return true if the event handler exists and is empty
131: */
132: // public boolean isEventHandlerEmpty(String handlerName) {
133: // return false;
134: // }
135: }
|