org.apache.excalibur.instrument.client

Class NodeData

java.lang.Object

org.apache.excalibur.instrument.client.NodeData

Direct Known Subclasses:

InstrumentableNodeData, InstrumentNodeData, InstrumentSampleNodeData

abstract class NodeData
extends java.lang.Object

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.swing.JMenuItem[]	EMPTY_MENU_ITEM_ARRAY
private java.lang.String	m_description
private java.lang.String	m_name
private int	m_stateVersion
protected static java.lang.String	MEDIA_PATH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeData()

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem[]	getCommonMenuItems() Returns an array of any menu items which will be displayed both in a popup menu and in the menus.
(package private) java.lang.String	getDescription()
(package private) abstract javax.swing.ImageIcon	getIcon() Get the icon to display for the node.
(package private) java.lang.String	getName()
javax.swing.JPopupMenu	getPopupMenu() Return the popup for the node.
(package private) int	getStateVersion()
(package private) abstract java.lang.String	getToolTipText() Return the text to use for a tool tip on this node.
(package private) void	select() Called when the node is selected.
(package private) void	setDescription(java.lang.String description)
java.lang.String	toString()
(package private) boolean	update(java.lang.String name, java.lang.String description, int stateVersion)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MEDIA_PATH

protected static final java.lang.String MEDIA_PATH

See Also:

Constant Field Values

EMPTY_MENU_ITEM_ARRAY

protected static final javax.swing.JMenuItem[] EMPTY_MENU_ITEM_ARRAY

m_name

private java.lang.String m_name

m_description

private java.lang.String m_description

m_stateVersion

private int m_stateVersion

Constructor Detail

NodeData

protected NodeData()

Method Detail

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String description)

getStateVersion

int getStateVersion()

getIcon

abstract javax.swing.ImageIcon getIcon()

Get the icon to display for the node.

Returns:

the icon to display for the node.

getToolTipText

abstract java.lang.String getToolTipText()

Return the text to use for a tool tip on this node.

Returns:

Tool Tip text. May be null, for no tool tip.

getPopupMenu

public javax.swing.JPopupMenu getPopupMenu()

Return the popup for the node.

Returns:

The the popup for the node.

getCommonMenuItems

public javax.swing.JMenuItem[] getCommonMenuItems()

Returns an array of any menu items which will be displayed both in a popup menu and in the menus.

Returns:

An array of the common menu items.

select

void select()

Called when the node is selected.

update

boolean update(java.lang.String name,
             java.lang.String description,
             int stateVersion)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object