Package Summary  Overview Summary

class:DefaultTreeCellRenderer [NONE]

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, TreeCellRenderer

public class DefaultTreeCellRendererextends JLabel implements TreeCellRenderer
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.

The set of icons and colors used by DefaultTreeCellRenderer can be configured using the various setter methods. The value for each property is initialized from the defaults table. When the look and feel changes (updateUI is invoked), any properties that have a value of type UIResource are refreshed from the defaults table. The following table lists the mapping between DefaultTreeCellRenderer property and defaults table key:
Properties
PropertyKey
"leafIcon""Tree.leafIcon"
"closedIcon""Tree.closedIcon"
"openIcon""Tree.openIcon"
"textSelectionColor""Tree.selectionForeground"
"textNonSelectionColor""Tree.textForeground"
"backgroundSelectionColor""Tree.selectionBackground"
"backgroundNonSelectionColor""Tree.textBackground"
"borderSelectionColor""Tree.selectionBorderColor"

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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.

field:selected [NONE]

  • selected

    protected boolean selected
    Is the value currently selected.
  • field:hasFocus [NONE]

    hasFocus

    protected boolean hasFocus
    True if has focus.

    field:closedIcon [NONE]

    closedIcon

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

    field:leafIcon [NONE]

    leafIcon

    protected transient  Icon leafIcon
    Icon used to show leaf nodes.

    field:openIcon [NONE]

    openIcon

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

    field:textSelectionColor [NONE]

    textSelectionColor

    protected Color textSelectionColor
    Color to use for the foreground for selected nodes.

    field:textNonSelectionColor [NONE]

    textNonSelectionColor

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

    field:backgroundSelectionColor [NONE]

    backgroundSelectionColor

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

    field:backgroundNonSelectionColor [NONE]

    backgroundNonSelectionColor

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

    field:borderSelectionColor [NONE]

    borderSelectionColor

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

    constructor:DefaultTreeCellRenderer() [NONE]

    • DefaultTreeCellRenderer

      public DefaultTreeCellRenderer()
      Creates a DefaultTreeCellRenderer. Icons and text color are determined from the UIManager.

    method:updateUI() [NONE]

  • updateUI

    public void updateUI()
    Resets the UI property to a value from the current look and feel.
    Overrides:
    updateUI in class JLabel
    Since:
    1.7
    See Also:
  • method:getDefaultOpenIcon() [NONE]

    getDefaultOpenIcon

    public Icon getDefaultOpenIcon()
    Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.
    Returns:
    the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.

    method:getDefaultClosedIcon() [NONE]

    getDefaultClosedIcon

    public Icon getDefaultClosedIcon()
    Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.
    Returns:
    the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.

    method:getDefaultLeafIcon() [NONE]

    getDefaultLeafIcon

    public Icon getDefaultLeafIcon()
    Returns the default icon, for the current laf, that is used to represent leaf nodes.
    Returns:
    the default icon, for the current laf, that is used to represent leaf nodes.

    method:setOpenIcon(javax.swing.Icon) [NONE]

    setOpenIcon

    public void setOpenIcon (Icon newIcon)
    Sets the icon used to represent non-leaf nodes that are expanded.
    Parameters:
    newIcon - the icon to be used for expanded non-leaf nodes

    method:getOpenIcon() [NONE]

    getOpenIcon

    public Icon getOpenIcon()
    Returns the icon used to represent non-leaf nodes that are expanded.
    Returns:
    the icon used to represent non-leaf nodes that are expanded

    method:setClosedIcon(javax.swing.Icon) [NONE]

    setClosedIcon

    public void setClosedIcon (Icon newIcon)
    Sets the icon used to represent non-leaf nodes that are not expanded.
    Parameters:
    newIcon - the icon to be used for not expanded non-leaf nodes

    method:getClosedIcon() [NONE]

    getClosedIcon

    public Icon getClosedIcon()
    Returns the icon used to represent non-leaf nodes that are not expanded.
    Returns:
    the icon used to represent non-leaf nodes that are not expanded

    method:setLeafIcon(javax.swing.Icon) [NONE]

    setLeafIcon

    public void setLeafIcon (Icon newIcon)
    Sets the icon used to represent leaf nodes.
    Parameters:
    newIcon - icon to be used for leaf nodes

    method:getLeafIcon() [NONE]

    getLeafIcon

    public Icon getLeafIcon()
    Returns the icon used to represent leaf nodes.
    Returns:
    the icon used to represent leaf nodes

    method:setTextSelectionColor(java.awt.Color) [NONE]

    setTextSelectionColor

    public void setTextSelectionColor (Color newColor)
    Sets the color the text is drawn with when the node is selected.
    Parameters:
    newColor - color to be used for text when the node is selected

    method:getTextSelectionColor() [NONE]

    getTextSelectionColor

    public Color getTextSelectionColor()
    Returns the color the text is drawn with when the node is selected.
    Returns:
    the color the text is drawn with when the node is selected

    method:setTextNonSelectionColor(java.awt.Color) [NONE]

    setTextNonSelectionColor

    public void setTextNonSelectionColor (Color newColor)
    Sets the color the text is drawn with when the node isn't selected.
    Parameters:
    newColor - color to be used for text when the node isn't selected

    method:getTextNonSelectionColor() [NONE]

    getTextNonSelectionColor

    public Color getTextNonSelectionColor()
    Returns the color the text is drawn with when the node isn't selected.
    Returns:
    the color the text is drawn with when the node isn't selected.

    method:setBackgroundSelectionColor(java.awt.Color) [NONE]

    setBackgroundSelectionColor

    public void setBackgroundSelectionColor (Color newColor)
    Sets the color to use for the background if node is selected.
    Parameters:
    newColor - to be used for the background if the node is selected

    method:getBackgroundSelectionColor() [NONE]

    getBackgroundSelectionColor

    public Color getBackgroundSelectionColor()
    Returns the color to use for the background if node is selected.
    Returns:
    the color to use for the background if node is selected

    method:setBackgroundNonSelectionColor(java.awt.Color) [NONE]

    setBackgroundNonSelectionColor

    public void setBackgroundNonSelectionColor (Color newColor)
    Sets the background color to be used for non selected nodes.
    Parameters:
    newColor - color to be used for the background for non selected nodes

    method:getBackgroundNonSelectionColor() [NONE]

    getBackgroundNonSelectionColor

    public Color getBackgroundNonSelectionColor()
    Returns the background color to be used for non selected nodes.
    Returns:
    the background color to be used for non selected nodes.

    method:setBorderSelectionColor(java.awt.Color) [NONE]

    setBorderSelectionColor

    public void setBorderSelectionColor (Color newColor)
    Sets the color to use for the border.
    Parameters:
    newColor - color to be used for the border

    method:getBorderSelectionColor() [NONE]

    getBorderSelectionColor

    public Color getBorderSelectionColor()
    Returns the color the border is drawn.
    Returns:
    the color the border is drawn

    method:setFont(java.awt.Font) [NONE]

    setFont

    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.
    Overrides:
    setFont in class JComponent
    Parameters:
    font - the desired Font for this component
    See Also:

    method:getFont() [NONE]

    getFont

    public Font getFont()
    Gets the font of this component.
    Specified by:
    getFont in interface MenuContainer
    Overrides:
    getFont in class Component
    Returns:
    this component's font; if a font has not been set for this component, the font of its parent is returned
    See Also:

    method:setBackground(java.awt.Color) [NONE]

    setBackground

    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.
    Overrides:
    setBackground in class JComponent
    Parameters:
    color - the desired background Color
    See Also:

    method:getTreeCellRendererComponent(javax.swing.JTree,java.lang.Object,boolean,boolean,boolean,int,boolean) [NONE]

    getTreeCellRendererComponent

    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.
    Specified by:
    getTreeCellRendererComponent in interface TreeCellRenderer
    Parameters:
    tree - the receiver is being configured for
    value - the value to render
    sel - whether node is selected
    expanded - whether node is expanded
    leaf - whether node is a lead node
    row - row index
    hasFocus - whether node has focus
    Returns:
    the Component that the renderer uses to draw the value

    method:paint(java.awt.Graphics) [NONE]

    paint

    public void paint (Graphics g)
    Paints the value. The background is filled based on selected.
    Overrides:
    paint in class JComponent
    Parameters:
    g - the Graphics context in which to paint
    See Also:

    method:getPreferredSize() [NONE]

    getPreferredSize

    public Dimension getPreferredSize()
    Overrides JComponent.getPreferredSize to return slightly wider preferred size value.
    Overrides:
    getPreferredSize in class JComponent
    Returns:
    the value of the preferredSize property
    See Also:

    method:validate() [NONE]

    validate

    public void validate()
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    validate in class Container
    See Also:

    method:invalidate() [NONE]

    invalidate

    public void invalidate()
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    invalidate in class Container
    Since:
    1.5
    See Also:

    method:revalidate() [NONE]

    revalidate

    public void revalidate()
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    revalidate in class JComponent
    See Also:

    method:repaint(long,int,int,int,int) [NONE]

    repaint

    public void repaint (long tm, int x, int y, int width, int height)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    repaint in class JComponent
    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
    See Also:

    method:repaint(java.awt.Rectangle) [NONE]

    repaint

    public void repaint (Rectangle r)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    repaint in class JComponent
    Parameters:
    r - a Rectangle containing the dirty region
    See Also:

    method:repaint() [NONE]

    repaint

    public void repaint()
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    repaint in class Component
    Since:
    1.5
    See Also:

    method:firePropertyChange(java.lang.String,java.lang.Object,java.lang.Object) [NONE]

    firePropertyChange

    protected void firePropertyChange (String propertyName, Object oldValue, Object newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class Component
    Parameters:
    propertyName - the property whose value has changed
    oldValue - the property's previous value
    newValue - the property's new value

    method:firePropertyChange(java.lang.String,byte,byte) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, byte oldValue, byte newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class Component
    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)
    See Also:

    method:firePropertyChange(java.lang.String,char,char) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, char oldValue, char newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class JComponent
    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)
    See Also:

    method:firePropertyChange(java.lang.String,short,short) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, short oldValue, short newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class Component
    Parameters:
    propertyName - the programmatic name of the property that was changed
    oldValue - the old value of the property (as a short)
    newValue - the new value of the property (as a short)
    See Also:

    method:firePropertyChange(java.lang.String,int,int) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, int oldValue, int newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class JComponent
    Parameters:
    propertyName - the property whose value has changed
    oldValue - the property's previous value
    newValue - the property's new value

    method:firePropertyChange(java.lang.String,long,long) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, long oldValue, long newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class Component
    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)
    See Also:

    method:firePropertyChange(java.lang.String,float,float) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, float oldValue, float newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class Component
    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)
    See Also:

    method:firePropertyChange(java.lang.String,double,double) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, double oldValue, double newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class Component
    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)
    See Also:

    method:firePropertyChange(java.lang.String,boolean,boolean) [NONE]

    firePropertyChange

    public void firePropertyChange (String propertyName, boolean oldValue, boolean newValue)
    Overridden for performance reasons. See the Implementation Note for more information.
    Overrides:
    firePropertyChange in class JComponent
    Parameters:
    propertyName - the property whose value has changed
    oldValue - the property's previous value
    newValue - the property's new value

    © 2023 Oracle Corporation and/or its affiliates