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.visualweb.complib.api;
043:
044: import java.io.File;
045: import java.util.List;
046:
047: import org.netbeans.api.project.Project;
048: import org.netbeans.spi.palette.PaletteActions;
049: import org.netbeans.spi.palette.PaletteFilter;
050: import org.openide.nodes.Node;
051:
052: /**
053: * Complib service.
054: *
055: * @author Edwin Goei
056: */
057: public interface ComplibService {
058:
059: /**
060: * Creates complib <code>PaletteFilter</code> for specified <code>Project</code>.
061: *
062: * @param project
063: * @return
064: */
065: public PaletteFilter createComplibPaletteFilter(Project project);
066:
067: /**
068: * Creates PaletteActions to add custom items on the palette UI
069: *
070: * @return
071: */
072: public PaletteActions createComplibPaletteActions();
073:
074: /**
075: * Add a listener for Complib events
076: *
077: * @param listener
078: */
079: public void addComplibListener(ComplibListener listener);
080:
081: /**
082: * Remove a listener for Complib events
083: *
084: * @param listener
085: */
086: public void removeComplibListener(ComplibListener listener);
087:
088: /**
089: * Return a root node to represent the complibs for a project. For example in the project
090: * navigator, this root node represents all the complibs in a project with each child node
091: * corresponding to an embedded complib in the project.
092: *
093: * @param project
094: * @return
095: */
096: public Node getComplibsRootNode(Project project);
097:
098: /**
099: * Install the complib file into the IDE so that it is available for use by projects. This is
100: * also known as importing a complib file.
101: *
102: * @param complibFile
103: * complib file, e.g. represents "acme-1.2.1.complib" on disk
104: * @param overwrite
105: * If true, then any existing component library with the same namespace and version
106: * will be overwritten. If false, then the existing component library will not be
107: * replaced.
108: * @throws ComplibException
109: * if there are problems with complib file or install failed
110: */
111: public void installComplibFile(File complibFile, boolean overwrite)
112: throws ComplibException;
113:
114: /**
115: * Initialize all complibs associated with a project
116: *
117: * @param project
118: */
119: public void initProjectComplibs(Project project);
120:
121: /**
122: * Clean up any resources that are used by the complibs associated with a project
123: *
124: * @param project
125: */
126: public void cleanUpProjectComplibs(Project project);
127:
128: /**
129: * Package private method designed to be called from BrokenLibraryRefFilter. Note: project
130: * migration should have been a separate step under explicit user control but other parts of the
131: * IDE were not done that way for some unknown reason.
132: *
133: * @param project
134: * @return list of legacy library reference names to be removed from project
135: */
136: public List<String> getLibRefNamesToRemove(Project project);
137: }
|