Explorer & Property Sheet API
Official

See:
Description

Explorer & Property Sheet API

org.openide.explorer	Many different UI components in NetBeans 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.

XXX no answer for arch-overall

What is New (see all changes)?

• Aug 31 '11 API method for creating a PropertyEnv instance

  Added PropertyEnv.create method for creating an instance of PropertyEnv for given property and beans (nodes). To be used when there is a need to initialize an ExPropertyEditor instance independently from PropertySheet or PropertyPanel infrastructure (e.g. before the property appears in UI).

• Jun 30 '11 In-place rename can be processed on background

  By providing slowRename property, nodes can request in-place rename to be finished on background.

• Jun 10 '11 Allows one to disable quick search in property sheets, either globally or per-instance.

  Added methods setQuickSearchAllowed(boolean) and isQuickSearchAllowed() to BaseTable to control and query whether the quick search feature is enabled. Since the BaseTable instance of a PropertySheet is private, setQuickSearchAllowed(boolean) and isQuickSearchAllowed() delegate methods were also added to PropertySheet. This allows a developer control on a per-instance basis, though it is also possible to disable property sheet quick search globally by setting the ps.quickSearch.disabled.global system property to true.

• Nov 16 '10 It's possible to define whether the quick search is enabled or disabled in TreeView.

  Methods setQuickSearchAllowed() and isQuickSearchAllowed() added to TreeView to control quick search enable or disable.

• Oct 4 '10 It's possible to define whether the default action is allowed or not in OutlineView.

  Methods setDefaultActionAllowed() and isDefaultActionAllowed() added to OutlineView to control invocation of the default action.

Use Cases

XXX no answer for arch-usecases

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
ExplorerAPI	Exported	Official	.../org/openide/explorer/doc-files/api.html
TreeTableViewSortingAPI	Exported	Friend

Group of systemproperty interfaces

Interface Name	In/Out	Stability	Specified in What Document?
org.openide.explorer.VisualizerNode.prefetchCount	Exported	Private	Setting this property to integer number controls prefetching of nodes when VisualizerChildren are constructed (prefetchCount = 0 disables prefetching). The prefetching should eliminate "bounce" effect (see #144718) in lazy implementation which is caused by the fact that there exist keys without nodes. In such case "dummy" nodes are created and remove event is fired. This undesirable effect is eliminated by prefetching selected number of nodes so "dummy" nodes are detected and removed in advance before any visualization occurs.
netbeans.dnd.enabled	Exported	Private	Checks by Drag & Drop support for views. True is regard as default (no matter what jdk's version). False value disallows Drag & Drop in all views.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
customDelete	Exported	Under Development	Nodes returing Boolean.TRUE from getValue("customDelete") are assumed to provide their own confirmation dialog for delete action and explorer will not show default one when they are deleted.
slowRename	Exported	Under Development	Nodes returing Boolean.TRUE from getValue("slowRename") are expected to have potentially slow implemenation of setName. Explorer views rather process in-place rename in background for such nodes.

Implementation Details

Where are the sources for the module?

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

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

XXX no answer for deploy-dependencies

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