JavaTM 2 Platform
Std. Ed. v1.3

javax.swing.tree
Class DefaultTreeCellRenderer

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JLabel
                          |
                          +--javax.swing.tree.DefaultTreeCellRenderer
All Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable, SwingConstants, TreeCellRenderer

public class DefaultTreeCellRenderer
extends JLabel
implements TreeCellRenderer

Displays an entry in a tree. See How to Use Trees in The Java Tutorial for examples of customizing node display using this class.

Implementation Note: This class overrides 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. A future release of Swing will provide support for long term persistence.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JLabel
JLabel.AccessibleJLabel
 
Inner classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
Component.AccessibleAWTComponent
 
Field Summary
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 background when the node isn't selected.
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.
 
Fields inherited from class javax.swing.JLabel
labelFor
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
DefaultTreeCellRenderer()
          Returns a new instance of DefaultTreeCellRenderer.
 
Method Summary
 void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, byte oldValue, byte newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, char oldValue, char newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, double oldValue, double newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, float oldValue, float newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, int oldValue, int newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, long oldValue, long newValue)
          Overridden for performance reasons.
protected  void firePropertyChange(String propertyName, Object oldValue, Object newValue)
          Overridden for performance reasons.
 void firePropertyChange(String propertyName, short oldValue, short 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.
 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 paint(Graphics g)
          Paints the value.
 void repaint(long tm, int x, int y, int width, int height)
          Overridden for performance reasons.
 void repaint(Rectangle r)
          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.
 
Methods inherited from class javax.swing.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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 background when the node isn't selected.
Constructor Detail

DefaultTreeCellRenderer

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

getDefaultOpenIcon

public Icon getDefaultOpenIcon()
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.

getDefaultLeafIcon

public Icon getDefaultLeafIcon()
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.

getOpenIcon

public Icon getOpenIcon()
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.

getClosedIcon

public Icon getClosedIcon()
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.

getLeafIcon

public Icon getLeafIcon()
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.

getTextSelectionColor

public Color getTextSelectionColor()
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.

getTextNonSelectionColor

public Color getTextNonSelectionColor()
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.

getBackgroundSelectionColor

public Color getBackgroundSelectionColor()
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.

getBackgroundNonSelectionColor

public Color getBackgroundNonSelectionColor()
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.

getBorderSelectionColor

public Color getBorderSelectionColor()
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
Following copied from class: javax.swing.JComponent
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
Following copied from class: javax.swing.JComponent
See Also:
Component.getBackground()

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 on leaf and expanded.
Specified by:
getTreeCellRendererComponent in interface TreeCellRenderer
Following copied from interface: javax.swing.tree.TreeCellRenderer
Returns:
Component that the renderer uses to draw the value.

paint

public void paint(Graphics g)
Paints the value. The background is filled based on selected.
Overrides:
paint in class JComponent
Following copied from class: javax.swing.JComponent
See Also:
JComponent.paintComponent(java.awt.Graphics), JComponent.paintBorder(java.awt.Graphics), JComponent.paintChildren(java.awt.Graphics), JComponent.getComponentGraphics(java.awt.Graphics), JComponent.repaint(long, int, int, int, int)

getPreferredSize

public Dimension getPreferredSize()
Overrides JComponent.getPreferredSize to return slightly wider preferred size value.
Overrides:
getPreferredSize in class JComponent
Following copied from class: javax.swing.JComponent
Returns:
the value of the preferredSize property
See Also:
JComponent.setPreferredSize(java.awt.Dimension)

validate

public void validate()
Overridden for performance reasons. See the Implementation Note for more information.
Overrides:
validate in class Container
Following copied from class: java.awt.Container
See Also:
Container.validate(), Component.invalidate()

revalidate

public void revalidate()
Overridden for performance reasons. See the Implementation Note for more information.
Overrides:
revalidate in class JComponent
Following copied from class: javax.swing.JComponent
See Also:
Component.invalidate(), Container.validate(), JComponent.isValidateRoot(), RepaintManager.addInvalidComponent(javax.swing.JComponent)

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
Following copied from class: javax.swing.JComponent
See Also:
Component.isShowing(), RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)

repaint

public void repaint(Rectangle r)
Overridden for performance reasons. See the Implementation Note for more information.
Overrides:
repaint in class JComponent
Following copied from class: javax.swing.JComponent
See Also:
Component.isShowing(), RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)

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 JComponent
Following copied from class: javax.swing.JComponent
Parameters:
propertyName - the programmatic name of the property that was changed
oldValue - the old value of the property
newValue - the new value of the property
See Also:
PropertyChangeSupport

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 JComponent
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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 JComponent
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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 JComponent
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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 JComponent
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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 JComponent
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

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
Following copied from class: javax.swing.JComponent
See Also:
JComponent.firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)

JavaTM 2 Platform
Std. Ed. v1.3

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.