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:
| 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.
JLabel.AccessibleJLabel JComponent.AccessibleJComponent Container.AccessibleAWTContainer Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy protected boolean selected
Is the value currently selected.
protected boolean hasFocus
True if has focus.
protected transient Icon closedIcon
Icon used to show non-leaf nodes that aren't expanded.
protected transient Icon leafIcon
Icon used to show leaf nodes.
protected transient Icon openIcon
Icon used to show non-leaf nodes that are expanded.
protected Color textSelectionColor
Color to use for the foreground for selected nodes.
protected Color textNonSelectionColor
Color to use for the foreground for non-selected nodes.
protected Color backgroundSelectionColor
Color to use for the background when a node is selected.
protected Color backgroundNonSelectionColor
Color to use for the background when the node isn't selected.
protected Color borderSelectionColor
Color to use for the focus indicator when the node has focus.
public DefaultTreeCellRenderer()
Creates a DefaultTreeCellRenderer. Icons and text color are determined from the UIManager.
public void updateUI()
Resets the UI property to a value from the current look and feel.
updateUI in class JLabel
JComponent.updateUI()public Icon getDefaultOpenIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are 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 void setOpenIcon(Icon newIcon)
Sets the icon used to represent non-leaf nodes that are expanded.
public Icon getOpenIcon()
Returns the icon used to represent non-leaf nodes that are expanded.
public void setClosedIcon(Icon newIcon)
Sets the icon used to represent non-leaf nodes that are not expanded.
public Icon getClosedIcon()
Returns the icon used to represent non-leaf nodes that are not expanded.
public void setLeafIcon(Icon newIcon)
Sets the icon used to represent leaf nodes.
public Icon getLeafIcon()
Returns the icon used to represent leaf nodes.
public void setTextSelectionColor(Color newColor)
Sets the color the text is drawn with when the node is selected.
public Color getTextSelectionColor()
Returns the color the text is drawn with when the node is selected.
public void setTextNonSelectionColor(Color newColor)
Sets the color the text is drawn with when the node isn't selected.
public Color getTextNonSelectionColor()
Returns the color the text is drawn with when the node isn't selected.
public void setBackgroundSelectionColor(Color newColor)
Sets the color to use for the background if node is selected.
public Color getBackgroundSelectionColor()
Returns the color to use for the background if node is selected.
public void setBackgroundNonSelectionColor(Color newColor)
Sets the background color to be used for non selected nodes.
public Color getBackgroundNonSelectionColor()
Returns the background color to be used for non selected nodes.
public void setBorderSelectionColor(Color newColor)
Sets the color to use for the border.
public Color getBorderSelectionColor()
Returns the color the border is drawn.
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.
setFont in class JComponent
font - the desired Font for this componentComponent.getFont()public Font getFont()
Gets the font of this component.
getFont in interface MenuContainer
getFont in class Component
Component.setFont(java.awt.Font)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.
setBackground in class JComponent
color - the desired background Color
Component.getBackground(), JComponent.setOpaque(boolean)
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.
getTreeCellRendererComponent in interface TreeCellRenderer
Component that the renderer uses to draw the valuepublic void paint(Graphics g)
Paints the value. The background is filled based on selected.
paint in class JComponent
g - the Graphics context in which to paintJComponent.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)
public Dimension getPreferredSize()
Overrides JComponent.getPreferredSize to return slightly wider preferred size value.
getPreferredSize in class JComponent
preferredSize propertyJComponent.setPreferredSize(java.awt.Dimension), ComponentUI
public void validate()
Overridden for performance reasons. See the Implementation Note for more information.
validate in class Container
Container.add(java.awt.Component), Container.invalidate(), Container.isValidateRoot(), JComponent.revalidate(), Container.validateTree()
public void invalidate()
Overridden for performance reasons. See the Implementation Note for more information.
invalidate in class Container
Container.validate(), Container.layout(), LayoutManager2
public void revalidate()
Overridden for performance reasons. See the Implementation Note for more information.
revalidate in class JComponent
Component.invalidate(), Container.validate(), JComponent.isValidateRoot(), RepaintManager.addInvalidComponent(javax.swing.JComponent)
public void repaint(long tm,
int x,
int y,
int width,
int height) Overridden for performance reasons. See the Implementation Note for more information.
repaint in class JComponent
tm - this parameter is not usedx - the x value of the dirty regiony - the y value of the dirty regionwidth - the width of the dirty regionheight - the height of the dirty regionJComponent.isPaintingOrigin(), Component.isShowing(), RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)
public void repaint(Rectangle r)
Overridden for performance reasons. See the Implementation Note for more information.
repaint in class JComponent
r - a Rectangle containing the dirty regionJComponent.isPaintingOrigin(), Component.isShowing(), RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)
public void repaint()
Overridden for performance reasons. See the Implementation Note for more information.
repaint in class Component
Component.update(Graphics)protected void firePropertyChange(String propertyName,
Object oldValue,
Object newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class Component
propertyName - the property whose value has changedoldValue - the property's previous valuenewValue - the property's new valuepublic void firePropertyChange(String propertyName,
byte oldValue,
byte newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class Component
propertyName - the programmatic name of the property that was changedoldValue - the old value of the property (as a byte)newValue - the new value of the property (as a byte)Component.firePropertyChange(java.lang.String, java.lang.Object,
java.lang.Object)public void firePropertyChange(String propertyName,
char oldValue,
char newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class JComponent
propertyName - the programmatic name of the property that was changedoldValue - the old value of the property (as a char)newValue - the new value of the property (as a char)Component.firePropertyChange(java.lang.String, java.lang.Object,
java.lang.Object)public void firePropertyChange(String propertyName,
short oldValue,
short newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class Component
propertyName - the programmatic name of the property that was changedoldValue - the old value of the property (as a short)newValue - the old value of the property (as a short)Component.firePropertyChange(java.lang.String, java.lang.Object,
java.lang.Object)public void firePropertyChange(String propertyName,
int oldValue,
int newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class JComponent
propertyName - the property whose value has changedoldValue - the property's previous valuenewValue - the property's new valuepublic void firePropertyChange(String propertyName,
long oldValue,
long newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class Component
propertyName - the programmatic name of the property that was changedoldValue - the old value of the property (as a long)newValue - the new value of the property (as a long)Component.firePropertyChange(java.lang.String, java.lang.Object,
java.lang.Object)public void firePropertyChange(String propertyName,
float oldValue,
float newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class Component
propertyName - the programmatic name of the property that was changedoldValue - the old value of the property (as a float)newValue - the new value of the property (as a float)Component.firePropertyChange(java.lang.String, java.lang.Object,
java.lang.Object)public void firePropertyChange(String propertyName,
double oldValue,
double newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class Component
propertyName - the programmatic name of the property that was changedoldValue - the old value of the property (as a double)newValue - the new value of the property (as a double)Component.firePropertyChange(java.lang.String, java.lang.Object,
java.lang.Object)public void firePropertyChange(String propertyName,
boolean oldValue,
boolean newValue) Overridden for performance reasons. See the Implementation Note for more information.
firePropertyChange in class JComponent
propertyName - the property whose value has changedoldValue - the property's previous valuenewValue - the property's new value
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.