NetBeans Project UI API



Project UI API
org.netbeans.spi.project.ui Ability to provide a tailored UI for a project. Helpful UI support classes for general projects. Support for providing own templates visible in New File... action.


What is New (see all changes)?

Use Cases

The main use case is for project type providers to supply logical views and customizers for the project. Also for template providers to create project-aware file templates. Can also get a list of open projects, create different kinds of project-related actions, and select projects on disk.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...
Group of java interfaces
Interface NameIn/OutStabilitySpecified in What Document?

The Project UI API provides some miscellaneous APIs and SPIs relating to the appearance and UI behavior of generic projects. Most importantly, it permits the customizer and logical view of a project to be defined.


Callbacks intended to let the Project UI module plug in implementations of APIs defined here. Uses implementation dependencies.

Group of layer interfaces
Interface NameIn/OutStabilitySpecified in What Document?

New (or import) project wizards can be registered in a special folder Templates/Projects/.


Providers of generic project actions can register Action and JSeparator instances in a special folder Projects/Actions/. So if any module wishes to extend, hide or reorder some of them it can just register its actions there. Example:

    <folder name="Projects" >
        <folder name="Actions" >
            <file name="org-mymodule-MyAction.instance" >
                <attr name="instanceCreate" stringvalue="org.mymodule.MyAction" />


File templates can be registered with various attributes, some specific to the project system.

Implementation Details

What do other modules need to do to declare a dependency on this one?
   OpenIDE-Module-Module-Dependencies: org.netbeans.modules.projectuiapi/1 > ${OpenIDE-Module-Specification-Version}

Read more about the implementation in the answers to architecture questions.


Built on May 3 2007.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.