Package com.jidesoft.tree
Class StyledTreeCellRenderer
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JLabel
com.jidesoft.swing.StyledLabel
com.jidesoft.tree.StyledTreeCellRenderer
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,SwingConstants
,TreeCellRenderer
A tree cell renderer based on StyledLabel. To use it, you should make your cell renderer extending this one and
override
customizeStyledLabel(javax.swing.JTree, Object, boolean, boolean, boolean, int, boolean)
method. If your
overridden method, you can call setStyleRange() or setStyleRanges() based on the tree node value and row index.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JLabel
JLabel.AccessibleJLabel
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Color
Color to use for the background when the node isn't selected.protected Color
Color to use for the background when a node is selected.protected Color
Color to use for the focus indicator when the node has focus.protected Icon
Icon used to show non-leaf nodes that aren't expanded.protected boolean
True if has focus.protected Icon
Icon used to show leaf nodes.protected Icon
Icon used to show non-leaf nodes that are expanded.protected boolean
Is the value currently selected.protected Color
Color to use for the foreground for non-selected nodes.protected Color
Color to use for the foreground for selected nodes.Fields inherited from class com.jidesoft.swing.StyledLabel
PROPERTY_IGNORE_COLOR_SETTINGS, PROPERTY_STYLE_RANGE
Fields inherited from class javax.swing.JComponent
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
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
customizeStyledLabel
(JTree tree, Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus) Overrides this method to customize the styled label.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.void
firePropertyChange
(String propertyName, short oldValue, short newValue) Overridden for performance reasons.protected void
firePropertyChange
(String propertyName, Object oldValue, Object newValue) Overridden for performance reasons.Returns the background color to be used for non selected nodes.Returns the color to use for the background if node is selected.Returns the color the border is drawn.Returns the icon 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.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 non-leaf nodes that are expanded.getFont()
Gets the font of this component.Returns the icon used to represent leaf nodes.Returns the icon used to represent non-leaf nodes that are expanded.OverridesJComponent.getPreferredSize
to return slightly wider preferred size value.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 is selected.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
Overridden for performance reasons.void
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
Overridden for performance reasons.void
Overridden for performance reasons.void
setBackground
(Color color) Subclassed to mapColorUIResource
s 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
Subclassed to mapFontUIResource
s 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.Methods inherited from class com.jidesoft.swing.StyledLabel
addStyleRange, addStyleRanges, clearStyleRange, clearStyleRanges, getMaximumSize, getMaxRows, getMinimumSize, getMinRows, getPreferredWidth, getRowGap, getRows, getStyleRanges, getUIClassID, isIgnoreColorSettings, isLineWrap, isTruncated, setIgnoreColorSettings, setLineWrap, setMaxRows, setMinRows, setPreferredWidth, setRowGap, setRows, setStyleRanges, setTruncated
Methods inherited from class javax.swing.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition
Methods inherited from class javax.swing.JComponent
addAncestorListener, 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, 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
Methods inherited from class java.awt.Container
add, 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, validateTree
Methods inherited from class java.awt.Component
action, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
selected
protected boolean selectedIs the value currently selected. -
hasFocus
protected boolean hasFocusTrue if has focus. -
closedIcon
Icon used to show non-leaf nodes that aren't expanded. -
leafIcon
Icon used to show leaf nodes. -
openIcon
Icon used to show non-leaf nodes that are expanded. -
textSelectionColor
Color to use for the foreground for selected nodes. -
textNonSelectionColor
Color to use for the foreground for non-selected nodes. -
backgroundSelectionColor
Color to use for the background when a node is selected. -
backgroundNonSelectionColor
Color to use for the background when the node isn't selected. -
borderSelectionColor
Color to use for the focus indicator when the node has focus.
-
-
Constructor Details
-
StyledTreeCellRenderer
public StyledTreeCellRenderer()Returns a new instance of DefaultTreeCellRenderer. Alignment is set to left aligned. Icons and text color are determined from the UIManager.
-
-
Method Details
-
updateUI
public void updateUI()Description copied from class:StyledLabel
Resets the UI property to a value from the current look and feel.- Overrides:
updateUI
in classStyledLabel
- See Also:
-
getDefaultOpenIcon
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded. -
getDefaultClosedIcon
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded. -
getDefaultLeafIcon
Returns the default icon, for the current laf, that is used to represent leaf nodes. -
setOpenIcon
Sets the icon used to represent non-leaf nodes that are expanded. -
getOpenIcon
Returns the icon used to represent non-leaf nodes that are expanded. -
setClosedIcon
Sets the icon used to represent non-leaf nodes that are not expanded. -
getClosedIcon
Returns the icon used to represent non-leaf nodes that are not expanded. -
setLeafIcon
Sets the icon used to represent leaf nodes. -
getLeafIcon
Returns the icon used to represent leaf nodes. -
setTextSelectionColor
Sets the color the text is drawn with when the node is selected. -
getTextSelectionColor
Returns the color the text is drawn with when the node is selected. -
setTextNonSelectionColor
Sets the color the text is drawn with when the node isn't selected. -
getTextNonSelectionColor
Returns the color the text is drawn with when the node isn't selected. -
setBackgroundSelectionColor
Sets the color to use for the background if node is selected. -
getBackgroundSelectionColor
Returns the color to use for the background if node is selected. -
setBackgroundNonSelectionColor
Sets the background color to be used for non selected nodes. -
getBackgroundNonSelectionColor
Returns the background color to be used for non selected nodes. -
setBorderSelectionColor
Sets the color to use for the border. -
getBorderSelectionColor
Returns the color the border is drawn. -
setFont
Subclassed to mapFontUIResource
s to null. Iffont
is null, or aFontUIResource
, this has the effect of letting the font of the JTree show through. On the other hand, iffont
is non-null, and not aFontUIResource
, the font becomesfont
.- Overrides:
setFont
in classJComponent
-
getFont
Gets the font of this component.- Specified by:
getFont
in interfaceMenuContainer
- Overrides:
getFont
in classComponent
- Returns:
- this component's font; if a font has not been set for this component, the font of its parent is returned
-
setBackground
Subclassed to mapColorUIResource
s to null. Ifcolor
is null, or aColorUIResource
, this has the effect of letting the background color of the JTree show through. On the other hand, ifcolor
is non-null, and not aColorUIResource
, the background becomescolor
.- Overrides:
setBackground
in classJComponent
-
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 withconvertValueToText
, which ultimately invokestoString
onvalue
. The foreground color is set based on the selection and the icon is set based on theleaf
andexpanded
parameters.- Specified by:
getTreeCellRendererComponent
in interfaceTreeCellRenderer
-
customizeStyledLabel
protected void customizeStyledLabel(JTree tree, Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus) Overrides this method to customize the styled label.- Parameters:
tree
-value
-sel
-expanded
-leaf
-row
-hasFocus
-
-
paint
Paints the value. The background is filled based on selected.- Overrides:
paint
in classJComponent
-
getPreferredSize
OverridesJComponent.getPreferredSize
to return slightly wider preferred size value.- Overrides:
getPreferredSize
in classJComponent
-
validate
public void validate()Overridden for performance reasons. See the Implementation Note for more information. -
invalidate
public void invalidate()Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
invalidate
in classContainer
- Since:
- 1.5
-
revalidate
public void revalidate()Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
revalidate
in classJComponent
-
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 classJComponent
-
repaint
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
repaint
in classJComponent
-
repaint
public void repaint()Overridden for performance reasons. See the Implementation Note for more information. -
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classJComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classJComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classComponent
-
firePropertyChange
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classJComponent
-