org.netbeans.swing.outline

Interface RenderDataProvider

All Known Subinterfaces:

CheckRenderDataProvider

public interface RenderDataProvider

A class which can provide rendering data for the tree portion an Outline, such as converting values to text, providing tooltip text and icons. Makes it possible to provide most of the interesting data that affects display without needing to provide a custom cell renderer.

Method Summary

Modifier and Type	Method and Description
Color	getBackground(Object o) Get the background color to be used for rendering this node.
String	getDisplayName(Object o) Convert an object in the tree to the string that should be used to display its node
Color	getForeground(Object o) Get the foreground color to be used for rendering this node.
Icon	getIcon(Object o) Get an icon to be used for this object.
String	getTooltipText(Object o) Get a description for this object suitable for use in a tooltip.
boolean	isHtmlDisplayName(Object o) Returns true of the display name for this object should use HTML rendering (future support for integration of the lightweight HTML renderer into NetBeans).

Method Detail

getDisplayName

String getDisplayName(Object o)

Convert an object in the tree to the string that should be used to display its node

isHtmlDisplayName

boolean isHtmlDisplayName(Object o)

Returns true of the display name for this object should use HTML rendering (future support for integration of the lightweight HTML renderer into NetBeans).

getBackground

Color getBackground(Object o)

Get the background color to be used for rendering this node. Return null if the standard table background or selected color should be used.

getForeground

Color getForeground(Object o)

Get the foreground color to be used for rendering this node. Return null if the standard table foreground or selected foreground should be used.

getTooltipText

String getTooltipText(Object o)

Get a description for this object suitable for use in a tooltip. Return null if no tooltip is desired.

getIcon

Icon getIcon(Object o)

Get an icon to be used for this object. Return null if the look and feel's default tree folder/leaf icons should be used as appropriate.