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: package org.netbeans.modules.compapp.projects.jbi.api;
042:
043: import org.netbeans.api.project.Project;
044: import java.util.List;
045: import java.awt.*;
046:
047: /**
048: * Service Provider Interface for internal JBI projects.
049: * Port types are generic.
050: *
051: * This interface is still being defined and may change at any moment.
052: *
053: * @author jsandusky
054: */
055: public interface InternalProjectTypePlugin {
056:
057: /**
058: * Name for this JBI project type.
059: * @return display name
060: */
061: String getPluginName();
062:
063: /**
064: * Resource path to the icon that corresponds to this JBI project type.
065: * @return icon
066: */
067: String getIconFileBase();
068:
069: /**
070: * Category name for the JBI project type.
071: * JBI project types that correspond to the same category name will be
072: * grouped together (i.e. for example, on a palette).
073: *
074: * use null, if it should not be added into any category
075: *
076: * @return category name
077: */
078: String getCategoryName();
079:
080: /**
081: * Obtains the WizardIterator that can show a new project
082: * wizard to the user (if necessary), and then create the project.
083: * @return the wizard iterator
084: */
085: InternalProjectTypePluginWizardIterator getWizardIterator();
086:
087: /**
088: * Opens whatever editor that corresponds to the JBI project type.
089: * The user may need to rebuild the composite application project in order
090: * for any external edits to be applied.
091: * @param project the project object to open an editor for
092: */
093: void openEditor(Project project);
094:
095: // 11/08/07, extension for generic plug-in projects, e.g., ear-link
096:
097: /**
098: * Return the JBI target component name of this project type.
099: *
100: * @return the name of SU target
101: */
102: String getJbiTargetName();
103:
104: /**
105: * get the list of action performer from the plug-in project type
106: *
107: * @return a list of action performer
108: */
109: List<JbiProjectActionPerformer> getProjectActions();
110:
111: /**
112: * can a project be created to represent this source object?
113: *
114: * @param source the source object
115: * @return true if the object is associated with the project type
116: */
117: boolean isAcceptableProjectSource(Object source);
118:
119: /**
120: * Has project properties customizer
121: *
122: * @return true if has project properties customizer
123: */
124: boolean hasCustomizer();
125:
126: /**
127: * Get the project properties customizer
128: *
129: * @param project the project instance
130: * @return the project properties customizer
131: */
132: Component getCustomizer(Project project);
133: }
|