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
public class StyledTreeCellRenderer extends StyledLabel implements 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:

  • Field Details

    • selected

      protected boolean selected
      Is the value currently selected.

    • hasFocus

      protected boolean hasFocus
      True if has focus.

    • closedIcon

      protected transient Icon closedIcon
      Icon used to show non-leaf nodes that aren't expanded.

    • leafIcon

      protected transient Icon leafIcon
      Icon used to show leaf nodes.

    • openIcon

      protected transient Icon openIcon
      Icon used to show non-leaf nodes that are expanded.

    • textSelectionColor

      protected Color textSelectionColor
      Color to use for the foreground for selected nodes.

    • textNonSelectionColor

      protected Color textNonSelectionColor
      Color to use for the foreground for non-selected nodes.

    • backgroundSelectionColor

      protected Color backgroundSelectionColor
      Color to use for the background when a node is selected.

    • backgroundNonSelectionColor

      protected Color backgroundNonSelectionColor
      Color to use for the background when the node isn't selected.

    • borderSelectionColor

      protected Color 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 class StyledLabel
      See Also:

    • getDefaultOpenIcon

      public Icon getDefaultOpenIcon()
      Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are expanded.

    • getDefaultClosedIcon

      public Icon getDefaultClosedIcon()
      Returns the default icon, for the current laf, that is used to represent non-leaf nodes that are not expanded.

    • getDefaultLeafIcon

      public Icon getDefaultLeafIcon()
      Returns the default icon, for the current laf, that is used to represent leaf nodes.

    • setOpenIcon

      public void setOpenIcon(Icon newIcon)
      Sets the icon used to represent non-leaf nodes that are expanded.

    • getOpenIcon

      public Icon getOpenIcon()
      Returns the icon used to represent non-leaf nodes that are expanded.

    • setClosedIcon

      public void setClosedIcon(Icon newIcon)
      Sets the icon used to represent non-leaf nodes that are not expanded.

    • getClosedIcon

      public Icon getClosedIcon()
      Returns the icon used to represent non-leaf nodes that are not expanded.

    • setLeafIcon

      public void setLeafIcon(Icon newIcon)
      Sets the icon used to represent leaf nodes.

    • getLeafIcon

      public Icon getLeafIcon()
      Returns the icon used to represent leaf nodes.

    • setTextSelectionColor

      public void setTextSelectionColor(Color newColor)
      Sets the color the text is drawn with when the node is selected.

    • getTextSelectionColor

      public Color getTextSelectionColor()
      Returns the color the text is drawn with when the node is selected.

    • setTextNonSelectionColor

      public void setTextNonSelectionColor(Color newColor)
      Sets the color the text is drawn with when the node isn't selected.

    • getTextNonSelectionColor

      public Color getTextNonSelectionColor()
      Returns the color the text is drawn with when the node isn't selected.

    • setBackgroundSelectionColor

      public void setBackgroundSelectionColor(Color newColor)
      Sets the color to use for the background if node is selected.

    • getBackgroundSelectionColor

      public Color getBackgroundSelectionColor()
      Returns the color to use for the background if node is selected.

    • setBackgroundNonSelectionColor

      public void setBackgroundNonSelectionColor(Color newColor)
      Sets the background color to be used for non selected nodes.

    • getBackgroundNonSelectionColor

      public Color getBackgroundNonSelectionColor()
      Returns the background color to be used for non selected nodes.

    • setBorderSelectionColor

      public void setBorderSelectionColor(Color newColor)
      Sets the color to use for the border.

    • getBorderSelectionColor

      public Color getBorderSelectionColor()
      Returns the color the border is drawn.

    • setFont

      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.
      Overrides:
      setFont in class JComponent

    • getFont

      public Font getFont()
      Gets the font of this component.
      Specified by:
      getFont in interface MenuContainer
      Overrides:
      getFont in class 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(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.
      Overrides:
      setBackground in class JComponent

    • 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 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.
      Specified by:
      getTreeCellRendererComponent in interface TreeCellRenderer

    • 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

      public void paint(Graphics g)
      Paints the value. The background is filled based on selected.
      Overrides:
      paint in class JComponent

    • getPreferredSize

      public Dimension getPreferredSize()
      Overrides JComponent.getPreferredSize to return slightly wider preferred size value.
      Overrides:
      getPreferredSize in class JComponent

    • validate

      public void validate()
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      validate in class Container

    • invalidate

      public void invalidate()
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      invalidate in class Container
      Since:
      1.5

    • revalidate

      public void revalidate()
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      revalidate in class 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 class JComponent

    • repaint

      public void repaint(Rectangle r)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      repaint in class JComponent

    • repaint

      public void repaint()
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      repaint in class Component
      Since:
      1.5

    • firePropertyChange

      protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class Component

    • firePropertyChange

      public void firePropertyChange(String propertyName, byte oldValue, byte newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class Component

    • firePropertyChange

      public void firePropertyChange(String propertyName, char oldValue, char newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class JComponent

    • firePropertyChange

      public void firePropertyChange(String propertyName, short oldValue, short newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class Component

    • firePropertyChange

      public void firePropertyChange(String propertyName, int oldValue, int newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class JComponent

    • firePropertyChange

      public void firePropertyChange(String propertyName, long oldValue, long newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class Component

    • firePropertyChange

      public void firePropertyChange(String propertyName, float oldValue, float newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class Component

    • firePropertyChange

      public void firePropertyChange(String propertyName, double oldValue, double newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class Component

    • firePropertyChange

      public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
      Overridden for performance reasons. See the Implementation Note for more information.
      Overrides:
      firePropertyChange in class JComponent