public class DefaultTreeCellRenderer extends JLabel implements TreeCellRenderer
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.AccessibleJLabelJComponent.AccessibleJComponentContainer.AccessibleAWTContainerComponent.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy| Modifier and Type | Field and Description |
|---|---|
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.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTBOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WESTABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH| Constructor and Description |
|---|
DefaultTreeCellRenderer()
Creates a
DefaultTreeCellRenderer. |
| Modifier and Type | Method and Description |
|---|---|
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.
|
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(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 |
updateUI()
Resets the UI property to a value from the current look and feel.
|
void |
validate()
Overridden for performance reasons.
|
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPositionaddAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateadd, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validateTreeaction, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycleprotected boolean selected
protected boolean hasFocus
protected transient Icon closedIcon
protected transient Icon leafIcon
protected transient Icon openIcon
protected Color textSelectionColor
protected Color textNonSelectionColor
protected Color backgroundSelectionColor
protected Color backgroundNonSelectionColor
protected Color borderSelectionColor
public DefaultTreeCellRenderer()
DefaultTreeCellRenderer. Icons and text color are
determined from the UIManager.public void updateUI()
updateUI in class JLabelJComponent.updateUI()public Icon getDefaultOpenIcon()
public Icon getDefaultClosedIcon()
public Icon getDefaultLeafIcon()
public void setOpenIcon(Icon newIcon)
public Icon getOpenIcon()
public void setClosedIcon(Icon newIcon)
public Icon getClosedIcon()
public void setLeafIcon(Icon newIcon)
public Icon getLeafIcon()
public void setTextSelectionColor(Color newColor)
public Color getTextSelectionColor()
public void setTextNonSelectionColor(Color newColor)
public Color getTextNonSelectionColor()
public void setBackgroundSelectionColor(Color newColor)
public Color getBackgroundSelectionColor()
public void setBackgroundNonSelectionColor(Color newColor)
public Color getBackgroundNonSelectionColor()
public void setBorderSelectionColor(Color newColor)
public Color getBorderSelectionColor()
public void setFont(Font font)
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 JComponentfont - the desired Font for this componentComponent.getFont()public Font getFont()
getFont in interface MenuContainergetFont in class ComponentComponent.setFont(java.awt.Font)public void setBackground(Color color)
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 JComponentcolor - the desired background ColorComponent.getBackground(),
JComponent.setOpaque(boolean)public Component getTreeCellRendererComponent(JTree tree, Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus)
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 TreeCellRendererComponent that the renderer uses to draw the valuepublic void paint(Graphics g)
paint in class JComponentg - 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()
JComponent.getPreferredSize to
return slightly wider preferred size value.getPreferredSize in class JComponentpreferredSize propertyJComponent.setPreferredSize(java.awt.Dimension),
ComponentUIpublic void validate()
validate in class ContainerContainer.add(java.awt.Component),
Container.invalidate(),
Container.isValidateRoot(),
JComponent.revalidate(),
Container.validateTree()public void invalidate()
invalidate in class ContainerContainer.validate(),
Container.layout(),
LayoutManager2public void revalidate()
revalidate in class JComponentComponent.invalidate(),
Container.validate(),
JComponent.isValidateRoot(),
RepaintManager.addInvalidComponent(javax.swing.JComponent)public void repaint(long tm,
int x,
int y,
int width,
int height)
repaint in class JComponenttm - 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)
repaint in class JComponentr - a Rectangle containing the dirty regionJComponent.isPaintingOrigin(),
Component.isShowing(),
RepaintManager.addDirtyRegion(javax.swing.JComponent, int, int, int, int)public void repaint()
repaint in class ComponentComponent.update(Graphics)protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
firePropertyChange in class ComponentpropertyName - the property whose value has changedoldValue - the property's previous valuenewValue - the property's new valuepublic void firePropertyChange(String propertyName, byte oldValue, byte newValue)
firePropertyChange in class ComponentpropertyName - 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)
firePropertyChange in class JComponentpropertyName - 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)
firePropertyChange in class ComponentpropertyName - 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)
firePropertyChange in class JComponentpropertyName - the property whose value has changedoldValue - the property's previous valuenewValue - the property's new valuepublic void firePropertyChange(String propertyName, long oldValue, long newValue)
firePropertyChange in class ComponentpropertyName - 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)
firePropertyChange in class ComponentpropertyName - 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)
firePropertyChange in class ComponentpropertyName - 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)
firePropertyChange in class JComponentpropertyName - the property whose value has changedoldValue - the property's previous valuenewValue - the property's new value Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2016, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.