当前页面: 在线文档首页 > NetBeans API Javadoc 4.1.0

Overview (NetBeans APIs) - NetBeans API Javadoc 4.1.0

Overview  Package  Class  Use  Tree  Deprecated  Index  Help
PREV   NEXT	FRAMES    NO FRAMES

---

NetBeans Open APIs

This document set describes the central APIs used in the NetBeans IDE.

See:
          Description

Modules API
org.openide.modules	The IDE is capable of being extended by pluggable modules providing additional functionality.

 

ServiceType, WizardDescriptor, ...
org.openide	Miscellaneous general classes, especially the util classes to handle a user notifications, displaying dialogs and the error management system.

 

Services & Lookup API
org.openide.cookies	Cookies are a design pattern used to add behaviors to existing data object and nodes, or to separate implementation from the main object.
org.openide.util.lookup	Useful implementations of the lookup system used to register functionality and objects in the APIs.

 

Filesystems API
org.openide.filesystems	The IDE internally uses the concept of a virtual filesystem.

 

Nodes API
org.openide.nodes	The IDE uses nodes to represent JavaBeans or other property containers, formed into a hierarchical tree.

 

Explorer API
org.openide.explorer	Many different UI components of the IDE are actually Explorer views of nodes.
org.openide.explorer.propertysheet	The exact properties of a node may be displayed and edited with the Property Sheet.
org.openide.explorer.propertysheet.editors
org.openide.explorer.view	The Explorer is really an abstraction that needs a view to actually display the nodes.

 

Actions API
org.openide.actions	There are a number of standard system actions available for use in the IDE.
org.openide.util.actions	There are several types of standard actions that should be used for many user interactions with the IDE.

 

Editor API
org.openide.text	The IDE is able to integrate multiple editors for different content types and mechanically access their content.

 

Window System API
org.openide.windows	Most parts of the IDE do not manipulate windows directly, but use special top components.

 

Options API
org.openide.options	System options provide an easy-to-use mechanism for persistent storage of user-settable options.

 

Utility Classes
org.openide.awt	A set of utility classes pertaining to the visual appearance of the IDE.
org.openide.util	A set of utility classes covering a few general infrastructure points in the Open APIs.
org.openide.util.datatransfer	The IDE uses special extensions to data transfer.
org.openide.util.io	A set of utility classes providing extensions to the Java I/O system.
org.openide.xml	A set of utility classes assisting in the manipulation of XML documents in the IDE.

 

This document set describes the central APIs used in the NetBeans IDE. It also applies to compatible distributions such as Sun Java Studio and any other applications which keep the APIs intact.

The API set allows application creators and power users to extensively customize the IDE and integrate substantial external applications into the IDE's operation. It also is self-contained and permits the implementation to be inserted into it at runtime.

Available API sets:

• The Modules API provides a way to insert pluggable JAR-based modules into the IDE, in a user-controllable fashion, which may extend its operation using any of the other APIs. Based heavily on the Java Extension Mechanism, features include module versioning and cross-compatibility checks; Web-based download and installation of modules into a running IDE; and the capability to specify a variety of standard additions (such as new menu items) descriptively in the module's manifest file or XML layer.
• The Services & Lookup API describes a general way of permitting various service objects to be uniformly created, installed, configured, selected, and saved. It also covers the lookup mechanism: how to register objects to lookup, find them, and present them to a user, including settings.
• The Filesystems API describes how to access and monitor files used in the IDE.
• The Explorer API gives access to the Explorer in its various views, such as trees and tree tables. Module authors may drop an Explorer view of some part of the IDE into a custom UI component. The API also allows an implementor to create new Explorer views for custom data representation, and make them interoperable with the existing ones. Also included is the Property Sheet and ways to display properties.
• The Nodes API permits access to the provided features of nodes such as those used in the Explorer window; and allows third parties to create their own hierarchical nodes to display wherever they wish, including operations such as browsing of nodes; cut/copy/paste and reordering; display characteristics, both icon and available properties; and actions which may be taken on the node (e.g. in a context menu), both custom actions and standard actions such as "Open".
• The Actions API provides an interface to such IDE elements as toolbars, menus, and keyboard shortcuts - allowing third parties to create actions which are sensitive to context and are invokable in more than one way.
• The Window System API controls the overall functioning of the desktop, including standard and custom modes and the dynamic interaction of windows during various stages of the user experience, as well as XML-based persistence and configuration.
• The Options API provides the ability for a module to have persistent user-level options accessible in the Options dialog, including custom option editors and context help.
• The Editor API provides access to the basic functionality of the Editor and its support for different content types; guarded blocks and annotations; and the ability to insert custom editors conforming to the Swing Editor Kit conventions.
• Utility Classes providing support functionality for the primary APIs.
• HtmlBrowser for modules to provide an alternate web browser, and HttpServer for an alternate web server (which must be internal so as to handle serving of pages from the Repository).

Sections marked with a blue background are non-normative and should not be considered part of the formal specification of the APIs.

Supplementary specifications:

1. All NetBeans APIs (online)
2. Threading Models used in the Open APIs.
3. API Change List (for Open APIs only - other APIs list their own changes separately).
4. NetBeans code conventions (online). Includes informational relevant to the APIs such as when null may or may not be passed to a method.
5. Architecture Summary for the Modules API
6. Architecture Summary for the Dialogs API
7. Architecture Summary for the Lookup API
8. Architecture Summary for the Filesystems API
9. Architecture Summary for the Nodes API
10. Architecture Summary for the Explorer API
11. Architecture Summary for the Actions API
12. Architecture Summary for the Window System API
13. Architecture Summary for the Utilities API
14. Architecture Summary for the Editor API
15. Architecture Summary for the Property Sheet API

---

Overview  Package  Class  Use  Tree  Deprecated  Index  Help
PREV   NEXT	FRAMES    NO FRAMES

---

Built on May 4 2005.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.