Overview (Project UI API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.projectuiapi/1 1.24.0 6

PREV NEXT

FRAMES NO FRAMES

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.

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)?

May 10 '07 Add LookupMergerimplementation for ProjectOpenedHook
New method UILookupMergerSupport.createProjectOpenHookMerger(ProjectOpenedHook) creates an instance of LookupMerger that ensures that from the ProjectOpenedHook instances in project's lookup, the project's own is always called first.
Mar 26 '07 Adding template attribute project.license
Added the template attribute project.license for templates using scripting language.
Jan 5 '07 Added a way how to define UI component for non-leaf category node in project customizer
Allow to define UI component for non-leaf category node in project customizer by setting name of the file in folder on layer filesystem. If there is a category with some subcategories and UI component is needed for the category, the folder that defines the category in layer needs to contain file with name 'Self.instance'. Instance of the file will be used to create customizer component for the category.
Oct 23 '06 Ability to attach a ok button listener on single customizer category.
Allow to attach a listener to ProjectCustomizer.Category that will notify the Category and it's panel that the changes ought to be applied. This is generally useful as a fallback, general solution for 3rd party plugging into the project customizer in case the given project type doesn't provide model-driven project updating mechanism.
Oct 16 '06 Added OpenProjects.PROPERTY_MAIN_PROJECT property
Added OpenProjects.PROPERTY_MAIN_PROJECT property and firing changes in main project property value to listeners attached to OpenProjects.

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.CreateFromTemplateAttributesProvider`s registered in project lookups. It provides project.license attribute 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.

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.