Project UI
Friend, Private or Third Party

See:
Description

Project UI

org.netbeans.modules.project.ui.api

Module provides general implementation of projects UI and exports client friend API only.

What is New (see all changes)?

• Jul 20 '08 Externalize Build related action registration.

  For certain distributions of NetBeans (PHP or Ruby), actions like "Build project" or "Rebuild project" make no sense in the main menu. Therefore the layer registration for these actions was moved to projectui.buildmenu module which provides token "BuildActions". If a certain distribution requires these actiosn to be present it shall require this token. Java and CND do now.

• Feb 1 '07 Don't open project view component in bluej edition.

  Use system property "project.tab.no.selection" for influencing the behaviour on creation or opening of projects. When this property is set, the opening/creating of projects doesn't trigger opening and focusing of the projects logical view top component. Allows the BlueJ Edition to focus it's own component instead.

• Mar 20 '06 Provide a way to get list of information about recent projects.

  Added RecentProjects class that provides access to list of recently used projects (UnloadedProjectInformation class). Listener can be registered to be notified about change in the list of recent projects. The API is only for friend access.

Use Cases

Needed for working with projects in the IDE.

RecentProjects

API can be used to get list of information about recently opened projects in IDE. API provides project display name, icon and URL of project folder location. Listeners can be registered to learn about change of the list.

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?
RecentProjects	Exported	Friend	.../issues/show_bug.cgi?id=57073 API can be used to get list of information about recently opened projects in IDE. API provides project display name, icon and URL of project folder location. Listeners can be registered to learn about change of the list. .../issues/show_bug.cgi?id=57073 There is package org.netbeans.modules.project.ui.api which is public and exposed as friend API.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
PRESELECT_CATEGORY	Exported	Private	Path to a category of project type, e.g. Sample/Standard.
PRESELECT_TEMPLATE	Exported	Private	Name of a project type, e.g. emptyWeb.
project.tab.no.selection	Exported	Private	When this property is set, the opening of projects doesn't trigger opening and focusing of the projects logical view top component. Allows the BlueJ Edition to focus it's own component instead.
org.netbeans.modules.project.ui.OpenProjectList	Exported	Private	Error manager logging category for things affecting project list.
netbeans.projects.dir	Exported	Private	Property for overriding default location of projects directory which is folder NetBeansProjects under $HOME on Unixes and under default user folder on Windows (e.g. C:\Documents and Settings\[username]\My Documents\NetBeansProjects). Directory passed by the property must exist, otherwise default is used.

Group of logger interfaces

Interface Name	In/Out	Stability	Specified in What Document?
org.netbeans.ui.actions.UI_ACTION_BUTTON_PRESS	Exported	Friend	There is a special support for notifying when an action wrapped by LookupSensitiveAction is invoked and how. The support is using Logger.getLogger("org.netbeans.ui.actions") and sents a LogRecord with message UI_ACTION_BUTTON_PRESS, FINER level and paramerters: {0} instance of the button {1} class of the button {2} instance of the action {3} class of the action {4} display name of the action whenever such action is invoked. This message can then be consumed by enhanced UI logger that track what the user is going.

Group of layer interfaces

Interface Name	In/Out	Stability	Specified in What Document?
ProjectsTabActions	Exported	Friend	Actions for the Projects tab root context menu are taken from the layer folder ProjectsTabActions. Foreign modules ought to place entries below sep-below-main-actions.instance.

Group of preferences interfaces

Interface Name	In/Out	Stability	Specified in What Document?
org.netbeans.modules.projectui	Exported	Private	List of open projects. See OpenProjectListSettings.
org.netbeans.modules.projectui.groups	Exported	Private	Project groups. See Group.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

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

N/A

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