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 | 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 | Description |
|---|---|
DefaultTreeCellRenderer() |
Creates a
DefaultTreeCellRenderer. |
| Modifier and Type | Method | 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, update