Project UI API
Official

ProjectUIAPI

See:
Description

Project UI API

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

• ProjectUIAPI

  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.

• ProjectUIAPI-provider

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

What is New (see all changes)?

• Jun 9 '08 Project root nodes automatically badged

  Project root nodes will now automatically be badged according to VCS status of contained files.

• Mar 26 '08 Adding template attribute project.encoding

  Added the template attribute project.encoding for templates using scripting language.

• Mar 21 '08 PrivilegedTemplates instance in global action context is preferred

  The previous scope of PrivilegedTemplates was the whole project. Now the selected Node (active context) can also provide an instance in it's lookup and it will be used instead of the default one from project's lookup. In this case the last used templates will not be considered.

• Feb 6 '08 Added ways to track projects opening and closing

  Added a method to track progress of projects opening and closing. As the opening of a project may take long time, and as there can be multiple projects open at once, it may be necessary to be notified that the process of open project list modification started or that it has finished.

• Jan 9 '08 Added methods for creating customizer UI with additional listener for saving outside of AWT EQ

  New methods were added to allow to use additional listener for saving data after user presses OK button on Project Customzer UI. The listener will be executed after all OkListeners and will be executed off the AWT Event Queue. During save operation modal dialog with progress bar is displayed.

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 Name	In/Out	Stability	Specified in What Document?
ProjectUIAPI	Exported	Official	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.
ProjectUIAPI-provider	Exported	Friend	Callbacks intended to let the Project UI module plug in implementations of APIs defined here. Uses implementation dependencies.

Group of lookup interfaces

Interface Name	In/Out	Stability	Specified in What Document?
org.openide.loaders.CreateFromTemplateAttributesProvider	Exported	Official	The attributes provider is registered in META-INF/services. It collects attributes from org.openide.loaders.CreateFromTemplateAttributesProviders registered in project lookups. It provides the project.license and project.encoding attributes for file templates using scripting support.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
project.license	Exported	Official	project.license attribute contains project license as String for newly created templates. It is used to import license templates. The default is used if the attribute was not found in any project lookup.
project.encoding	Exported	Official	project.encoding attribute contains the project encoding as String for newly created templates. The encoding of the parent folder of the new file is used if the attribute was not found in any project lookup.

Group of layer interfaces

Interface Name	In/Out	Stability	Specified in What Document?
RegisteredActions	Exported	Under Development	Several project related actions are registered in the Actions folder in the layer. Product branding is intended to use those actions to build main menu, toolbars and shortcuts. Actions/Project/org-netbeans-modules-project-ui-BuildMainProject.instance Actions/Project/org-netbeans-modules-project-ui-CleanMainProject.instance Actions/Project/org-netbeans-modules-project-ui-RebuildMainProject.instance Actions/Project/org-netbeans-modules-project-ui-RunMainProject.instance Actions/Project/org-netbeans-modules-project-ui-DebugMainProject.instance Actions/Project/org-netbeans-modules-project-ui-TestProject.instance Actions/Project/org-netbeans-modules-project-ui-BuildProject.instance Actions/Project/org-netbeans-modules-project-ui-CleanProject.instance Actions/Project/org-netbeans-modules-project-ui-RebuildProject.instance Actions/Project/org-netbeans-modules-project-ui-RunProject.instance
ProjectTemplates	Exported	Official	New (or import) project wizards can be registered in a special folder Templates/Projects/.
ProjectActions	Exported	Official	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> </folder> </folder>
Templates	Exported	Official	File templates can be registered with various attributes, some specific to the project system.
TemplatesLicenses	Exported	Official	Under Templates/Licenses folder should be registered various license headers that can be imported by templates using scripting. The recommended format of filename is license-[licensename].txt e.g. license-cddl.txt.

Implementation Details

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing.

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