Description Layer Registration in NetBeans APIs - NetBeans API Javadoc (Current Development Version)

Registration of various objects, files and hints into layer is pretty central to the way NetBeans based applications handle communication between modules. This page summarizes the list of such extension points defined by modules with API.

• layer-actions in Ant

  Context menu actions are read from the layer folder Loaders/text/x-ant+xml/Actions.

• DatabaseExplorerLayerAPI in Database Explorer

• Loaders-text-dbschema-Actions in Database Explorer

• Loaders-text-sql-Actions in Database Explorer

• J2SEProjectCustomizer in Java SE Projects

  "Projects/org-netbeans-modules-java-j2seproject/Customizer" folder's content is used to construct the project's customizer. It's content is expected to be ProjectCustomizer.CompositeCategoryProvider instances. The lookup passed to the panels contains an instance of Project and org.netbeans.modules.java.j2seproject.ui.customizer.J2SEProjectProperties Please note that the latter is not part of any public APIs and you need implementation dependency to make use of it.

• J2SELogicalViewProvider in Java SE Projects

  "Projects/org-netbeans-modules-java-j2seproject/Nodes" folder's content is used to construct the project's child nodes. It's content is expected to be NodeFactory instances.

• J2SELookup in Java SE Projects

  "Projects/org-netbeans-modules-java-j2seproject/Lookup" folder's content is used to construct the project's additional lookup. It's content is expected to be LookupProvider instances. J2SE project provides LookupMergers for Sources, PrivilegedTemplates and RecommendedTemplates. Implementations added by 3rd parties will be merged into a single instance in the project's lookup.

• OptionsDialogSPILayers in Options Dialog and SPI

  Use OptionsDialog folder for registration of custom top level options panels. Register your implementation of OptionsCategory there (*.instance file). Standard file systems sorting mechanism is used.

• AdvancedPanelSPILayers in Options Dialog and SPI

  Use OptionsDialog/Advanced folder for registration of custom panels to Miscellaneous Panel. Register your implementation of AdvancedCategory there (*.instance file). Standard file systems sorting mechanism is used.

• RegisteredActions in Project UI API

  Several project related actions are registered in the Actions folder in the layer. Product branding is intended to use those actions to build main menu, toolbars and shortcuts.

  • Actions/Project/org-netbeans-modules-project-ui-BuildMainProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-CleanMainProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-RebuildMainProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-RunMainProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-DebugMainProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-TestProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-BuildProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-CleanProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-RebuildProject.instance
  • Actions/Project/org-netbeans-modules-project-ui-RunProject.instance

• ProjectTemplates in Project UI API

  New (or import) project wizards can be registered in a special folder Templates/Projects/.

• ProjectActions in Project UI API

  Providers of generic project actions can register Action and JSeparator instances in a special folder Projects/Actions/. So if any module wishes to extend, hide or reorder some of them it can just register its actions there. Example:

      <folder name="Projects" >
          <folder name="Actions" >
              <file name="org-mymodule-MyAction.instance" >
                  <attr name="instanceCreate" stringvalue="org.mymodule.MyAction" />
              </file>
          </folder>
      </folder>
      

• Templates in Project UI API

  File templates can be registered with various attributes, some specific to the project system.

• TemplatesLicenses in Project UI API

  Under Templates/Licenses folder should be registered various license headers that can be imported by templates using scripting. The recommended format of filename is license-[licensename].txt e.g. license-cddl.txt.

• RuntimeInstancesRegistry in Settings API

  xml/memory: Associates runtime instance with environment provider.

• ServicesDisplayRegistry in Settings API

  UI/Services: The root folder for displaying options in the deprecated Advanced dialog.

• user_settings in Common Palette

  There's a private XML file for user settings for each palette model.

• Loaders-folder-any-Actions in Datasystems API

  The actions that the default folder loader shows in its popup menu are read from a layer folder Loaders/folder/any/Actions so if any module wishes to extend, hide or reorder some of them it can just register its actions there.

• Loaders-text-xml-Actions in Datasystems API

  The actions that the standard XML loader shows in its popup menu are read from a layer folder Loaders/text/xml/Actions

• Loaders-content-unknown-Actions in Datasystems API

  The actions that the loader for unrecognized files shows in its popup menu are read from a layer folder Loaders/content/unknown/Actions

• Loaders-application-x-nbsettings-Actions in Datasystems API

  The actions that the loader for instance and settings files shows in its popup menu are read from a layer folder Loaders/application/x-nbsettings/Actions

• Loaders-folder-any-Actions in Datasystems API

  The actions that the default folder loader shows in its popup menu are read from a layer folder Loaders/folder/any/Actions so if any module wishes to extend, hide or reorder some of them it can just register its actions there.

• Loaders-text-xml-Actions in Datasystems API

  The actions that the standard XML loader shows in its popup menu are read from a layer folder Loaders/text/xml/Actions

• Loaders-content-unknown-Actions in Datasystems API

  The actions that the loader for unrecognized files shows in its popup menu are read from a layer folder Loaders/content/unknown/Actions

• Loaders-application-x-nbsettings-Actions in Datasystems API

  The actions that the loader for instance and settings files shows in its popup menu are read from a layer folder Loaders/application/x-nbsettings/Actions

• PrivilegedTemplates in Datasystems API

  A folder Privileged offers to other module possibility add own templates.

• RecentTemplates in Datasystems API

  A folder Recent stores a set of recently used templates, it's not open to other module.

• NewConfigurationData in Window System API

  new configuration data

• OldConfigurationData in Window System API

  old configuration data

• ModuleDataStructure in Window System API

  Module folder structure under Windows2 directory

• LocalDataStructure in Window System API

  Local folder structure under Windows2Local directory

To get your API listed here, use <api type='export' group='layer' ... /> in your module arch.xml document.