javax.swing.tree

Class DefaultTreeCellRenderer

public class DefaultTreeCellRenderer extends JLabel implements TreeCellRenderer

A default implementation of the {@link TreeCellRenderer} interface.

Field Summary
protected Color	backgroundNonSelectionColor The background color for non-selected cells.
protected Color	backgroundSelectionColor The background color for selected cells.
protected Color	borderSelectionColor The border color for selected tree cells.
protected Icon	closedIcon The icon used to represent non-leaf nodes that are closed.
protected boolean	hasFocus A flag indicating the current focus status.
protected Icon	leafIcon The icon used to represent leaf nodes.
protected Icon	openIcon The icon used to represent non-leaf nodes that are open.
protected boolean	selected A flag indicating the current selection status.
protected Color	textNonSelectionColor The color used for text in non-selected cells.
protected Color	textSelectionColor The color used for text in selected cells.

Constructor Summary
	DefaultTreeCellRenderer() Creates a new tree cell renderer with defaults appropriate for the current {@link LookAndFeel}.

Method Summary
protected void	firePropertyChange(String name, Object oldValue, Object newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, byte oldValue, byte newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, char oldValue, char newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, short oldValue, short newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, int oldValue, int newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, long oldValue, long newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, float oldValue, float newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, double oldValue, double newValue) For performance reasons, this method is overridden to do nothing.
void	firePropertyChange(String name, boolean oldValue, boolean newValue) For performance reasons, this method is overridden to do nothing.
Color	getBackgroundNonSelectionColor() Returns the background color for tree cells that are not selected.
Color	getBackgroundSelectionColor() Returns the background color for tree cells that are selected.
Color	getBorderSelectionColor() Returns the border color for tree cells that are selected.
Icon	getClosedIcon() Returns the icon displayed for non-leaf nodes that are closed.
Icon	getDefaultClosedIcon() Returns the default icon for non-leaf tree cells that are closed (not expanded).
Icon	getDefaultLeafIcon() Returns the default icon for leaf tree cells.
Icon	getDefaultOpenIcon() Returns the default icon for non-leaf tree cells that are open (expanded).
Font	getFont() Returns the current font.
Icon	getLeafIcon() Returns the icon displayed for leaf nodes.
Icon	getOpenIcon() Returns the icon displayed for non-leaf nodes that are open (expanded).
Dimension	getPreferredSize() Returns the preferred size of the cell.
Color	getTextNonSelectionColor() Returns the text color for tree cells that are not selected.
Color	getTextSelectionColor() Returns the text color for tree cells that are selected.
Component	getTreeCellRendererComponent(JTree tree, Object val, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) Returns a component (in fact `this`) that can be used to render a tree cell with the specified state.
void	paint(Graphics g) Paints the value.
void	repaint(long tm, int x, int y, int width, int height) For performance reasons, this method is overridden to do nothing.
void	repaint(Rectangle area) For performance reasons, this method is overridden to do nothing.
void	revalidate() For performance reasons, this method is overridden to do nothing.
void	setBackground(Color c) Sets the background color.
void	setBackgroundNonSelectionColor(Color c) Sets the background color for tree cells that are not selected.
void	setBackgroundSelectionColor(Color c) Sets the background color for tree cells that are selected.
void	setBorderSelectionColor(Color c) Sets the border color for tree cells that are selected.
void	setClosedIcon(Icon icon) Sets the icon to be displayed for non-leaf nodes that are closed.
void	setFont(Font f) Sets the font.
void	setLeafIcon(Icon icon) Sets the icon to be displayed for leaf nodes.
void	setOpenIcon(Icon icon) Sets the icon to be displayed for non-leaf nodes that are open (expanded).
void	setTextNonSelectionColor(Color c) Sets the text color for tree cells that are not selected.
void	setTextSelectionColor(Color c) Sets the text color for tree cells that are selected.
void	validate() For performance reasons, this method is overridden to do nothing.

Field Detail

backgroundNonSelectionColor

protected Color backgroundNonSelectionColor

The background color for non-selected cells.

backgroundSelectionColor

protected Color backgroundSelectionColor

The background color for selected cells.

borderSelectionColor

protected Color borderSelectionColor

The border color for selected tree cells.

closedIcon

protected transient Icon closedIcon

The icon used to represent non-leaf nodes that are closed.

hasFocus

protected boolean hasFocus

A flag indicating the current focus status.

leafIcon

protected transient Icon leafIcon

The icon used to represent leaf nodes.

openIcon

protected transient Icon openIcon

The icon used to represent non-leaf nodes that are open.

selected

protected boolean selected

A flag indicating the current selection status.

textNonSelectionColor

protected Color textNonSelectionColor

The color used for text in non-selected cells.

textSelectionColor

protected Color textSelectionColor

The color used for text in selected cells.

Constructor Detail

DefaultTreeCellRenderer

public DefaultTreeCellRenderer()

Creates a new tree cell renderer with defaults appropriate for the current {@link LookAndFeel}.

Method Detail

firePropertyChange

protected void firePropertyChange(String name, Object oldValue, Object newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, byte oldValue, byte newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, char oldValue, char newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, short oldValue, short newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, int oldValue, int newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, long oldValue, long newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, float oldValue, float newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, double oldValue, double newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

firePropertyChange

public void firePropertyChange(String name, boolean oldValue, boolean newValue)

For performance reasons, this method is overridden to do nothing.

Parameters: name the property name. oldValue the old value. newValue the new value.

getBackgroundNonSelectionColor

public Color getBackgroundNonSelectionColor()

Returns the background color for tree cells that are not selected. The default value is obtained from the {@link LookAndFeel} defaults table using the key Tree.textBackground.

Returns: The background color for tree cells that are not selected.

getBackgroundSelectionColor

public Color getBackgroundSelectionColor()

Returns the background color for tree cells that are selected. The default value is obtained from the {@link LookAndFeel} defaults table using the key Tree.selectionBackground.

Returns: The background color for tree cells that are selected.

getBorderSelectionColor

public Color getBorderSelectionColor()

Returns the border color for tree cells that are selected. The default value is obtained from the {@link LookAndFeel} defaults table using the key Tree.selectionBorderColor.

Returns: The border color for tree cells that are selected.

getClosedIcon

public Icon getClosedIcon()

Returns the icon displayed for non-leaf nodes that are closed. The default value is initialised from the {@link LookAndFeel}.

Returns: The closed icon (possibly null).

getDefaultClosedIcon

public Icon getDefaultClosedIcon()

Returns the default icon for non-leaf tree cells that are closed (not expanded). The icon is fetched from the defaults table for the current {@link LookAndFeel} using the key Tree.closedIcon.

Returns: The default icon.

getDefaultLeafIcon

public Icon getDefaultLeafIcon()

Returns the default icon for leaf tree cells. The icon is fetched from the defaults table for the current {@link LookAndFeel} using the key Tree.leafIcon.

Returns: The default icon.

getDefaultOpenIcon

public Icon getDefaultOpenIcon()

Returns the default icon for non-leaf tree cells that are open (expanded). The icon is fetched from the defaults table for the current {@link LookAndFeel} using the key Tree.openIcon.

Returns: The default icon.

getFont

public Font getFont()

Returns the current font.

Returns: The current font.

getLeafIcon

public Icon getLeafIcon()

Returns the icon displayed for leaf nodes. The default value is initialised from the {@link LookAndFeel}.

Returns: The leaf icon (possibly null).

getOpenIcon

public Icon getOpenIcon()

Returns the icon displayed for non-leaf nodes that are open (expanded). The default value is initialised from the {@link LookAndFeel}.

Returns: The open icon (possibly null).

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size of the cell.

Returns: The preferred size of the cell.

getTextNonSelectionColor

public Color getTextNonSelectionColor()

Returns the text color for tree cells that are not selected. The default value is obtained from the {@link LookAndFeel} defaults table using the key Tree.selectionForeground.

Returns: The background color for tree cells that are not selected.

getTextSelectionColor

public Color getTextSelectionColor()

Returns the text color for tree cells that are selected. The default value is obtained from the {@link LookAndFeel} defaults table using the key Tree.selectionForeground.

Returns: The text color for tree cells that are selected.

getTreeCellRendererComponent

public Component getTreeCellRendererComponent(JTree tree, Object val, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)

Returns a component (in fact this) that can be used to render a tree cell with the specified state.

Parameters: tree the tree that the cell belongs to. val the cell value. selected indicates whether or not the cell is selected. expanded indicates whether or not the cell is expanded. leaf indicates whether or not the cell is a leaf in the tree. row the row index. hasFocus indicates whether or not the cell has the focus.

Returns: this.

paint

public void paint(Graphics g)

Paints the value. The background is filled based on selected.

Parameters: g the graphics device.

repaint

public void repaint(long tm, int x, int y, int width, int height)

For performance reasons, this method is overridden to do nothing.

Parameters: tm ignored x coordinate of the region to mark as dirty y coordinate of the region to mark as dirty width dimension of the region to mark as dirty height dimension of the region to mark as dirty