public class

DefaultTreeCellRenderer

extends JLabel
implements TreeCellRenderer
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.JLabel
           ↳ javax.swing.tree.DefaultTreeCellRenderer
Known Direct Subclasses

Class Overview

Displays an entry in a tree. DefaultTreeCellRenderer is not opaque and unless you subclass paint you should not change this. See How to Use Trees in The Java Tutorial for examples of customizing node display using this class.

Implementation Note: This class overrides invalidate, validate, revalidate, repaint, and firePropertyChange solely to improve performance. If not overridden, these frequently called methods would execute code paths that are unnecessary for the default tree cell renderer. If you write your own renderer, take care to weigh the benefits and drawbacks of overriding these methods.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.SwingConstants
Fields
protected Color backgroundNonSelectionColor Color to use for the background when the node isn't selected.
protected Color backgroundSelectionColor Color to use for the background when a node is selected.
protected Color borderSelectionColor Color to use for the focus indicator when the node has focus.
protected Icon closedIcon Icon used to show non-leaf nodes that aren't expanded.
protected boolean hasFocus True if has focus.
protected Icon leafIcon Icon used to show leaf nodes.
protected Icon openIcon Icon used to show non-leaf nodes that are expanded.
protected boolean selected Is the value currently selected.
protected Color textNonSelectionColor Color to use for the foreground for non-selected nodes.
protected Color textSelectionColor Color to use for the foreground for selected nodes.
[Expand]
Inherited Fields
From class javax.swing.JLabel
From class javax.swing.JComponent
Public Constructors
DefaultTreeCellRenderer()
Returns a new instance of DefaultTreeCellRenderer.
Public Methods
void firePropertyChange(String propertyName, float oldValue, float newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, long oldValue, long newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, byte oldValue, byte newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, double oldValue, double newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, short oldValue, short newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, int oldValue, int newValue)
Overridden for performance reasons.
void firePropertyChange(String propertyName, char oldValue, char newValue)
Overridden for performance reasons.
Color getBackgroundNonSelectionColor()
Returns the background color to be used for non selected nodes.
Color getBackgroundSelectionColor()
Returns the color to use for the background if node is selected.
Color getBorderSelectionColor()
Returns the color the border is drawn.
Icon getClosedIcon()
Returns the icon used to represent non-leaf nodes that are not expanded.
Icon getDefaultClosedIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.
Icon getDefaultLeafIcon()
Returns the default icon, for the current laf, that is used to represent leaf nodes.
Icon getDefaultOpenIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.
Font getFont()
Gets the font of this component.
Icon getLeafIcon()
Returns the icon used to represent leaf nodes.
Icon getOpenIcon()
Returns the icon used to represent non-leaf nodes that are expanded.
Dimension getPreferredSize()
Overrides JComponent.getPreferredSize to return slightly wider preferred size value.
Color getTextNonSelectionColor()
Returns the color the text is drawn with when the node isn't selected.
Color getTextSelectionColor()
Returns the color the text is drawn with when the node is selected.
Component getTreeCellRendererComponent(JTree tree, Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus)
Configures the renderer based on the passed in components.
void invalidate()
Overridden for performance reasons.
void paint(Graphics g)
Paints the value.
void repaint()
Overridden for performance reasons.
void repaint(Rectangle r)
Overridden for performance reasons.
void repaint(long tm, int x, int y, int width, int height)
Overridden for performance reasons.
void revalidate()
Overridden for performance reasons.
void setBackground(Color color)
Subclassed to map ColorUIResources to null.
void setBackgroundNonSelectionColor(Color newColor)
Sets the background color to be used for non selected nodes.
void setBackgroundSelectionColor(Color newColor)
Sets the color to use for the background if node is selected.
void setBorderSelectionColor(Color newColor)
Sets the color to use for the border.
void setClosedIcon(Icon newIcon)
Sets the icon used to represent non-leaf nodes that are not expanded.
void setFont(Font font)
Subclassed to map FontUIResources to null.
void setLeafIcon(Icon newIcon)
Sets the icon used to represent leaf nodes.
void setOpenIcon(Icon newIcon)
Sets the icon used to represent non-leaf nodes that are expanded.
void setTextNonSelectionColor(Color newColor)
Sets the color the text is drawn with when the node isn't selected.
void setTextSelectionColor(Color newColor)
Sets the color the text is drawn with when the node is selected.
void validate()
Overridden for performance reasons.
Protected Methods
void firePropertyChange(String propertyName, Object oldValue, Object newValue)
Overridden for performance reasons.
[Expand]
Inherited Methods
From class javax.swing.JLabel
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible
From interface javax.swing.tree.TreeCellRenderer

Fields

protected Color backgroundNonSelectionColor

Color to use for the background when the node isn't selected.

protected Color backgroundSelectionColor

Color to use for the background when a node is selected.

protected Color borderSelectionColor

Color to use for the focus indicator when the node has focus.

protected Icon closedIcon

Icon used to show non-leaf nodes that aren't expanded.

protected boolean hasFocus

True if has focus.

protected Icon leafIcon

Icon used to show leaf nodes.

protected Icon openIcon

Icon used to show non-leaf nodes that are expanded.

protected boolean selected

Is the value currently selected.

protected Color textNonSelectionColor

Color to use for the foreground for non-selected nodes.

protected Color textSelectionColor

Color to use for the foreground for selected nodes.

Public Constructors

public DefaultTreeCellRenderer ()

Returns a new instance of DefaultTreeCellRenderer. Alignment is set to left aligned. Icons and text color are determined from the UIManager.

Public Methods

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the programmatic name of the property that was changed
oldValue the old value of the property (as a float)
newValue the new value of the property (as a float)

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the programmatic name of the property that was changed
oldValue the old value of the property (as a long)
newValue the new value of the property (as a long)

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the programmatic name of the property that was changed
oldValue the old value of the property (as a byte)
newValue the new value of the property (as a byte)

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the property whose value has changed
oldValue the property's previous value
newValue the property's new value

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the programmatic name of the property that was changed
oldValue the old value of the property (as a double)
newValue the new value of the property (as a double)

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the programmatic name of the property that was changed
oldValue the old value of the property (as a short)
newValue the old value of the property (as a short)

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the property whose value has changed
oldValue the property's previous value
newValue the property's new value

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the programmatic name of the property that was changed
oldValue the old value of the property (as a char)
newValue the new value of the property (as a char)

public Color getBackgroundNonSelectionColor ()

Returns the background color to be used for non selected nodes.

public Color getBackgroundSelectionColor ()

Returns the color to use for the background if node is selected.

public Color getBorderSelectionColor ()

Returns the color the border is drawn.

public Icon getClosedIcon ()

Returns the icon used to represent non-leaf nodes that are not expanded.

public Icon getDefaultClosedIcon ()

Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.

public Icon getDefaultLeafIcon ()

Returns the default icon, for the current laf, that is used to represent leaf nodes.

public Icon getDefaultOpenIcon ()

Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.

public Font getFont ()

Gets the font of this component.

Returns
  • this component's font; if a font has not been set for this component, the font of its parent is returned

public Icon getLeafIcon ()

Returns the icon used to represent leaf nodes.

public Icon getOpenIcon ()

Returns the icon used to represent non-leaf nodes that are expanded.

public Dimension getPreferredSize ()

Overrides JComponent.getPreferredSize to return slightly wider preferred size value.

Returns
  • the value of the preferredSize property

public Color getTextNonSelectionColor ()

Returns the color the text is drawn with when the node isn't selected.

public Color getTextSelectionColor ()

Returns the color the text is drawn with when the node is selected.

public Component getTreeCellRendererComponent (JTree tree, Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus)

Configures the renderer based on the passed in components. The value is set from messaging the tree with convertValueToText, which ultimately invokes toString on value. The foreground color is set based on the selection and the icon is set based on the leaf and expanded parameters.

Returns
  • the Component that the renderer uses to draw the value

public void invalidate ()

Overridden for performance reasons. See the Implementation Note for more information.

public void paint (Graphics g)

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

Parameters
g the Graphics context in which to paint

public void repaint ()

Overridden for performance reasons. See the Implementation Note for more information.

public void repaint (Rectangle r)

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
r a Rectangle containing the dirty region

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
tm this parameter is not used
x the x value of the dirty region
y the y value of the dirty region
width the width of the dirty region
height the height of the dirty region

public void revalidate ()

Overridden for performance reasons. See the Implementation Note for more information.

public void setBackground (Color color)

Subclassed to map ColorUIResources to null. If color is null, or a ColorUIResource, this has the effect of letting the background color of the JTree show through. On the other hand, if color is non-null, and not a ColorUIResource, the background becomes color.

Parameters
color the desired background Color

public void setBackgroundNonSelectionColor (Color newColor)

Sets the background color to be used for non selected nodes.

public void setBackgroundSelectionColor (Color newColor)

Sets the color to use for the background if node is selected.

public void setBorderSelectionColor (Color newColor)

Sets the color to use for the border.

public void setClosedIcon (Icon newIcon)

Sets the icon used to represent non-leaf nodes that are not expanded.

public void setFont (Font font)

Subclassed to map FontUIResources to null. If font is null, or a FontUIResource, this has the effect of letting the font of the JTree show through. On the other hand, if font is non-null, and not a FontUIResource, the font becomes font.

Parameters
font the desired Font for this component

public void setLeafIcon (Icon newIcon)

Sets the icon used to represent leaf nodes.

public void setOpenIcon (Icon newIcon)

Sets the icon used to represent non-leaf nodes that are expanded.

public void setTextNonSelectionColor (Color newColor)

Sets the color the text is drawn with when the node isn't selected.

public void setTextSelectionColor (Color newColor)

Sets the color the text is drawn with when the node is selected.

public void validate ()

Overridden for performance reasons. See the Implementation Note for more information.

Protected Methods

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

Overridden for performance reasons. See the Implementation Note for more information.

Parameters
propertyName the property whose value has changed
oldValue the property's previous value
newValue the property's new value