org.netbeans.spi.navigator

Interface NavigatorPanel

All Known Subinterfaces:

NavigatorPanelWithToolbar, NavigatorPanelWithUndo

public interface NavigatorPanel

Navigation related view description. Implementors of this interface will be plugged into Navigator UI.

See Also:

NavigatorPanel.Registration

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NavigatorPanel.DynamicRegistration Dynamically create panels for files.
static interface	NavigatorPanel.Registration Registers a navigator panel.
static interface	NavigatorPanel.Registrations Used in case multiple registrations are needed in one place.

Method Summary

Modifier and Type	Method and Description
JComponent	getComponent() JComponent representation of this view.
String	getDisplayHint() Description of the view, explaining main purpose of the view.
String	getDisplayName() Name of the view which will be shown in navigator UI.
Lookup	getLookup() Returns Lookup that will be integrated into Lookup of Navigator UI TopComponent.
void	panelActivated(Lookup context) Called when this panel's component is about to being displayed.
void	panelDeactivated() Called when this panel's component is about to being hidden.

Method Detail

getDisplayName

String getDisplayName()

Name of the view which will be shown in navigator UI.

Returns:

Displayable name of the view

getDisplayHint

String getDisplayHint()

Description of the view, explaining main purpose of the view. Currently unused.

Returns:

String description of the view.

getComponent

JComponent getComponent()

JComponent representation of this view. System will ask multiple times and it is strongly recommended to return the same JComponent instance each call for performance reasons.

This method is always called in event dispatch thread.

Returns:

JComponent representation of this view.

panelActivated

void panelActivated(Lookup context)

Called when this panel's component is about to being displayed. Right place to attach listeners to current navigation data context, as clients are responsible for listening to context changes when active (in the time between panelActivated - panelDeactivated calls). This method is always called in event dispatch thread.

Parameters:

context - Lookup instance representing current context to take data from

panelDeactivated

void panelDeactivated()

Called when this panel's component is about to being hidden. Right place to detach, remove listeners from data context, that were added in panelActivated impl. This method is always called in event dispatch thread.

getLookup

Lookup getLookup()

Returns Lookup that will be integrated into Lookup of Navigator UI TopComponent. Allows clients to achieve several things:

1) Specify activated Node of Navigator UI TopComponent when this panel is active.
If returned lookup contains Nodes, they will act as activated nodes of Navigator UI TopComponent (navigator window).
Method may return null, signalizing that default mechanism should be enabled. Default mechanism chooses first Node from Utilities.actionsGlobalContext() (current system-wide activated Node) as activated Node for Navigator's TopComponent.

2) Enable support for Toolbar or main menu global actions in NavigatorPanel.
ActionMap contained in this Lookup will be part of Utilities.actionsGlobalContext() when Navigator UI TopComponent (navigator window) is active in the system.

Returns:

Lookup instance or null