Google Git
Sign in
apache / netbeans-docs / refs/heads/asf-site / . / content / 9.0 / javadoc / org-netbeans-modules-projectui / architecture-summary.html
blob: 77d9c12fe26c54b04d5ccbc22c2cb23e9511e820 [file] [log] [blame]
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Project UI - NetBeans Architecture Questions</title>
<link rel="stylesheet" type="text/css" href="prose.css">
</head>
<body>
<p class="overviewlink">
<a href="overview-summary.html">Overview</a>
</p>
<h1>NetBeans Architecture Answers for Project UI module</h1>
<ul>
<li>
<b>Author:</b> jglick@netbeans.org,mkubec@netbeans.org</li>
<li>
<b>Answers as of:</b> 14-Sep-2018</li>
<li>
<b>Answers for questions version:</b> 1.29</li>
<li>
<b>Latest available version of questions:</b> 1.29</li>
</ul>
<hr>
<h2>Interfaces table</h2>
<a name="group-java">
<h5>Group of java interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>RecentProjects</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="java-RecentProjects"><a href="http://www.netbeans.org/issues/show_bug.cgi?id=57073">
.../issues/show_bug.cgi?id=57073</a>
<p></p>
<p></p>
<p>
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.
</p>
<p></p>
<a href="http://www.netbeans.org/issues/show_bug.cgi?id=57073">
.../issues/show_bug.cgi?id=57073</a>
<p></p>
<p></p>
<p>
There is package org.netbeans.modules.project.ui.api which is public and exposed
as friend API.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>CommonAnnotationsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Stable">Stable</a></td><td><a name="java-CommonAnnotationsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.13
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>Progress</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-Progress">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.40
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ProgressSwing</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ProgressSwing">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.40
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.core.execution</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="java-org.netbeans.core.execution">
<p></p>
The module is used during runtime.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.core.ui</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="java-org.netbeans.core.ui">
<p></p>
The module is used during runtime.
Specification version
1.8
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.modules.favorites</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="java-org.netbeans.modules.favorites">
<p></p>
The module is used during runtime.
Specification version
1.10
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>MasterFileSystemAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="java-MasterFileSystemAPI">
<p></p>
The module is used during runtime.
Specification version
2.50
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.modules.project.indexingbridge</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="java-org.netbeans.modules.project.indexingbridge">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.2
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ProjectAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ProjectAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.56
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ProjectUIAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ProjectUIAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>BaseProjectUIAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-BaseProjectUIAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>GeneralQueriesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-GeneralQueriesAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.27
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>SendOptsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-SendOptsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
2.20
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>SearchProvider</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-SearchProvider">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.17
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ActionsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ActionsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.2
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.openide.awt</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-org.openide.awt">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.49
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>DialogsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-DialogsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.19
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ExplorerAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ExplorerAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.8
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>FilesystemsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-FilesystemsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.6
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.openide.filesystems.nb</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="java-org.openide.filesystems.nb">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.0
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>LoadersAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-LoadersAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.61
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>DataSystemsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-DataSystemsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.0
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ModulesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ModulesAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.19
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>NodesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-NodesAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.27
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>EditorAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-EditorAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.32
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>UtilitiesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-UtilitiesAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>WeakListener.setAccessible</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java-WeakListener.setAccessible">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>LookupAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-LookupAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
8.0
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>WindowSystemAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-WindowSystemAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.28
is required.
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-property">
<h5>Group of property interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>PRESELECT_CATEGORY</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-PRESELECT_CATEGORY">
<p></p>
<p>
Path to a category of project type, e.g. Sample/Standard.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>PRESELECT_TEMPLATE</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-PRESELECT_TEMPLATE">
<p></p>
<p>
Name of a project type, e.g. emptyWeb.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-systemproperty">
<h5>Group of systemproperty interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>project.tab.no.selection</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="systemproperty-project.tab.no.selection">
<p></p>
<p>
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.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.modules.project.ui.OpenProjectList</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="systemproperty-org.netbeans.modules.project.ui.OpenProjectList">
<p></p>
<p>
Error manager logging category for things affecting project list.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>netbeans.projects.dir</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="systemproperty-netbeans.projects.dir">
<p></p>
<p>
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.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-logger">
<h5>Group of logger interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>org.netbeans.ui.actions.UI_ACTION_BUTTON_PRESS</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="logger-org.netbeans.ui.actions.UI_ACTION_BUTTON_PRESS">
<p></p>
There is a special support for notifying when an action wrapped by
<code>LookupSensitiveAction</code> is
invoked and how. The support is using <a href="http://download.oracle.com/javase/8/docs/api/java/util/logging/Logger.html" shape="rect">
Logger.getLogger("org.netbeans.ui.actions")
</a> and sents a <a href="http://download.oracle.com/javase/8/docs/api/java/util/logging/LogRecord.html" shape="rect">LogRecord</a>
with message <code>UI_ACTION_BUTTON_PRESS</code>,
<code>FINER</code> <a href="http://download.oracle.com/javase/8/docs/api/java/util/logging/LogRecord.html" shape="rect">level</a>
and paramerters:
<ul>
<li>{<b>0</b>} instance of the button</li>
<li>{<b>1</b>} class of the button</li>
<li>{<b>2</b>} instance of the action</li>
<li>{<b>3</b>} class of the action</li>
<li>{<b>4</b>} display name of the action</li>
</ul>
whenever such action is invoked. This message can then be consumed
by enhanced UI logger that track what the user is going.
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-cli">
<h5>Group of cli interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>group</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="cli-group">
<p></p>
<p>
Can use <code>--open-group <i>NAME</i></code> to open a project group at startup, or <code>--close-group</code>.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-layer">
<h5>Group of layer interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>Loaders-folder-any-Actions</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Stable">Stable</a></td><td><a name="layer-Loaders-folder-any-Actions"><a href="../org-openide-loaders/architecture-summary.html#layer-Loaders-folder-any-Actions">
.../architecture-summary.html</a>
<p></p>
<p></p>
to add certain build system actions to folder popup menu and hide the
default ones.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>ProjectsTabActions</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="layer-ProjectsTabActions">
<p></p>
<p>
Actions for the <b>Projects</b> tab root context menu are taken from
the layer folder <code>ProjectsTabActions</code>. Foreign modules ought
to place entries below <code>sep-below-main-actions.instance</code>.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-preferences">
<h5>Group of preferences interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>org.netbeans.modules.projectui</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="preferences-org.netbeans.modules.projectui">
<p></p>
<p>
List of open projects. See <code>OpenProjectListSettings</code>.
</p>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.modules.projectui.groups</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="preferences-org.netbeans.modules.projectui.groups">
<p></p>
<p>
Project groups. See <code>Group</code>.
</p>
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<api-answers author="jglick@netbeans.org,mkubec@netbeans.org" module="Project UI" question-version="1.29">
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Author : Jaroslav Tulach, Jesse Glick
Description: Questions that should be answered in order to make better API
No PUBLIC or SYSTEM IDs defined currently.
-->
<!--
*** ATTENTION EDITORS ***
Please increment the 'version' field of <api-questions> whenever you make a
semantic change: adding a new question or significantly changing the meaning of
an old one. Changing this field ensures that arch pages answering the old version
print a warning during Javadoc generation. If you only change hints or make small
edits in the text of a question, you need not change the version number.
An automated process runs openide/www/tutorial/build.xml#question periodically
and commits any changes to openide/www/tutorial/questions.html.
-->
<api-questions version="1.29" xml:base="file:/home/nsigma/Code/NetBeans/incubator-netbeans/nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">
<hr>
<h2>General Information</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-arch-what">Question (arch-what)</a>:</b><em>
What is this project good for?
</em></font>
<p></p>
<b>Answer:</b>
<p>
General user interface implementation for the project system. <a href="http://projects.netbeans.org/buildsys/build-sys-ui-spec.html" shape="rect">UI
Specification</a>
</p>
<p></p>
<font color="gray"><b><a name="answer-arch-overall">Question (arch-overall)</a>:</b><em>
Describe the overall architecture.
</em></font>
<p></p>
<b>Answer:</b>
<p>
Module provides general implementation of projects UI and exports client friend API only.
</p>
<p></p>
<font color="gray"><b><a name="answer-arch-usecases">Question (arch-usecases)</a>:</b><em>
Describe the main <a href="http://wiki.netbeans.org/API_Design#The_Importance_of_Being_Use_Case_Oriented" shape="rect">
use cases</a> of the new API. Who will use it under
what circumstances? What kind of code would typically need to be written
to use the module?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Needed for working with projects in the IDE.
</p>
<a href="#java-RecentProjects">RecentProjects</a>
-
<p>
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.
</p>
<p></p>
<font color="gray"><b><a name="answer-arch-time">Question (arch-time)</a>:</b><em>
What are the time estimates of the work?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Mostly done.
</p>
<p></p>
<font color="gray"><b><a name="answer-arch-quality">Question (arch-quality)</a>:</b><em>
How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html" shape="rect">quality</a>
of your code be tested and
how are future regressions going to be prevented?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Unit tests would be appropriate for some code areas; currently few exist.
IDE-wide functional tests cover most of the module&rsquo;s functionality.
Basic API functionality is covered by unit tests.
</p>
<p></p>
<font color="gray"><b><a name="answer-arch-where">Question (arch-where)</a>:</b><em>
Where one can find sources for your module?
</em></font>
<p></p>
<b>Answer:</b>
<p>
<p>
The sources for the module are in the
<a href="http://hg.netbeans.org/" shape="rect">NetBeans Mercurial repositories</a>.
</p>
</p>
</ul>
<hr>
<h2>Project and platform dependencies</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-dep-nb">Question (dep-nb)</a>:</b><em>
What other NetBeans projects and modules does this one depend on?
</em></font>
<p></p>
<b>Answer:</b>
<p>
<p>
These modules are required in project.xml:
<!--<li><api type='import' group='java' category='stable' name='CommonAnnotationsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.13
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='Progress'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.40
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='ProgressSwing'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.40
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='private' name='org.netbeans.core.execution'>
The module is used during runtime.
</api>
</li>
--><!--<li><api type='import' group='java' category='private' name='org.netbeans.core.ui'>
The module is used during runtime.
Specification version
1.8
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='private' name='org.netbeans.modules.favorites'>
The module is used during runtime.
Specification version
1.10
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='friend' name='MasterFileSystemAPI'>
The module is used during runtime.
Specification version
2.50
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='private' name='org.netbeans.modules.project.indexingbridge'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.2
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='ProjectAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.56
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='ProjectUIAPI'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='BaseProjectUIAPI'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='GeneralQueriesAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.27
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='SendOptsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
2.20
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='SearchProvider'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.17
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='ActionsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.2
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='org.openide.awt'>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.49
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='DialogsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.19
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='ExplorerAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.8
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='FilesystemsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.6
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='private' name='org.openide.filesystems.nb'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.0
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='LoadersAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.61
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='DataSystemsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.0
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='ModulesAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.19
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='NodesAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
7.27
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='EditorAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.32
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='UtilitiesAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='devel' name='WeakListener.setAccessible'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='LookupAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
8.0
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='WindowSystemAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
6.28
is required.
</api>
</li>
--><ul>
<li>
<a href="#java-CommonAnnotationsAPI">CommonAnnotationsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.13
is required.
</li>
<li>
<a href="#java-Progress">Progress</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.40
is required.
</li>
<li>
<a href="#java-ProgressSwing">ProgressSwing</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.40
is required.
</li>
<li>
<a href="#java-org.netbeans.core.execution">org.netbeans.core.execution</a>
-
The module is used during runtime.
</li>
<li>
<a href="#java-org.netbeans.core.ui">org.netbeans.core.ui</a>
-
The module is used during runtime.
Specification version
1.8
is required.
</li>
<li>
<a href="#java-org.netbeans.modules.favorites">org.netbeans.modules.favorites</a>
-
The module is used during runtime.
Specification version
1.10
is required.
</li>
<li>
<a href="#java-MasterFileSystemAPI">MasterFileSystemAPI</a>
-
The module is used during runtime.
Specification version
2.50
is required.
</li>
<li>
<a href="#java-org.netbeans.modules.project.indexingbridge">org.netbeans.modules.project.indexingbridge</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.2
is required.
</li>
<li>
<a href="#java-ProjectAPI">ProjectAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.56
is required.
</li>
<li>
<a href="#java-ProjectUIAPI">ProjectUIAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
</li>
<li>
<a href="#java-BaseProjectUIAPI">BaseProjectUIAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
</li>
<li>
<a href="#java-GeneralQueriesAPI">GeneralQueriesAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.27
is required.
</li>
<li>
<a href="#java-SendOptsAPI">SendOptsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
2.20
is required.
</li>
<li>
<a href="#java-SearchProvider">SearchProvider</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.17
is required.
</li>
<li>
<a href="#java-ActionsAPI">ActionsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
6.2
is required.
</li>
<li>
<a href="#java-org.openide.awt">org.openide.awt</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
7.49
is required.
</li>
<li>
<a href="#java-DialogsAPI">DialogsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
7.19
is required.
</li>
<li>
<a href="#java-ExplorerAPI">ExplorerAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
6.8
is required.
</li>
<li>
<a href="#java-FilesystemsAPI">FilesystemsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.6
is required.
</li>
<li>
<a href="#java-org.openide.filesystems.nb">org.openide.filesystems.nb</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.0
is required.
</li>
<li>
<a href="#java-LoadersAPI">LoadersAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
7.61
is required.
</li>
<li>
<a href="#java-DataSystemsAPI">DataSystemsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.0
is required.
</li>
<li>
<a href="#java-ModulesAPI">ModulesAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
7.19
is required.
</li>
<li>
<a href="#java-NodesAPI">NodesAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
7.27
is required.
</li>
<li>
<a href="#java-EditorAPI">EditorAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
6.32
is required.
</li>
<li>
<a href="#java-UtilitiesAPI">UtilitiesAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</li>
<li>
<a href="#java-WeakListener.setAccessible">WeakListener.setAccessible</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</li>
<li>
<a href="#java-LookupAPI">LookupAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
8.0
is required.
</li>
<li>
<a href="#java-WindowSystemAPI">WindowSystemAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
6.28
is required.
</li>
</ul>
</p>
</p>
<p></p>
<font color="gray"><b><a name="answer-dep-non-nb">Question (dep-non-nb)</a>:</b><em>
What other projects outside NetBeans does this one depend on?
</em></font>
<p></p>
<b>Answer:</b>
<p>
None.
</p>
<p></p>
<font color="gray"><b><a name="answer-dep-platform">Question (dep-platform)</a>:</b><em>
On which platforms does your module run? Does it run in the same
way on each?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Any.
</p>
<p></p>
<font color="gray"><b><a name="answer-dep-jre">Question (dep-jre)</a>:</b><em>
Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
</em></font>
<p></p>
<b>Answer:</b>
<p>
1.4+.
</p>
<p></p>
<font color="gray"><b><a name="answer-dep-jrejdk">Question (dep-jrejdk)</a>:</b><em>
Do you require the JDK or is the JRE enough?
</em></font>
<p></p>
<b>Answer:</b>
<p>
JRE.
</p>
</ul>
<hr>
<h2>Deployment</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-deploy-jar">Question (deploy-jar)</a>:</b><em>
Do you deploy just module JAR file(s) or other files as well?
</em></font>
<p></p>
<b>Answer:</b>
<p>
JAR only.
</p>
<p></p>
<font color="gray"><b><a name="answer-deploy-nbm">Question (deploy-nbm)</a>:</b><em>
Can you deploy an NBM via the Update Center?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Yes.
</p>
<p></p>
<font color="gray"><b><a name="answer-deploy-shared">Question (deploy-shared)</a>:</b><em>
Do you need to be installed in the shared location only, or in the user directory only,
or can your module be installed anywhere?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Anywhere.
</p>
<p></p>
<font color="gray"><b><a name="answer-deploy-packages">Question (deploy-packages)</a>:</b><em>
Are packages of your module made inaccessible by not declaring them
public?
</em></font>
<p></p>
<b>Answer:</b>
<a href="#java-RecentProjects">RecentProjects</a>
-
<p>
There is package org.netbeans.modules.project.ui.api which is public and exposed
as friend API.
</p>
<p></p>
<font color="gray"><b><a name="answer-deploy-dependencies">Question (deploy-dependencies)</a>:</b><em>
What do other modules need to do to declare a dependency on this one,
in addition to or instead of the normal module dependency declaration
(e.g. tokens to require)?
</em></font>
<p></p>
<b>Answer:</b>
<p>
N/A
</p>
</ul>
<hr>
<h2>Compatibility with environment</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-compat-i18n">Question (compat-i18n)</a>:</b><em>
Is your module correctly internationalized?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Yes.
</p>
<p></p>
<font color="gray"><b><a name="answer-compat-standards">Question (compat-standards)</a>:</b><em>
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-compat-version">Question (compat-version)</a>:</b><em>
Can your module coexist with earlier and future
versions of itself? Can you correctly read all old settings? Will future
versions be able to read your current settings? Can you read
or politely ignore settings stored by a future version?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Uses a system option, but otherwise not much to version.
</p>
<p></p>
<font color="gray"><b><a name="answer-compat-deprecation">Question (compat-deprecation)</a>:</b><em>
How the introduction of your project influences functionality
provided by previous version of the product?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No APIs are planned to be deprecated/removed/changed.
</p>
</ul>
<hr>
<h2>Access to resources</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-resources-file">Question (resources-file)</a>:</b><em>
Does your module use <code>java.io.File</code> directly?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Sometimes.
</p>
<p></p>
<font color="gray"><b><a name="answer-resources-layer">Question (resources-layer)</a>:</b><em>
Does your module provide own layer? Does it create any files or
folders in it? What it is trying to communicate by that and with which
components?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Installs a whole lot of UI through the layer. Menus, templates, etc.
Also is using
<a href="#layer-Loaders-folder-any-Actions">Loaders-folder-any-Actions</a>
-
to add certain build system actions to folder popup menu and hide the
default ones.
</p>
<p></p>
<font color="gray"><b><a name="answer-resources-read">Question (resources-read)</a>:</b><em>
Does your module read any resources from layers? For what purpose?
</em></font>
<p></p>
<b>Answer:</b>
<a href="#layer-ProjectsTabActions">ProjectsTabActions</a>
-
<p>
Actions for the <b>Projects</b> tab root context menu are taken from
the layer folder <code>ProjectsTabActions</code>. Foreign modules ought
to place entries below <code>sep-below-main-actions.instance</code>.
</p>
<p></p>
<font color="gray"><b><a name="answer-resources-mask">Question (resources-mask)</a>:</b><em>
Does your module mask/hide/override any resources provided by other modules in
their layers?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Seems to override mode definitions for explorer components.
</p>
<p></p>
<font color="gray"><b><a name="answer-resources-preferences">Question (resources-preferences)</a>:</b><em>
Does your module uses preferences via Preferences API? Does your module use NbPreferences or
or regular JDK Preferences ? Does it read, write or both ?
Does it share preferences with other modules ? If so, then why ?
</em></font>
<p></p>
<b>Answer:</b>
<a href="#preferences-org.netbeans.modules.projectui">org.netbeans.modules.projectui</a>
-
<p>
List of open projects. See <code>OpenProjectListSettings</code>.
</p>
<a href="#preferences-org.netbeans.modules.projectui.groups">org.netbeans.modules.projectui.groups</a>
-
<p>
Project groups. See <code>Group</code>.
</p>
</ul>
<hr>
<h2>Lookup of components</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-lookup-lookup">Question (lookup-lookup)</a>:</b><em>
Does your module use <code>org.openide.util.Lookup</code>
or any similar technology to find any components to communicate with? Which ones?
</em></font>
<p></p>
<b>Answer:</b>
<p>
The UI asks projects for various documented interfaces in their lookup;
details given in the particular interfaces. E.g.
<code>LogicalViewProvider</code> is sought out in project lookups when
displaying the logical view.
The UI uses <code>AuxiliaryConfiguration</code> to store list of files opened
in the project in an instant closing the project. Will be used for reopen these
files when this project opens.
</p>
<p></p>
<font color="gray"><b><a name="answer-lookup-register">Question (lookup-register)</a>:</b><em>
Do you register anything into lookup for other code to find?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Callback implementation for the Project UI API.
</p>
<p></p>
<font color="gray"><b><a name="answer-lookup-remove">Question (lookup-remove)</a>:</b><em>
Do you remove entries of other modules from lookup?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
</ul>
<!-- classification of interfaces -->
<!-- package names -->
<hr>
<h2>Execution Environment</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-exec-property">Question (exec-property)</a>:</b><em>
Is execution of your code influenced by any environment or
Java system (<code>System.getProperty</code>) property?
On a similar note, is there something interesting that you
pass to <code>java.util.logging.Logger</code>? Or do you observe
what others log?
</em></font>
<p></p>
<b>Answer:</b>
<ul>
<li>
<a href="#systemproperty-project.tab.no.selection">project.tab.no.selection</a>
-
<p>
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.
</p>
</li>
<li>
<a href="#systemproperty-org.netbeans.modules.project.ui.OpenProjectList">org.netbeans.modules.project.ui.OpenProjectList</a>
-
<p>
Error manager logging category for things affecting project list.
</p>
</li>
<li>
<a href="#systemproperty-netbeans.projects.dir">netbeans.projects.dir</a>
-
<p>
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.
</p>
</li>
<li>
<a href="#logger-org.netbeans.ui.actions.UI_ACTION_BUTTON_PRESS">org.netbeans.ui.actions.UI_ACTION_BUTTON_PRESS</a>
-
There is a special support for notifying when an action wrapped by
<code>LookupSensitiveAction</code> is
invoked and how. The support is using <a href="http://download.oracle.com/javase/8/docs/api/java/util/logging/Logger.html" shape="rect">
Logger.getLogger("org.netbeans.ui.actions")
</a> and sents a <a href="http://download.oracle.com/javase/8/docs/api/java/util/logging/LogRecord.html" shape="rect">LogRecord</a>
with message <code>UI_ACTION_BUTTON_PRESS</code>,
<code>FINER</code> <a href="http://download.oracle.com/javase/8/docs/api/java/util/logging/LogRecord.html" shape="rect">level</a>
and paramerters:
<ul>
<li>{<b>0</b>} instance of the button</li>
<li>{<b>1</b>} class of the button</li>
<li>{<b>2</b>} instance of the action</li>
<li>{<b>3</b>} class of the action</li>
<li>{<b>4</b>} display name of the action</li>
</ul>
whenever such action is invoked. This message can then be consumed
by enhanced UI logger that track what the user is going.
</li>
<li>
<a href="#cli-group">group</a>
-
<p>
Can use <code>--open-group <i>NAME</i></code> to open a project group at startup, or <code>--close-group</code>.
</p>
</li>
</ul>
<p></p>
<font color="gray"><b><a name="answer-exec-component">Question (exec-component)</a>:</b><em>
Is execution of your code influenced by any (string) property
of any of your components?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Yes, the <code>org.netbeans.modules.project.ui.TemplatesPanel</code> reads the properties:
<a href="#property-PRESELECT_CATEGORY">PRESELECT_CATEGORY</a>
-
<p>
Path to a category of project type, e.g. Sample/Standard.
</p>
<a href="#property-PRESELECT_TEMPLATE">PRESELECT_TEMPLATE</a>
-
<p>
Name of a project type, e.g. emptyWeb.
</p>
These properties affect which category and project are preselected in 1st panel
of <code>NewProjectWizard</code>. If properties are empty (as default) then
category/project are selected by UI spec.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-ant-tasks">Question (exec-ant-tasks)</a>:</b><em>
Do you define or register any ant tasks that other can use?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No Ant tasks.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-classloader">Question (exec-classloader)</a>:</b><em>
Does your code create its own class loader(s)?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-reflection">Question (exec-reflection)</a>:</b><em>
Does your code use Java Reflection to execute other code?
</em></font>
<p></p>
<b>Answer:</b>
<p>
<code>org.netbeans.modules.project.ui.Hacks</code> does some things to fix
actions for folder context menus; update the main window title; and do
something strange with <code>TemplateWizard</code>.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-privateaccess">Question (exec-privateaccess)</a>:</b><em>
Are you aware of any other parts of the system calling some of
your methods by reflection?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-process">Question (exec-process)</a>:</b><em>
Do you execute an external process from your module? How do you ensure
that the result is the same on different platforms? Do you parse output?
Do you depend on result code?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-introspection">Question (exec-introspection)</a>:</b><em>
Does your module use any kind of runtime type information (<code>instanceof</code>,
work with <code>java.lang.Class</code>, etc.)?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-exec-threading">Question (exec-threading)</a>:</b><em>
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Mostly EQ.
</p>
<p></p>
<font color="gray"><b><a name="answer-security-policy">Question (security-policy)</a>:</b><em>
Does your functionality require modifications to the standard policy file?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-security-grant">Question (security-grant)</a>:</b><em>
Does your code grant additional rights to some other code?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
</ul>
<hr>
<h2>Format of files and protocols</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-format-types">Question (format-types)</a>:</b><em>
Which protocols and file formats (if any) does your module read or write on disk,
or transmit or receive over the network? Do you generate an ant build script?
Can it be edited and modified?
</em></font>
<p></p>
<b>Answer:</b>
<p>
None.
</p>
<p></p>
<font color="gray"><b><a name="answer-format-dnd">Question (format-dnd)</a>:</b><em>
Which protocols (if any) does your code understand during Drag &amp; Drop?
</em></font>
<p></p>
<b>Answer:</b>
<p>
None.
</p>
<p></p>
<font color="gray"><b><a name="answer-format-clipboard">Question (format-clipboard)</a>:</b><em>
Which data flavors (if any) does your code read from or insert to
the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>?
</em></font>
<p></p>
<b>Answer:</b>
<p>
None.
</p>
</ul>
<hr>
<h2>Performance and Scalability</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-perf-startup">Question (perf-startup)</a>:</b><em>
Does your module run any code on startup?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Calls <code>ProjectOpenedHook.projectOpened()</code> on projects.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-exit">Question (perf-exit)</a>:</b><em>
Does your module run any code on exit?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Calls <code>ProjectOpenedHook.projectClosed()</code> on projects.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-scale">Question (perf-scale)</a>:</b><em>
Which external criteria influence the performance of your
program (size of file in editor, number of files in menu,
in source directory, etc.) and how well your code scales?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Number of open modules.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-limit">Question (perf-limit)</a>:</b><em>
Are there any hard-coded or practical limits in the number or size of
elements your code can handle?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-mem">Question (perf-mem)</a>:</b><em>
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</em></font>
<p></p>
<b>Answer:</b>
<p>
Unknown.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-wakeup">Question (perf-wakeup)</a>:</b><em>
Does any piece of your code wake up periodically and do something
even when the system is otherwise idle (no user interaction)?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-progress">Question (perf-progress)</a>:</b><em>
Does your module execute any long-running tasks?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-huge_dialogs">Question (perf-huge_dialogs)</a>:</b><em>
Does your module contain any dialogs or wizards with a large number of
GUI controls such as combo boxes, lists, trees, or text areas?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Nothing too big.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-menus">Question (perf-menus)</a>:</b><em>
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated and slow enablement logic?
</em></font>
<p></p>
<b>Answer:</b>
<p>
Yes, project-selection- and file-selection-sensitive actions are updated
dynamically.
</p>
<p></p>
<font color="gray"><b><a name="answer-perf-spi">Question (perf-spi)</a>:</b><em>
How the performance of the plugged in code will be enforced?
</em></font>
<p></p>
<b>Answer:</b>
<p>
No special provisions.
</p>
</ul>
<!-- security -->
<!-- recovery -->
</api-questions>
<!--
<question id="arch-overall" when="init">
Describe the overall architecture.
<hint>
What will be API for
<a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi">
clients and what support API</a>?
What parts will be pluggable?
How will plug-ins be registered? Please use <code>&lt;api type="export"/&gt;</code>
to describe your general APIs.
If possible please provide
simple diagrams.
</hint>
</question>
-->
<!--
<question id="arch-quality" when="init">
How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">quality</a>
of your code be tested and
how are future regressions going to be prevented?
<hint>
What kind of testing do
you want to use? How much functionality, in which areas,
should be covered by the tests?
</hint>
</question>
-->
<!--
<question id="arch-time" when="init">
What are the time estimates of the work?
<hint>
Please express your estimates of how long the design, implementation,
stabilization are likely to last. How many people will be needed to
implement this and what is the expected milestone by which the work should be
ready?
</hint>
</question>
-->
<!--
<question id="arch-usecases" when="init">
<hint>
Content of this answer will be displayed as part of page at
http://www.netbeans.org/download/dev/javadoc/usecases.html
You can use tags &lt;usecase name="name&gt; regular html description &lt;/usecase&gt;
and if you want to use an URL you can prefix if with to begin
at the root of your javadoc
</hint>
Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase">
use cases</a> of the new API. Who will use it under
what circumstances? What kind of code would typically need to be written
to use the module?
</question>
-->
<!--
<question id="arch-what" when="init">
What is this project good for?
<hint>
Please provide here a few lines describing the project,
what problem it should solve, provide links to documentation,
specifications, etc.
</hint>
</question>
-->
<!--
<question id="arch-where" when="init">
Where one can find sources for your module?
<hint>
Please provide link to the CVS web client at
http://www.netbeans.org/download/source_browse.html
or just use tag defaultanswer generate='here'
</hint>
</question>
-->
<!--
<question id="compat-i18n" when="impl">
Is your module correctly internationalized?
<hint>
Correct internationalization means that it obeys instructions
at <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html">
NetBeans I18N pages</a>.
</hint>
</question>
-->
<!--
<question id="compat-standards" when="init">
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</question>
-->
<!--
<question id="compat-version" when="impl">
Can your module coexist with earlier and future
versions of itself? Can you correctly read all old settings? Will future
versions be able to read your current settings? Can you read
or politely ignore settings stored by a future version?
<hint>
Very helpful for reading settings is to store version number
there, so future versions can decide whether how to read/convert
the settings and older versions can ignore the new ones.
</hint>
</question>
-->
<!--
<question id="dep-jre" when="final">
Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
<hint>
It is expected that if your module runs on 1.x that it will run
on 1.x+1 if no, state that please. Also describe here cases where
you run different code on different versions of JRE and why.
</hint>
</question>
-->
<!--
<question id="dep-jrejdk" when="final">
Do you require the JDK or is the JRE enough?
</question>
-->
<!--
<question id="dep-nb" when="init">
What other NetBeans projects and modules does this one depend on?
<hint>
If you want, describe such projects as imported APIs using
the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>
</hint>
</question>
-->
<!--
<question id="dep-non-nb" when="init">
What other projects outside NetBeans does this one depend on?
<hint>
Some non-NetBeans projects are packaged as NetBeans modules
(see <a href="http://libs.netbeans.org/">libraries</a>) and
it is preferred to use this approach when more modules may
depend on such third-party library.
</hint>
</question>
-->
<!--
<question id="dep-platform" when="init">
On which platforms does your module run? Does it run in the same
way on each?
<hint>
If your module is using JNI or deals with special differences of
OSes like filesystems, etc. please describe here what they are.
</hint>
</question>
-->
<!--
<question id="deploy-dependencies" when="final">
What do other modules need to do to declare a dependency on this one,
in addition to or instead of the normal module dependency declaration
(e.g. tokens to require)?
<hint>
Provide a sample of the actual lines you would add to a module manifest
to declare a dependency, for example OpenIDE-Module-Requires: some.token.
If other modules should not depend on this module, or should just use a
simple regular module dependency, you can just answer "nothing". If you
intentionally expose a semistable API to clients using implementation
dependencies, you should mention that here (but there is no need to give
an example of usage).
</hint>
</question>
-->
<!--
<question id="deploy-jar" when="impl">
Do you deploy just module JAR file(s) or other files as well?
<hint>
Usually a module consist of one JAR file (perhaps with Class-Path
extensions) and also a configuration file that enables it. If you
have any other files, use
&lt;api group="java.io.File" name="yourname" type="export" category="friend"&gt;...&lt;/api&gt;
to define the location, name and stability of your files (of course
changing "yourname" and "friend" to suit your needs).
If it uses more than one JAR, describe where they are located, how
they refer to each other.
If it consist of module JAR(s) and other files, please describe
what is their purpose, why other files are necessary. Please
make sure that installation/uninstallation leaves the system
in state as it was before installation.
</hint>
</question>
-->
<!--
<question id="deploy-nbm" when="impl">
Can you deploy an NBM via the Update Center?
<hint>
If not why?
</hint>
</question>
-->
<!--
<question id="deploy-packages" when="init">
Are packages of your module made inaccessible by not declaring them
public?
<hint>
NetBeans module system allows restriction of access rights to
public classes of your module from other modules. This prevents
unwanted dependencies of others on your code and should be used
whenever possible (<a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/apichanges.html#issue-19621">
public packages
</a>). If you do not restrict access to your classes you are
making it too easy for other people to misuse your implementation
details, that is why you should have good reason for not
restricting package access.
</hint>
</question>
-->
<!--
<question id="deploy-shared" when="final">
Do you need to be installed in the shared location only, or in the user directory only,
or can your module be installed anywhere?
<hint>
Installation location shall not matter, if it does explain why.
Consider also whether <code>InstalledFileLocator</code> can help.
</hint>
</question>
-->
<!--
<question id="exec-ant-tasks" when="impl">
Do you define or register any ant tasks that other can use?
<hint>
If you provide an ant task that users can use, you need to be very
careful about its syntax and behaviour, as it most likely forms an
API for end users and as there is a lot of end users, their reaction
when such API gets broken can be pretty strong.
</hint>
</question>
-->
<!--
<question id="exec-classloader" when="impl">
Does your code create its own class loader(s)?
<hint>
A bit unusual. Please explain why and what for.
</hint>
</question>
-->
<!--
<question id="exec-component" when="impl">
Is execution of your code influenced by any (string) property
of any of your components?
<hint>
Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code>
or <code>PropertyDescriptor.getValue</code>, etc. are used to influence
a behavior of some code. This of course forms an interface that should
be documented. Also if one depends on some interface that an object
implements (<code>component instanceof Runnable</code>) that forms an
API as well.
</hint>
</question>
-->
<!--
<question id="exec-introspection" when="impl">
Does your module use any kind of runtime type information (<code>instanceof</code>,
work with <code>java.lang.Class</code>, etc.)?
<hint>
Check for cases when you have an object of type A and you also
expect it to (possibly) be of type B and do some special action. That
should be documented. The same applies on operations in meta-level
(Class.isInstance(...), Class.isAssignableFrom(...), etc.).
</hint>
</question>
-->
<!--
<question id="exec-privateaccess" when="final">
Are you aware of any other parts of the system calling some of
your methods by reflection?
<hint>
If so, describe the "contract" as an API. Likely private or friend one, but
still API and consider rewrite of it.
</hint>
</question>
-->
<!--
<question id="exec-process" when="impl">
Do you execute an external process from your module? How do you ensure
that the result is the same on different platforms? Do you parse output?
Do you depend on result code?
<hint>
If you feed an input, parse the output please declare that as an API.
</hint>
</question>
-->
<!--
<question id="exec-property" when="impl">
Is execution of your code influenced by any environment or
Java system (<code>System.getProperty</code>) property?
<hint>
If there is a property that can change the behavior of your
code, somebody will likely use it. You should describe what it does
and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life">stability category</a>
of this API. You may use
<pre>
&lt;api type="export" group="property" name="id" category="private" url="http://..."&gt;
description of the property, where it is used, what it influence, etc.
&lt;/api&gt;
</pre>
</hint>
</question>
-->
<!--
<question id="exec-reflection" when="impl">
Does your code use Java Reflection to execute other code?
<hint>
This usually indicates a missing or insufficient API in the other
part of the system. If the other side is not aware of your dependency
this contract can be easily broken.
</hint>
</question>
-->
<!--
<question id="exec-threading" when="impl">
What threading models, if any, does your module adhere to?
<hint>
If your module calls foreign APIs which have a specific threading model,
indicate how you comply with the requirements for multithreaded access
(synchronization, mutexes, etc.) applicable to those APIs.
If your module defines any APIs, or has complex internal structures
that might be used from multiple threads, declare how you protect
data against concurrent access, race conditions, deadlocks, etc.,
and whether such rules are enforced by runtime warnings, errors, assertions, etc.
Examples: a class might be non-thread-safe (like Java Collections); might
be fully thread-safe (internal locking); might require access through a mutex
(and may or may not automatically acquire that mutex on behalf of a client method);
might be able to run only in the event queue; etc.
Also describe when any events are fired: synchronously, asynchronously, etc.
Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations">Threading Recommendations</a> (in progress)
</hint>
</question>
-->
<!--
<question id="format-clipboard" when="impl">
Which data flavors (if any) does your code read from or insert to
the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>?
<hint>
Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
Check your code for overriding these methods.
</hint>
</question>
-->
<!--
<question id="format-dnd" when="impl">
Which protocols (if any) does your code understand during Drag &amp; Drop?
<hint>
Often Node's deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>.
Check your code for overriding these methods. Btw. if they are not overridden, they
by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
</hint>
</question>
-->
<!--
<question id="format-types" when="impl">
Which protocols and file formats (if any) does your module read or write on disk,
or transmit or receive over the network? Do you generate an ant build script?
Can it be edited and modified?
<hint>
<p>
Files can be read and written by other programs, modules and users. If they influence
your behaviour, make sure you either document the format or claim that it is a private
api (using the &lt;api&gt; tag).
</p>
<p>
If you generate an ant build file, this is very likely going to be seen by end users and
they will be attempted to edit it. You should be ready for that and provide here a link
to documentation that you have for such purposes and also describe how you are going to
understand such files during next release, when you (very likely) slightly change the
format.
</p>
</hint>
</question>
-->
<!--
<question id="lookup-lookup" when="init">
Does your module use <code>org.openide.util.Lookup</code>
or any similar technology to find any components to communicate with? Which ones?
<hint>
Please describe the interfaces you are searching for, where
are defined, whether you are searching for just one or more of them,
if the order is important, etc. Also classify the stability of such
API contract. For that use &lt;api group=&amp;lookup&amp; /&gt; tag.
</hint>
</question>
-->
<!--
<question id="lookup-register" when="final">
Do you register anything into lookup for other code to find?
<hint>
Do you register using layer file or using <code>META-INF/services</code>?
Who is supposed to find your component?
</hint>
</question>
-->
<!--
<question id="lookup-remove" when="final">
Do you remove entries of other modules from lookup?
<hint>
Why? Of course, that is possible, but it can be dangerous. Is the module
your are masking resource from aware of what you are doing?
</hint>
</question>
-->
<!--
<question id="perf-exit" when="final">
Does your module run any code on exit?
</question>
-->
<!--
<question id="perf-huge_dialogs" when="final">
Does your module contain any dialogs or wizards with a large number of
GUI controls such as combo boxes, lists, trees, or text areas?
</question>
-->
<!--
<question id="perf-limit" when="init">
Are there any hard-coded or practical limits in the number or size of
elements your code can handle?
</question>
-->
<!--
<question id="perf-mem" when="final">
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</question>
-->
<!--
<question id="perf-menus" when="final">
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated and slow enablement logic?
<hint>
If you do a lot of tricks when adding actions to regular or context menus, you can significantly
slow down display of the menu, even when the user is not using your action. Pay attention to
actions you add to the main menu bar, and to context menus of foreign nodes or components. If
the action is conditionally enabled, or changes its display dynamically, you need to check the
impact on performance. In some cases it may be more appropriate to make a simple action that is
always enabled but does more detailed checks in a dialog if it is actually run.
</hint>
</question>
-->
<!--
<question id="perf-progress" when="final">
Does your module execute any long-running tasks?
<hint>Long running tasks should never block
AWT thread as it badly hurts the UI
<a href="http://performance.netbeans.org/responsiveness/issues.html">
responsiveness</a>.
Tasks like connecting over
network, computing huge amount of data, compilation
be done asynchronously (for example
using <code>RequestProcessor</code>), definitively it should
not block AWT thread.
</hint>
</question>
-->
<!--
<question id="perf-scale" when="init">
Which external criteria influence the performance of your
program (size of file in editor, number of files in menu,
in source directory, etc.) and how well your code scales?
<hint>
Please include some estimates, there are other more detailed
questions to answer in later phases of implementation.
</hint>
</question>
-->
<!--
<question id="perf-spi" when="init">
How the performance of the plugged in code will be enforced?
<hint>
If you allow foreign code to be plugged into your own module, how
do you enforce that it will behave correctly and quickly and will not
negatively influence the performance of your own module?
</hint>
</question>
-->
<!--
<question id="perf-startup" when="final">
Does your module run any code on startup?
</question>
-->
<!--
<question id="perf-wakeup" when="final">
Does any piece of your code wake up periodically and do something
even when the system is otherwise idle (no user interaction)?
</question>
-->
<!--
<question id="resources-file" when="final">
Does your module use <code>java.io.File</code> directly?
<hint>
NetBeans provide a logical wrapper over plain files called
<code>org.openide.filesystems.FileObject</code> that
provides uniform access to such resources and is the preferred
way that should be used. But of course there can be situations when
this is not suitable.
</hint>
</question>
-->
<!--
<question id="resources-layer" when="final">
Does your module provide own layer? Does it create any files or
folders in it? What it is trying to communicate by that and with which
components?
<hint>
NetBeans allows automatic and declarative installation of resources
by module layers. Module register files into appropriate places
and other components use that information to perform their task
(build menu, toolbar, window layout, list of templates, set of
options, etc.).
</hint>
</question>
-->
<!--
<question id="resources-mask" when="final">
Does your module mask/hide/override any resources provided by other modules in
their layers?
<hint>
If you mask a file provided by another module, you probably depend
on that and do not want the other module to (for example) change
the file's name. That module shall thus make that file available as an API
of some stability category.
</hint>
</question>
-->
<!--
<question id="resources-read" when="final">
Does your module read any resources from layers? For what purpose?
<hint>
As this is some kind of intermodule dependency, it is a kind of API.
Please describe it and classify according to
<a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
common stability categories</a>.
</hint>
</question>
-->
<!--
<question id="security-grant" when="final">
Does your code grant additional rights to some other code?
<hint>Avoid using a class loader that adds extra
permissions to loaded code unless really necessary.
Also note that your API implementation
can also expose unneeded permissions to enemy code by
calling AccessController.doPrivileged().</hint>
</question>
-->
<!--
<question id="security-policy" when="final">
Does your functionality require modifications to the standard policy file?
<hint>Your code might pass control to third-party code not
coming from trusted domains. This could be code downloaded over the
network or code coming from libraries that are not bundled
with NetBeans. Which permissions need to be granted to which domains?</hint>
</question>
-->
<!--
<question id="compat-deprecation" when="init">
How the introduction of your project influences functionality
provided by previous version of the product?
<hint>
If you are planning to deprecate/remove/change any existing APIs,
list them here accompanied with the reason explaining why you
are doing so.
</hint>
</question>
-->
<!--
<question id="resources-preferences" when="final">
Does your module uses preferences via Preferences API? Does your module use NbPreferences or
or regular JDK Preferences ? Does it read, write or both ?
Does it share preferences with other modules ? If so, then why ?
<hint>
You may use
<pre xml:space="preserve">
&lt;api type="export" group="preferences"
name="preference node's absolute path name" category="private" url="http://..."&gt;
description of individual keys, where it is used, what it
influence, whether the module reads/write it, etc.
&lt;/api&gt;
</pre>
</hint>
</question>
-->
</api-answers>
<hr>
<p><span class="footnote">Built on September 14 2018.&nbsp;&nbsp;|&nbsp;&nbsp; Copyright &#169; 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p>
</body>
</html>