NodeModelFilter (NetBeans View Model) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.viewmodel
Interface NodeModelFilter

All Superinterfaces:: Model

public interface NodeModelFilter
extends Model

Filters content of some existing NodeModel. You can change display name, tooltip, or icon for some existing object here.

Method Summary

void addModelListener(ModelListener l)
          Registers given listener.

String getDisplayName(NodeModel original, Object node)
          Returns filterred display name for given node.

String getIconBase(NodeModel original, Object node)
          Returns filterred icon for given node.

String getShortDescription(NodeModel original, Object node)
          Returns filterred tooltip for given node.

void removeModelListener(ModelListener l)
          Unregisters given listener.

Method Detail

getDisplayName

public String getDisplayName(NodeModel original,
                             Object node)
                      throws UnknownTypeException

Returns filterred display name for given node. You should not throw UnknownTypeException directly from this method!

Returns:: display name for given node
Throws:: UnknownTypeException - this exception can be thrown from original.getDisplayName (...) method call only!

getIconBase

public String getIconBase(NodeModel original,
                          Object node)
                   throws UnknownTypeException

Returns filterred icon for given node. You should not throw UnknownTypeException directly from this method!

Returns:: icon for given node
Throws:: UnknownTypeException - this exception can be thrown from original.getIconBase (...) method call only!

getShortDescription

public String getShortDescription(NodeModel original,
                                  Object node)
                           throws UnknownTypeException

Returns filterred tooltip for given node. You should not throw UnknownTypeException directly from this method!

Returns:: tooltip for given node
Throws:: UnknownTypeException - this exception can be thrown from original.getShortDescription (...) method call only!

addModelListener

public void addModelListener(ModelListener l)

Registers given listener.

Parameters:: l - the listener to add

removeModelListener

public void removeModelListener(ModelListener l)

Unregisters given listener.

Parameters:: l - the listener to remove