NodeList (Project UI API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.projectuiapi/1 1.24.0 6

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.project.ui.support
Interface NodeList<K>

public interface NodeList<K>

Represents a series of nodes which can be spliced into a children list.

Since:: org.netbeans.modules.projectuiapi/1 1.18
See Also:: NodeFactory, NodeFactorySupport, Children.Keys

Method Summary

void addChangeListener(ChangeListener l)
          Adds a listener to a change in keys.

void addNotify()
          Called when the node list is to be active.

List<K> keys()
          Obtains child keys which will be passed to node(K).

Node node(K key)
          Creates a node for a given key.

void removeChangeListener(ChangeListener l)
          Removes a change listener.

void removeNotify()
          Called when the node list is to be deactivated.

Method Summary
`void`	`addChangeListener(ChangeListener l)` Adds a listener to a change in keys.
`void`	`addNotify()` Called when the node list is to be active.
`List<K>`	`keys()` Obtains child keys which will be passed to `node(K)`.
`Node`	`node(K key)` Creates a node for a given key.
`void`	`removeChangeListener(ChangeListener l)` Removes a change listener.
`void`	`removeNotify()` Called when the node list is to be deactivated.

Method Detail

keys

List<K> keys()

Obtains child keys which will be passed to node(K). If there is a change in the set of keys based on external events, fire a ChangeEvent.

Returns:: list of zero or more keys to display

addChangeListener

void addChangeListener(ChangeListener l)

Adds a listener to a change in keys.

Parameters:: l - a listener to add

removeChangeListener

void removeChangeListener(ChangeListener l)

Removes a change listener.

Parameters:: l - a listener to remove

node

Node node(K key)

Creates a node for a given key.

Parameters:: key - a key which was included in keys()
Returns:: a node which should represent that key visually

addNotify

void addNotify()

Called when the node list is to be active. If there is any need to register listeners or begin caching of state, do it here.

See Also:: Children.addNotify()

removeNotify

void removeNotify()

Called when the node list is to be deactivated. Unregister any listeners and perform any general cleanup.

See Also:: Children.removeNotify()