| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Actions APIs - 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 Actions APIs module</h1> |
| <ul> |
| <li> |
| <b>Author:</b> pzavadsky@netbeans.org</li> |
| <li> |
| <b>Answers as of:</b> 14-Sep-2018</li> |
| <li> |
| <b>Answers for questions version:</b> 1.12</li> |
| <li> |
| <b>Latest available version of questions:</b> 1.29</li> |
| </ul> |
| <strong> |
| WARNING: answering questions version 1.12 |
| rather than the current 1.29. |
| </strong> |
| <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>NodesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-NodesAPI"><a href="../org-openide-nodes/overview-summary.html"> |
| .../overview-summary.html</a> |
| <p></p> |
| <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>WindowSystemAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-WindowSystemAPI"><a href="../org-openide-windows/overview-summary.html"> |
| .../overview-summary.html</a> |
| <p></p> |
| <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>ExplorerAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ExplorerAPI"><a href="../org-openide-explorer/overview-summary.html"> |
| .../overview-summary.html</a> |
| <p></p> |
| <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"><a href="../org-openide-filesystems/overview-summary.html"> |
| .../overview-summary.html</a> |
| <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"><a href="../org-openide-loaders/overview-summary.html"> |
| .../overview-summary.html</a> |
| <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"><a href="../org-openide-util-ui/overview-summary.html"> |
| .../overview-summary.html</a> |
| <p></p> |
| <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>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 |
| 6.5 |
| 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 |
| 6.2 |
| 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.16 |
| 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.1 |
| is required. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>ActionsAPI</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ActionsAPI"><a href="overview-summary.html">overview-summary.html</a> |
| <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>OpenIDE-Transmodal-Action</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="property-OpenIDE-Transmodal-Action"> |
| <p></p>Inidicates action can be performed |
| (typicaly via shortcut) even when dialog is popped out (modal or modeless).<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>delegates</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="property-delegates"> |
| <p></p>Used internaly in <code>PasteAction</code> delegate action |
| which serves to pass an array of <code>PasteType</code> or <code>Action</code> to global instance (it is the only one |
| which actually performs paste operation).<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>iconBase</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="property-iconBase"> |
| <p></p>Used in companion to Actions.SMALL_ICON. Because there |
| is no way to specify values for other types of icons the value of "iconBase" is used |
| to construct the resource names of disabled, pressed and rollover icons. The value is |
| expected to contain a resource path of the normal icon. Strings "_pressed", |
| "_disabled" and "_rollover" are inserted before the suffix when searching for |
| the other types of icons.<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>noIconInMenu</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="property-noIconInMenu"> |
| <p></p> |
| Allowed value <code>Boolean.TRUE</code>. |
| Influences the display of the action in the main menu, the item will have no icon there. Works for Actions that don't define custom MenuPresenter. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>PreferredIconSize</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="property-PreferredIconSize"> |
| <p></p> |
| Used to support 24x24 icons in toolbars. If toolbar button has client property "PreferredIconSize" |
| set to Integer(24) button tries to load icon with name "iconBase" + "24" eg. "cut24.gif". |
| Strings "_pressed","_disabled" and "_rollover" are inserted before the suffix when searching for |
| the other types of icons eg.:"cut24_pressed.gif".<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>waitFinished</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="property-waitFinished"> |
| <p></p> |
| There is a new contract established between the caller of an action that |
| allows mutual communication and possible synchronous execution even for |
| actions that by default perform their operations asynchronously. If the |
| action's <code>actionPeformed</code> method is passed <code>ActionEvent</code> |
| with command <q>waitFinished</q> the action shall be executed synchronously. |
| The code: |
| <pre xml:space="preserve"> |
| action.actionPerformed (new ActionEvent (this, 0, "waitFinished")) |
| </pre> |
| shall be executed synchronously, even if the action by default runs asynchronously. |
| All asynchronous actions are asked to obey this contract, <code>CallableSystemAction</code> |
| does it by default. However this contract is defined as friend one |
| and may be abandoned in future. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>ActionMapKeys</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Stable">Stable</a></td><td><a name="property-ActionMapKeys"> |
| <p></p> |
| |
| <code>CallableSystemAction</code> uses its <code>getActionMapKey()</code> method |
| (usually overriden by subclasses) to get a key which is then searched in the |
| <code>ActionMap</code> obtained from the action's context. Other modules can |
| register their own action then: |
| <pre xml:space="preserve"> |
| topComponent.getActionMap ().put (theKey, new YourOwnSwingAction ()); |
| </pre> |
| Here is the list of special keys: |
| <ul> |
| |
| <li> |
| <code>"cloneWindow"</code> - an action to be executed when a top component is to be cloned</li> |
| |
| <li> |
| <code>"closeWindow"</code> - an action when a view is about to be closed</li> |
| |
| <li> |
| <code>DefaultEditorKit.copyAction</code> - copy action handler</li> |
| |
| <li> |
| <code>DefaultEditorKit.cutAction</code> - cut action handler</li> |
| |
| <li> |
| <code>"delete"</code> - delete action handler</li> |
| |
| <li> |
| <code>DefaultEditorKit.pasteAction</code> - paste action handler</li> |
| |
| <!-- new since 5.8 --> |
| |
| <li> |
| <code>"jumpNext"</code> - when a next element shall be selected</li> |
| |
| <li> |
| <code>"jumpPrev"</code> - when a previous element shall be selected</li> |
| |
| </ul> |
| |
| <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>org.openide.util.actions.CallableSystemAction.synchronousByDefault</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="systemproperty-org.openide.util.actions.CallableSystemAction.synchronousByDefault"> |
| <p></p> |
| If set to <code>true</code>, changes default value of the |
| <code>asynchronous()</code> method. Useful for unit tests |
| which would prefer to run all tested actions synchronously. |
| <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>UI-ToolActions</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Stable">Stable</a></td><td><a name="layer-UI-ToolActions"> |
| <p></p> |
| Register your <a href="http://download.oracle.com/javase/8/docs/api/javax/swing/Action.html" shape="rect">javax.swing.Action</a> |
| instances in <code>UI/ToolActions</code> folder to make them known |
| to <a href="org/openide/actions/ToolsAction.html" shape="rect">ToolsAction</a>. |
| <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.openide.actions.HeapView</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="preferences-org.openide.actions.HeapView"> |
| <p></p> |
| |
| <table> |
| |
| <tbody> |
| |
| <tr> |
| |
| <th colspan="1" rowspan="1">key</th> |
| <th colspan="1" rowspan="1">description</th> |
| <th colspan="1" rowspan="1">read</th> |
| <th colspan="1" rowspan="1">write</th> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">showDropShadow</td> |
| <td colspan="1" rowspan="1">Preserves "Drop Shadow" setting of the view</td> |
| <td colspan="1" rowspan="1">x</td> |
| <td colspan="1" rowspan="1">x</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">showText</td> |
| <td colspan="1" rowspan="1">Preserves "Show Text" setting of the view</td> |
| <td colspan="1" rowspan="1">x</td> |
| <td colspan="1" rowspan="1">x</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">tickStyle</td> |
| <td colspan="1" rowspan="1">Preserves "Overlay Grid" setting of the view</td> |
| <td colspan="1" rowspan="1">x</td> |
| <td colspan="1" rowspan="1">x</td> |
| |
| </tr> |
| |
| </tbody> |
| |
| </table> |
| |
| <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="pzavadsky@netbeans.org" module="Actions APIs" question-version="1.12"> |
| |
| |
| <!-- |
| |
| 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> |
| <em>Actions</em> provides system of support and utility classes |
| for 'actions' usage in NetBeans. |
| <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> |
| XXX no answer for arch-overall |
| </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> |
| First see the <a href="org/openide/actions/doc-files/api.html" shape="rect">API description</a>. Here is just |
| a list of frequently asked or interesting questions slowly expanding as |
| people ask them: |
| |
| <h3>Actions faq:</h3> |
| |
| |
| <h4>How to define configurable Shortcut for Component based shortcut?</h4> |
| |
| <em><b>Q:</b> |
| The usual Swing way of defining Actions for your component is to create an Action instance and put it into the Input and Action maps of your component. |
| However how to make this Action's shortcut configurable from the Tools/Keyboard Shortcuts dialog?</em> |
| |
| <p> |
| In order for the action to show up in Keyboards Shortcut dialog you need the action defined in the |
| layer file under "Actions" folder and have the shortcut defined there under "Keymaps/<Profile Name>" linking to your action. |
| </p> |
| |
| <pre xml:space="preserve"> |
| <folder name="Actions" > |
| <folder name="Window"> |
| <file name="org-netbeans-core-actions-PreviousViewCallbackAction.instance"/> |
| </folder> |
| </folder> |
| |
| <folder name="Keymaps"> |
| <folder name="NetBeans"> |
| <file name="S-A-Left.shadow"> |
| <attr name="originalFile" stringvalue="Actions/Window/org-netbeans-core-actions-PreviousViewCallbackAction.instance"/> |
| </file> |
| </folder> |
| </folder> |
| </pre> |
| |
| <p> |
| The mentioned Action has to be a subclass of <code>org.openide.util.actions.CallbackSystemAction</code>. It does not necessarily has to |
| perform the action, it's just a placeholder for linking the shortcut. You might want to override it's <code>getActionMapKey()</code> and give it a |
| reasonable key. |
| </p> |
| |
| <p> |
| The actual action that does the work in your component (preferably a simple Swing <code>javax.swing.Action</code>) |
| is to be put into your <code>TopComponent</code>'s <code>ActionMap</code>. The key for the <code>ActionMap</code> |
| has to match the key defined in the global action's <code>getActionMapKey()</code> method. |
| </p> |
| |
| <pre xml:space="preserve"> |
| getActionMap().put("PreviousViewAction", new MyPreviousTabAction()); |
| </pre> |
| |
| <p> |
| This way even actions from multiple <code>TopComponent</code>s with the same gesture (eg. "switch to next tab") can share the same configurable shortcut. |
| </p> |
| |
| <p> |
| Note: Don't define your action's shortcut and don't put it into any of the <code>TopComponent</code>'s |
| <code>javax.swing.InputMap</code>. Otherwise the component would not pick up the changed shortcut from the |
| global context. |
| </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> |
| XXX no answer for arch-time |
| </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> |
| XXX no answer for arch-quality |
| </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> |
| It uses various kinds of API's: |
| <ul> |
| |
| <li> |
| |
| <a href="#java-NodesAPI">NodesAPI</a> |
| The support class <code>NodeAction</code>. |
| </li> |
| |
| <li> |
| |
| <a href="#java-WindowSystemAPI">WindowSystemAPI</a> |
| <code>NodeAction</code> uses <code>TopComponent.Registry</code>. |
| </li> |
| |
| <li> |
| |
| <a href="#java-ExplorerAPI">ExplorerAPI</a> |
| <code>PasteAction</code> uses <code>ExplorerManager</code>. |
| </li> |
| |
| <li> |
| |
| <a href="#java-FilesystemsAPI">FilesystemsAPI</a> |
| E.g. <code>FileSystemAction</code> uses <code>FileSystem</code>. |
| </li> |
| |
| <li> |
| |
| <a href="#java-LoadersAPI">LoadersAPI</a> |
| E.g. <code>FileSystemAction</code> uses <code>DataObject</code>. |
| </li> |
| |
| <li> |
| |
| <a href="#java-UtilitiesAPI">UtilitiesAPI</a> |
| |
| </li> |
| |
| </ul> |
| |
| <p>The default answer to this question is:<!--If you do not want default answer to be generated you can use <defaultanswer generate='none' /> here--><br> |
| <p> |
| <p> |
| These modules are required in project.xml: |
| <!--<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 |
| 6.5 |
| 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 |
| 6.2 |
| 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='NodesAPI'> |
| 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='EditorAPI'> |
| The module is needed for compilation. |
| |
| The module is used during runtime. |
| |
| Specification version |
| 6.16 |
| 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.1 |
| 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.2 |
| is required. |
| </api> |
| </li> |
| --><ul> |
| <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 |
| 6.5 |
| is required. |
| </li> |
| <li> |
| <a href="#java-DialogsAPI">DialogsAPI</a> |
| - |
| The module is needed for compilation. |
| |
| The module is used during runtime. |
| |
| Specification version |
| 6.2 |
| 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-NodesAPI">NodesAPI</a> |
| - |
| The module is needed for compilation. |
| |
| The module is used during runtime. |
| |
| Specification version |
| 6.2 |
| 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.16 |
| 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.1 |
| 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.2 |
| is required. |
| </li> |
| </ul> |
| </p> |
| </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> |
| No. |
| <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> |
| 100% pure Java. It should run anywhere. |
| <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> |
| It uses JRE 1.3. |
| <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> |
| JRE is enough. |
| </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> |
| Classes belonging to this module do not reside in standalone library. |
| They are bundled together with other parts of the openide in <code>openide.jar</code>. |
| <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> |
| Whole openide can be deployed via AU center. |
| <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> |
| <code>openide.jar</code> needs to be in the system directory. |
| <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> |
| <!-- XXX what does this mean? --> |
| No, ther are <a href="#java-ActionsAPI">ActionsAPI</a>. |
| <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> |
| Nothing. |
| </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> |
| Yes. |
| <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> |
| Before the Actions was build on <code>org.openide.util.actions.SystemAction</code>, this |
| was recently changed that Actions supports <code>javax.swing.Action</code> which |
| is java API standard, and Actions will be improving towards this more and more. |
| <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> |
| Yes up to now it is supposed to be compatible with older versions. |
| <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>WARNING:</b> Question with id="<i>compat-deprecation</i>" has not been answered!</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> |
| No. |
| <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> |
| <a href="#layer-UI-ToolActions">UI-ToolActions</a> |
| - |
| Register your <a href="http://download.oracle.com/javase/8/docs/api/javax/swing/Action.html" shape="rect">javax.swing.Action</a> |
| instances in <code>UI/ToolActions</code> folder to make them known |
| to <a href="org/openide/actions/ToolsAction.html" shape="rect">ToolsAction</a>. |
| |
| <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> |
| There are special folders containing actions in xml layers. |
| <ul> |
| |
| <li> |
| <em>Menu</em> contains actions which are present in menu.</li> |
| |
| <li> |
| <em>Toolbars</em> contains actions which will be present in toolbars.</li> |
| |
| <li> |
| <em>Shortcuts</em> contains actions which will have assigned shortcuts.</li> |
| |
| <li> |
| <em>Actions</em> contains actions which are possible to manipulate with (via Options).</li> |
| |
| </ul> |
| |
| <em>Note:</em> Those layers are not necessarily read by Actions module. Probably |
| it belongs to <em>Window system module</em>. |
| <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> |
| No. |
| <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.openide.actions.HeapView">org.openide.actions.HeapView</a> |
| - |
| <table> |
| |
| <tbody> |
| |
| <tr> |
| |
| <th colspan="1" rowspan="1">key</th> |
| <th colspan="1" rowspan="1">description</th> |
| <th colspan="1" rowspan="1">read</th> |
| <th colspan="1" rowspan="1">write</th> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">showDropShadow</td> |
| <td colspan="1" rowspan="1">Preserves "Drop Shadow" setting of the view</td> |
| <td colspan="1" rowspan="1">x</td> |
| <td colspan="1" rowspan="1">x</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">showText</td> |
| <td colspan="1" rowspan="1">Preserves "Show Text" setting of the view</td> |
| <td colspan="1" rowspan="1">x</td> |
| <td colspan="1" rowspan="1">x</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">tickStyle</td> |
| <td colspan="1" rowspan="1">Preserves "Overlay Grid" setting of the view</td> |
| <td colspan="1" rowspan="1">x</td> |
| <td colspan="1" rowspan="1">x</td> |
| |
| </tr> |
| |
| </tbody> |
| |
| </table> |
| |
| |
| </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> |
| It uses <code>Lookup</code> as a representation of context in which are certain action |
| types <code>ContextAwareAction</code>s used. Current implementations |
| lookup in the context for <code>javax.swing.ActionMap</code> |
| or <code>org.openide.nodes.Node</code> or <code>org.openide.Node.Cookie</code> |
| instances. |
| <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> |
| No. Actions are just clients of some lookups. |
| <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> |
| No. |
| </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-org.openide.util.actions.CallableSystemAction.synchronousByDefault">org.openide.util.actions.CallableSystemAction.synchronousByDefault</a> |
| - |
| If set to <code>true</code>, changes default value of the |
| <code>asynchronous()</code> method. Useful for unit tests |
| which would prefer to run all tested actions synchronously. |
| |
| </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> |
| There are used three values (via <code>Action.getValue()</code>). |
| <ul> |
| |
| <li> |
| <a href="#property-OpenIDE-Transmodal-Action">OpenIDE-Transmodal-Action</a> |
| - Inidicates action can be performed |
| (typicaly via shortcut) even when dialog is popped out (modal or modeless).</li> |
| |
| <li> |
| <a href="#property-delegates">delegates</a> |
| - Used internaly in <code>PasteAction</code> delegate action |
| which serves to pass an array of <code>PasteType</code> or <code>Action</code> to global instance (it is the only one |
| which actually performs paste operation).</li> |
| |
| <li> |
| <a href="#property-iconBase">iconBase</a> |
| - Used in companion to Actions.SMALL_ICON. Because there |
| is no way to specify values for other types of icons the value of "iconBase" is used |
| to construct the resource names of disabled, pressed and rollover icons. The value is |
| expected to contain a resource path of the normal icon. Strings "_pressed", |
| "_disabled" and "_rollover" are inserted before the suffix when searching for |
| the other types of icons.</li> |
| |
| <li> |
| <a href="#property-noIconInMenu">noIconInMenu</a> |
| - |
| Allowed value <code>Boolean.TRUE</code>. |
| Influences the display of the action in the main menu, the item will have no icon there. Works for Actions that don't define custom MenuPresenter. |
| </li> |
| |
| <li> |
| <a href="#property-PreferredIconSize">PreferredIconSize</a> |
| - |
| Used to support 24x24 icons in toolbars. If toolbar button has client property "PreferredIconSize" |
| set to Integer(24) button tries to load icon with name "iconBase" + "24" eg. "cut24.gif". |
| Strings "_pressed","_disabled" and "_rollover" are inserted before the suffix when searching for |
| the other types of icons eg.:"cut24_pressed.gif".</li> |
| |
| <li> |
| |
| <a href="#property-waitFinished">waitFinished</a> |
| - |
| There is a new contract established between the caller of an action that |
| allows mutual communication and possible synchronous execution even for |
| actions that by default perform their operations asynchronously. If the |
| action's <code>actionPeformed</code> method is passed <code>ActionEvent</code> |
| with command <q>waitFinished</q> the action shall be executed synchronously. |
| The code: |
| <pre xml:space="preserve"> |
| action.actionPerformed (new ActionEvent (this, 0, "waitFinished")) |
| </pre> |
| shall be executed synchronously, even if the action by default runs asynchronously. |
| All asynchronous actions are asked to obey this contract, <code>CallableSystemAction</code> |
| does it by default. However this contract is defined as friend one |
| and may be abandoned in future. |
| |
| </li> |
| |
| </ul> |
| |
| |
| <a href="#property-ActionMapKeys">ActionMapKeys</a> |
| - |
| <code>CallableSystemAction</code> uses its <code>getActionMapKey()</code> method |
| (usually overriden by subclasses) to get a key which is then searched in the |
| <code>ActionMap</code> obtained from the action's context. Other modules can |
| register their own action then: |
| <pre xml:space="preserve"> |
| topComponent.getActionMap ().put (theKey, new YourOwnSwingAction ()); |
| </pre> |
| Here is the list of special keys: |
| <ul> |
| |
| <li> |
| <code>"cloneWindow"</code> - an action to be executed when a top component is to be cloned</li> |
| |
| <li> |
| <code>"closeWindow"</code> - an action when a view is about to be closed</li> |
| |
| <li> |
| <code>DefaultEditorKit.copyAction</code> - copy action handler</li> |
| |
| <li> |
| <code>DefaultEditorKit.cutAction</code> - cut action handler</li> |
| |
| <li> |
| <code>"delete"</code> - delete action handler</li> |
| |
| <li> |
| <code>DefaultEditorKit.pasteAction</code> - paste action handler</li> |
| |
| <!-- new since 5.8 --> |
| |
| <li> |
| <code>"jumpNext"</code> - when a next element shall be selected</li> |
| |
| <li> |
| <code>"jumpPrev"</code> - when a previous element shall be selected</li> |
| |
| </ul> |
| |
| |
| |
| <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> |
| XXX no answer for exec-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> |
| No. |
| <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> |
| A bit indirectly. <code>SystemAction.get (...)</code> |
| calls to <code>SharedClassObject.findObject</code> which calls constructor by reflection. |
| <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> |
| No. |
| <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> |
| XXX no answer for exec-process |
| </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> |
| XXX no answer for exec-introspection |
| </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> |
| XXX no answer for exec-threading |
| </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> |
| XXX no answer for security-policy |
| </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> |
| XXX no answer for security-grant |
| </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> |
| None. |
| <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 & Drop? |
| |
| </em></font> |
| <p></p> |
| <b>Answer:</b> |
| See format-clibpoard. |
| <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> |
| Implementations of cut, copy and paste (<code>CutAction</code>, <code>CopyAction</code> |
| and <code>PasteAction</code>) reads/writes from/into clipboard. It uses standard |
| <a href="http://java.sun.com/j2se/1.4.1/docs/api/java/awt/datatransfer/package-summary.html" shape="rect">java datatransfer mechanism</a> |
| and <a href="../org-openide-util-ui/org/openide/util/datatransfer/package-summary.html" shape="rect">Netbeans extension to the mechanism</a>. |
| </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> |
| No. |
| <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> |
| No. |
| <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> |
| This should be irrelevant, as far as I know, Actions shouldn't use any collections |
| of data or something like that. One exception I know is global keymap implementation |
| which scales linear. |
| <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> |
| None is defined. |
| <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> |
| There is one class in VM per action. Because currently all actions are subclasses |
| of <code>SystemAction</code>. |
| Those kind of actions are singletons. |
| That older approach is getting away. There are already newer implementation |
| which creates short living action instances (context sensitive actions) |
| when invoking popup menu. |
| <br>It should be measured how much of memory they take. |
| I guess the amount shouldn't be signicant. |
| <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> |
| No. At least I do not know about that. |
| <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> |
| No. |
| <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> |
| Core implementation provides component for customizing shorcuts. |
| <code>org.netbeans.core.ShortcutsEditor</code>. |
| <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> |
| Actions doesn't use menus, it is vice versa. |
| <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> |
| XXX no answer for perf-spi |
| </p> |
| |
| </ul> |
| |
| |
| <!-- security --> |
| <!-- recovery --> |
| |
| |
| </api-questions> |
| |
| |
| |
| <!-- Question: arch-what |
| |
| <question id="arch-what"> |
| What is this project good for? |
| <hint> |
| Please provide here few lines describing the the project, |
| what problem it should solve, provide links to documentation, |
| specifications, etc. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| |
| <!-- Question: compat-i18n |
| |
| <question id="compat-i18n"> |
| Is your module correctly internationalized? |
| <hint> |
| Correct internationalization means that it obeys instuctions |
| at <a href="http://www.netbeans.org/devhome/docs/i18n/index.html"> |
| NetBeans I18N pages</a>. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: compat-standards |
| |
| <question id="compat-standards"> |
| Does the module implements or defines any standards? Is the |
| implementation exact or it deviates somehow? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: compat-version |
| |
| <question id="compat-version"> |
| Does your module properly coexists with earlier and future |
| versions? Can you correctly read settings? Will future |
| versions be able to read settings? |
| |
| <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: dep-jre |
| |
| <question id="dep-jre"> |
| Which version of JRE 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: dep-jrejdk |
| |
| <question id="dep-jrejdk"> |
| Do you require JDK or is JRE enough? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: dep-nb |
| |
| <question id="dep-nb"> |
| What other NetBeans projects this one depends on? |
| <hint> |
| If you want, describe such projects as imported API using |
| the <code><api name="identification" type="import or export" category="stable" url="where is the description" /></code> |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: dep-non-nb |
| |
| <question id="dep-non-nb"> |
| What other non-NetBeans projects this one depends on? |
| |
| <hint> |
| Some non-NetBeans projects are packaged as NetBeans modules |
| (see <a href="http://libs.netbeans.org">libraries</a>) and |
| it is prefered to use this approach when more modules may |
| depend on such third-party library. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: dep-platform |
| |
| <question id="dep-platform"> |
| On which platforms your module run? Any? Does it run in the same |
| way? |
| <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: deploy-jar |
| |
| <question id="deploy-jar"> |
| Do you deploy just module JAR file(s) or some other files? |
| <hint> |
| If your module consist just from one module JAR file, just confirm that. |
| If it uses more than one JAR, describe where there 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/deinstallation leaves the system |
| in state as it was before installation. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: deploy-nbm |
| |
| <question id="deploy-nbm"> |
| Can you deploy NBM via AutoUpdate center? |
| <hint> |
| If not why? |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: deploy-packages |
| |
| <question id="deploy-packages"> |
| 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/apis/org/openide/doc-files/upgrade.html#3.4-public-packages"> |
| public packages |
| </a>). |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: deploy-shared |
| |
| <question id="deploy-shared"> |
| Do you need to be installed in shared location or only in user directory? |
| <hint> |
| Installation location shall not matter, if it does explain why. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: exec-classloader |
| |
| <question id="exec-classloader"> |
| Does your code uses own classloader? |
| <hint> |
| A bit unusual. Please explain why and what for. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: exec-component |
| |
| <question id="exec-component"> |
| Is execution of your code influenced by (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 behaviour 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: exec-privateaccess |
| |
| <question id="exec-privateaccess"> |
| Are you aware of any other part 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: exec-property |
| |
| <question id="exec-property"> |
| Is execution of your code influenced by any environment of |
| system (<code>System.getProperty</code>) property? |
| |
| <hint> |
| If there is a property that can change the behaviour of your |
| code, somebody will likely use it. You should describe what it does |
| and the stability category of this API. You may use |
| <PRE> |
| <property name="id" category="private" > |
| description of the property, where it is used, what it influence, etc. |
| </property> |
| </PRE> |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: exec-reflection |
| |
| <question id="exec-reflection"> |
| Does your code uses java.lang.reflect to execute some other code? |
| <hint> |
| This usually indicates a missing or unsufficient 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: format-clipboard |
| |
| <question id="format-clipboard"> |
| Which protocols your code reads/inserts when communicating with |
| clipboard? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: format-dnd |
| |
| <question id="format-dnd"> |
| Which protocols your code understands during drag-n-drop? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: format-types |
| |
| <question id="format-types"> |
| Which file formats your code reads or writes on disk? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: lookup-lookup |
| |
| <question id="lookup-lookup"> |
| Does your module uses <code>org.openide.util.Lookup</code> |
| to find any components to communicate to? 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 clasify the stability of such |
| API contract. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: lookup-register |
| |
| <question id="lookup-register"> |
| Do you register anything into the lookup for other 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: lookup-remove |
| |
| <question id="lookup-remove"> |
| Are removing entries of other modules from the 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: perf-exit |
| |
| <question id="perf-exit"> |
| Does your module executes anything on exit? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-huge_dialogs |
| |
| <question id="perf-huge_dialogs"> |
| Does your module contain any dialogs or wizards with huge |
| amount of GUI controls like combo boxes, lists, trees, text |
| areas? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-limit |
| |
| <question id="perf-limit"> |
| Are there any limits in number/size of elements your code |
| can handle? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-mem |
| |
| <question id="perf-mem"> |
| What is the amount of memory your component occupies? Estimate |
| with a relaction to the number of windows, etc. |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-menus |
| |
| <question id="perf-menus"> |
| Does your module use dynamically changing context menus or |
| context sensitive actions with complicated logic for enable/disable? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-progress |
| |
| <question id="perf-progress"> |
| Does your module executes some long running task? |
| <hint>Typically they are tasks like connecting over |
| network, computing huge amount of data, compilation. |
| Such communication should be done asynchronously (for example |
| using <code>RequestProcessor</code>), definitively it should |
| not block AWT thread. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-scale |
| |
| <question id="perf-scale"> |
| 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? |
| Please include some estimates. |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-startup |
| |
| <question id="perf-startup"> |
| Does your module executes anything on startup? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: perf-wakeup |
| |
| <question id="perf-wakeup"> |
| Is any piece of your code waking up periodically? |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: resources-file |
| |
| <question id="resources-file"> |
| 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 prefered |
| way that should be used. But of course there can be situations when |
| this is not suitable. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- Question: resources-layer |
| |
| <question id="resources-layer"> |
| Does your module provide own layer? Does it create some files or |
| folders on it? What it is trying to communicate by that and with which |
| component? |
| |
| <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: resources-mask |
| |
| <question id="resources-mask"> |
| Does your module mask/hide/override any resource provided by another one in |
| module layer? |
| |
| <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: resources-read |
| |
| <question id="resources-read"> |
| 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 clasify according to |
| <a href="http://openide.netbeans.org/tutorial/api-design.html#categories"> |
| common stability categories</a>. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| <!-- Question: resources-preferences |
| |
| <question id="resources-preferences"> |
| 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 <api type="export" group="preferences" name="preference node name" |
| category="private"> description of individual keys, where it is used, what it influences, |
| whether the module reads/write it, etc. </api> Due to XML ID restrictions, rather than |
| /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo. Note that if you use |
| NbPreferences this name will then be the same as the code name base of the module. |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| <!-- |
| <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" shape="rect"> |
| clients and what support API</a>? |
| What parts will be pluggable? |
| How will plug-ins be registered? Please use <code><api type="export"/></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" shape="rect">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-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="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-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-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-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" shape="rect">Threading Recommendations</a> (in progress) |
| </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="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> |
| --> |
| |
| |
| |
| </api-answers> |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| </body> |
| </html> |
