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:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,javax.swing.SwingConstants
,javax.swing.tree.TreeCellRenderer
public class StyledTreeCellRenderer extends StyledLabel implements javax.swing.tree.TreeCellRenderer
A tree cell renderer based on StyledLabel. To use it, you should make your cell renderer extending this one and overridecustomizeStyledLabel(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:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JLabel
javax.swing.JLabel.AccessibleJLabel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description protected java.awt.Color
backgroundNonSelectionColor
Color to use for the background when the node isn't selected.protected java.awt.Color
backgroundSelectionColor
Color to use for the background when a node is selected.protected java.awt.Color
borderSelectionColor
Color to use for the focus indicator when the node has focus.protected javax.swing.Icon
closedIcon
Icon used to show non-leaf nodes that aren't expanded.protected boolean
hasFocus
True if has focus.protected javax.swing.Icon
leafIcon
Icon used to show leaf nodes.protected javax.swing.Icon
openIcon
Icon used to show non-leaf nodes that are expanded.protected boolean
selected
Is the value currently selected.protected java.awt.Color
textNonSelectionColor
Color to use for the foreground for non-selected nodes.protected java.awt.Color
textSelectionColor
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
-
-
Constructor Summary
Constructors Constructor Description StyledTreeCellRenderer()
Returns a new instance of DefaultTreeCellRenderer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
customizeStyledLabel(javax.swing.JTree tree, java.lang.Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean hasFocus)
Overrides this method to customize the styled label.void
firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, byte oldValue, byte newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, char oldValue, char newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, double oldValue, double newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, float oldValue, float newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, int oldValue, int newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, long oldValue, long newValue)
Overridden for performance reasons.void
firePropertyChange(java.lang.String propertyName, short oldValue, short newValue)
Overridden for performance reasons.protected void
firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
Overridden for performance reasons.java.awt.Color
getBackgroundNonSelectionColor()
Returns the background color to be used for non selected nodes.java.awt.Color
getBackgroundSelectionColor()
Returns the color to use for the background if node is selected.java.awt.Color
getBorderSelectionColor()
Returns the color the border is drawn.javax.swing.Icon
getClosedIcon()
Returns the icon used to represent non-leaf nodes that are not expanded.javax.swing.Icon
getDefaultClosedIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.javax.swing.Icon
getDefaultLeafIcon()
Returns the default icon, for the current laf, that is used to represent leaf nodes.javax.swing.Icon
getDefaultOpenIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.java.awt.Font
getFont()
Gets the font of this component.javax.swing.Icon
getLeafIcon()
Returns the icon used to represent leaf nodes.javax.swing.Icon
getOpenIcon()
Returns the icon used to represent non-leaf nodes that are expanded.java.awt.Dimension
getPreferredSize()
OverridesJComponent.getPreferredSize
to return slightly wider preferred size value.java.awt.Color
getTextNonSelectionColor()
Returns the color the text is drawn with when the node isn't selected.java.awt.Color
getTextSelectionColor()
Returns the color the text is drawn with when the node is selected.java.awt.Component
getTreeCellRendererComponent(javax.swing.JTree tree, java.lang.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(java.awt.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(java.awt.Rectangle r)
Overridden for performance reasons.void
revalidate()
Overridden for performance reasons.void
setBackground(java.awt.Color color)
Subclassed to mapColorUIResource
s to null.void
setBackgroundNonSelectionColor(java.awt.Color newColor)
Sets the background color to be used for non selected nodes.void
setBackgroundSelectionColor(java.awt.Color newColor)
Sets the color to use for the background if node is selected.void
setBorderSelectionColor(java.awt.Color newColor)
Sets the color to use for the border.void
setClosedIcon(javax.swing.Icon newIcon)
Sets the icon used to represent non-leaf nodes that are not expanded.void
setFont(java.awt.Font font)
Subclassed to mapFontUIResource
s to null.void
setLeafIcon(javax.swing.Icon newIcon)
Sets the icon used to represent leaf nodes.void
setOpenIcon(javax.swing.Icon newIcon)
Sets the icon used to represent non-leaf nodes that are expanded.void
setTextNonSelectionColor(java.awt.Color newColor)
Sets the color the text is drawn with when the node isn't selected.void
setTextSelectionColor(java.awt.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 Detail
-
selected
protected boolean selected
Is the value currently selected.
-
hasFocus
protected boolean hasFocus
True if has focus.
-
closedIcon
protected transient javax.swing.Icon closedIcon
Icon used to show non-leaf nodes that aren't expanded.
-
leafIcon
protected transient javax.swing.Icon leafIcon
Icon used to show leaf nodes.
-
openIcon
protected transient javax.swing.Icon openIcon
Icon used to show non-leaf nodes that are expanded.
-
textSelectionColor
protected java.awt.Color textSelectionColor
Color to use for the foreground for selected nodes.
-
textNonSelectionColor
protected java.awt.Color textNonSelectionColor
Color to use for the foreground for non-selected nodes.
-
backgroundSelectionColor
protected java.awt.Color backgroundSelectionColor
Color to use for the background when a node is selected.
-
backgroundNonSelectionColor
protected java.awt.Color backgroundNonSelectionColor
Color to use for the background when the node isn't selected.
-
borderSelectionColor
protected java.awt.Color borderSelectionColor
Color to use for the focus indicator when the node has focus.
-
-
Method Detail
-
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:
JComponent.updateUI()
-
getDefaultOpenIcon
public javax.swing.Icon getDefaultOpenIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.
-
getDefaultClosedIcon
public javax.swing.Icon getDefaultClosedIcon()
Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.
-
getDefaultLeafIcon
public javax.swing.Icon getDefaultLeafIcon()
Returns the default icon, for the current laf, that is used to represent leaf nodes.
-
setOpenIcon
public void setOpenIcon(javax.swing.Icon newIcon)
Sets the icon used to represent non-leaf nodes that are expanded.
-
getOpenIcon
public javax.swing.Icon getOpenIcon()
Returns the icon used to represent non-leaf nodes that are expanded.
-
setClosedIcon
public void setClosedIcon(javax.swing.Icon newIcon)
Sets the icon used to represent non-leaf nodes that are not expanded.
-
getClosedIcon
public javax.swing.Icon getClosedIcon()
Returns the icon used to represent non-leaf nodes that are not expanded.
-
setLeafIcon
public void setLeafIcon(javax.swing.Icon newIcon)
Sets the icon used to represent leaf nodes.
-
getLeafIcon
public javax.swing.Icon getLeafIcon()
Returns the icon used to represent leaf nodes.
-
setTextSelectionColor
public void setTextSelectionColor(java.awt.Color newColor)
Sets the color the text is drawn with when the node is selected.
-
getTextSelectionColor
public java.awt.Color getTextSelectionColor()
Returns the color the text is drawn with when the node is selected.
-
setTextNonSelectionColor
public void setTextNonSelectionColor(java.awt.Color newColor)
Sets the color the text is drawn with when the node isn't selected.
-
getTextNonSelectionColor
public java.awt.Color getTextNonSelectionColor()
Returns the color the text is drawn with when the node isn't selected.
-
setBackgroundSelectionColor
public void setBackgroundSelectionColor(java.awt.Color newColor)
Sets the color to use for the background if node is selected.
-
getBackgroundSelectionColor
public java.awt.Color getBackgroundSelectionColor()
Returns the color to use for the background if node is selected.
-
setBackgroundNonSelectionColor
public void setBackgroundNonSelectionColor(java.awt.Color newColor)
Sets the background color to be used for non selected nodes.
-
getBackgroundNonSelectionColor
public java.awt.Color getBackgroundNonSelectionColor()
Returns the background color to be used for non selected nodes.
-
setBorderSelectionColor
public void setBorderSelectionColor(java.awt.Color newColor)
Sets the color to use for the border.
-
getBorderSelectionColor
public java.awt.Color getBorderSelectionColor()
Returns the color the border is drawn.
-
setFont
public void setFont(java.awt.Font font)
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 classjavax.swing.JComponent
-
getFont
public java.awt.Font getFont()
Gets the font of this component.- Specified by:
getFont
in interfacejava.awt.MenuContainer
- Overrides:
getFont
in classjava.awt.Component
- Returns:
- this component's font; if a font has not been set for this component, the font of its parent is returned
-
setBackground
public void setBackground(java.awt.Color color)
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 classjavax.swing.JComponent
-
getTreeCellRendererComponent
public java.awt.Component getTreeCellRendererComponent(javax.swing.JTree tree, java.lang.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 interfacejavax.swing.tree.TreeCellRenderer
-
customizeStyledLabel
protected void customizeStyledLabel(javax.swing.JTree tree, java.lang.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
public void paint(java.awt.Graphics g)
Paints the value. The background is filled based on selected.- Overrides:
paint
in classjavax.swing.JComponent
-
getPreferredSize
public java.awt.Dimension getPreferredSize()
OverridesJComponent.getPreferredSize
to return slightly wider preferred size value.- Overrides:
getPreferredSize
in classjavax.swing.JComponent
-
validate
public void validate()
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
validate
in classjava.awt.Container
-
invalidate
public void invalidate()
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
invalidate
in classjava.awt.Container
- Since:
- 1.5
-
revalidate
public void revalidate()
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
revalidate
in classjavax.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 classjavax.swing.JComponent
-
repaint
public void repaint(java.awt.Rectangle r)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
repaint
in classjavax.swing.JComponent
-
repaint
public void repaint()
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
repaint
in classjava.awt.Component
- Since:
- 1.5
-
firePropertyChange
protected void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjava.awt.Component
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, byte oldValue, byte newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjava.awt.Component
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, char oldValue, char newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjavax.swing.JComponent
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, short oldValue, short newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjava.awt.Component
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, int oldValue, int newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjavax.swing.JComponent
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, long oldValue, long newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjava.awt.Component
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, float oldValue, float newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjava.awt.Component
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, double oldValue, double newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjava.awt.Component
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue)
Overridden for performance reasons. See the Implementation Note for more information.- Overrides:
firePropertyChange
in classjavax.swing.JComponent
-
-