Module java.desktop
Package javax.swing.tree

Class DefaultTreeCellRenderer

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants, TreeCellRenderer
    public class DefaultTreeCellRenderer
extends 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
    Property Key
    "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 Detail

      • selected

        protected boolean selected
        Is the value currently selected.

      • hasFocus

        protected boolean hasFocus
        True if has focus.

      • closedIcon

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

      • leafIcon

        protected transient Icon leafIcon
        Icon used to show leaf nodes.

      • openIcon

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

      • textSelectionColor

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

      • textNonSelectionColor

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

      • backgroundSelectionColor

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

      • backgroundNonSelectionColor

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

      • borderSelectionColor

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

    • Constructor Detail

      • DefaultTreeCellRenderer

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

    • Method Detail

      • 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:
        JComponent.updateUI()

      • 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.

      • 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.

      • 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.

      • 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

      • 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

      • 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

      • 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

      • setLeafIcon

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

      • getLeafIcon

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

      • 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

      • 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

      • 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

      • 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.

      • 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

      • 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

      • 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

      • 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.

      • setBorderSelectionColor

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

      • getBorderSelectionColor

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

      • 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:
        Component.getFont()

      • 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:
        Component.getBackground(), JComponent.setOpaque(boolean)

      • 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

      • 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

      • 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

      • 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