projectviewer.gui

Interface NodePropertyProvider

public interface NodePropertyProvider

Defines the interface for providing custom properties about a node. When showing the node properties dialog, a new tab will be created for each available provider.

Since:

PV 3.0.0

Author:

Marcelo Vanzin

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Component	getComponent(VPTNode node) Returns the component containing the UI for the properties of the given node.
java.lang.String	getTitle() Returns the title of the tab containing this provider's information.
boolean	isNodeSupported(VPTNode node) Returns whether this provider can show information for the given node.

Method Detail

isNodeSupported

boolean isNodeSupported(VPTNode node)

Returns whether this provider can show information for the given node. If the node is not supported, no tab for this provides is created in the UI.

Parameters:

node - The node.

Returns:

Whether a tab should be shown for this provider.

getTitle

java.lang.String getTitle()

Returns the title of the tab containing this provider's information.

getComponent

java.awt.Component getComponent(VPTNode node)

Returns the component containing the UI for the properties of the given node. This method is only called when the provider's tab is activated by the user, and is only called once for each invocation of the dialog.

Parameters:

node - The node.

Returns:

A UI component to be shown in the properties dialog.