com.alee.laf.tree

Class TreePainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>

java.lang.Object

com.alee.painter.AbstractPainter<E,U>

com.alee.painter.decoration.AbstractDecorationPainter<E,U,D>

com.alee.laf.tree.TreePainter<E,U,D>

All Implemented Interfaces:

ITreePainter<E,U>, PainterShapeProvider<E>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods

public class TreePainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>
extends AbstractDecorationPainter<E,U,D>
implements ITreePainter<E,U>

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.tree.TreeCellRenderer	currentCellRenderer
protected boolean	dashedLines
protected int	depthOffset
protected javax.swing.tree.TreePath	draggablePath
protected ITreeDropLocationPainter	dropLocationPainter Tree drop location painter.
protected int	editingRow
protected ITreeNodePainter	hoverPainter Hover node background painter.
protected java.util.List<java.lang.Integer>	initialSelection Runtime variables.
protected int	lastSelectionRow
protected java.awt.Color	linesColor
protected java.awt.event.MouseAdapter	mouseAdapter
protected java.util.Hashtable<javax.swing.tree.TreePath,java.lang.Boolean>	paintingCache
protected boolean	paintLines Style settings.
protected javax.swing.CellRendererPane	rendererPane
protected ITreeRowPainter	rowPainter Tree rows background painter.
protected java.awt.Point	selectionEnd
protected ITreeNodePainter	selectionPainter Selected nodes background painter.
protected java.awt.Point	selectionStart
protected ITreeSelectorPainter	selectorPainter Tree nodes selector painter.
protected int	totalChildIndent Painting variables.
protected javax.swing.event.TreeExpansionListener	treeExpansionListener
protected javax.swing.tree.TreeModel	treeModel
protected javax.swing.event.TreeSelectionListener	treeSelectionListener Listeners.
protected javax.swing.tree.AbstractLayoutCache	treeState

Fields inherited from class com.alee.painter.decoration.AbstractDecorationPainter

ancestor, DECORATION_STATES_PROPERTY, decorationCache, decorations, focused, focusStateTracker, hierarchyTracker, hover, hoverStateTracker, neighboursTracker, states

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors

Constructor and Description
TreePainter()

Method Summary

Modifier and Type	Method and Description
protected int	findCenteredX(int x, int iconWidth) Returns centered x coordinate for the icon.
protected int	getHorizontalLegIndent() Returns horizontal leg indent.
protected javax.swing.tree.TreePath	getLastChildPath(javax.swing.tree.TreePath parent) Returns a path to the last child of parent.
protected java.awt.Rectangle	getPathBounds(javax.swing.tree.TreePath path) Returns the Rectangle enclosing the label portion that the last item in path will be painted into.
protected java.awt.Rectangle	getPathBounds(javax.swing.tree.TreePath path, java.awt.Insets insets, java.awt.Rectangle bounds) Returns path bounds used for painting.
protected int	getRowX(int row, int depth) Returns the location, along the x-axis, to render a particular row at.
protected java.util.List<SectionPainter<E,U>>	getSectionPainters() Returns section painters used within this painter.
protected java.util.List<java.awt.Rectangle>	getSelectionRects() Returns list of tree selections bounds.
protected boolean	getShowsRootHandles() Returns whether or not root handles should be displayed.
protected int	getVerticalLegIndent() The vertical element of legs between nodes starts at the bottom of the parent node by default.
void	install(E c, U ui) Called when painter is installed onto some component.
protected boolean	isDragAvailable() Returns whether tree nodes drag available or not.
protected boolean	isDropLocationAvailable() Returns whether or not drop location is available.
protected boolean	isFullLineSelection() Returns whether tree selection style points that the whole line is a single cell or not.
boolean	isHoverDecorationSupported() Returns whether or not hover node decoration is supported by this tree painter.
protected boolean	isLocationInExpandControl(javax.swing.tree.TreePath path, int mouseX, int mouseY) Returns whether or not mouseX and mouseY fall in the area of row that is used to expand/collapse the node and the node at row does not represent a leaf.
protected boolean	isRootVisible() Returns whether or not root is visible.
protected boolean	isSelectorAvailable() Returns whether selector is available for current tree or not.
protected void	paintBackground(java.awt.Graphics2D g2d) Paints tree background.
protected void	paintCentered(java.awt.Component c, java.awt.Graphics2D g2d, javax.swing.Icon icon, int x, int y) Paints centered icon.
protected void	paintContent(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints content decorated by this painter.
protected void	paintDashedHorizontalLine(java.awt.Graphics2D g2d, int y, int x1, int x2) Paints dashed horizontal line.
protected void	paintDashedVerticalLine(java.awt.Graphics2D g2d, int x, int y1, int y2) Paints dashed vertical line.
protected void	paintDropLocation(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints drop location if it is available.
protected void	paintExpandControl(java.awt.Graphics2D g2d, java.awt.Rectangle clipBounds, java.awt.Insets insets, java.awt.Rectangle bounds, javax.swing.tree.TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf) Paints the expand (toggle) part of a row.
protected void	paintHorizontalLine(java.awt.Graphics2D g2d, int y, int x1, int x2) Paints a horizontal line.
protected void	paintHorizontalPartOfLeg(java.awt.Graphics2D g2d, java.awt.Rectangle clipBounds, java.awt.Insets insets, java.awt.Rectangle bounds, javax.swing.tree.TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf) Paints the horizontal part of the leg.
protected void	paintHoverNodeBackground(java.awt.Graphics2D g2d) Paints hover node highlight.
protected void	paintMultiselector(java.awt.Graphics2D g2d) Paints custom WebLaF multiselector.
protected void	paintRow(java.awt.Graphics2D g2d, java.awt.Rectangle clipBounds, java.awt.Insets insets, java.awt.Rectangle bounds, javax.swing.tree.TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf) Paints the renderer part of a row.
protected void	paintSelectedNodesBackground(java.awt.Graphics2D g2d) Paints special WebLaF tree nodes selection.
protected void	paintTree(java.awt.Graphics2D g2d) Paints all base tree elements.
protected void	paintVerticalLine(java.awt.Graphics2D g2d, int x, int y1, int y2) Paints a vertical line.
protected void	paintVerticalPartOfLeg(java.awt.Graphics2D g2d, java.awt.Rectangle clipBounds, java.awt.Insets insets, javax.swing.tree.TreePath path) Paints the vertical part of the leg.
void	prepareToPaint(java.util.Hashtable<javax.swing.tree.TreePath,java.lang.Boolean> paintingCache, javax.swing.tree.TreeCellRenderer currentCellRenderer) Prepares painter to pain tree.
protected void	propertyChange(java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue) Performs various updates on property changes.
protected void	repaintSelection() Repaints all rectangles containing tree selections.
protected boolean	shouldPaintExpandControl(javax.swing.tree.TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf) Returns whether or not the expand (toggle) control should be painted for the specified row.
void	uninstall(E c, U ui) Called when painter is installed into some component.
protected void	updateDepthOffset() Updates how much each depth should be offset by.

Methods inherited from class com.alee.painter.decoration.AbstractDecorationPainter

adjustBounds, asList, collectDecorationStates, getBorders, getDecoration, getDecorations, getDecorationSize, getDecorationStates, getPreferredSize, installFocusListener, installHierarchyListener, installHoverListener, isDecorated, isDecorationPaintAllowed, isEnabled, isFocused, isHover, isOpaque, isOpaqueDecorated, isOpaqueUndecorated, isPlainBackgroundPaintAllowed, paint, provideShape, uninstallFocusListener, uninstallHierarchyListener, uninstallHoverListener, updateDecorationState, usesState, usesState

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, getCompleteBorder, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.alee.painter.Painter

addPainterListener, getBorders, getPreferredSize, isOpaque, paint, removePainterListener

Field Detail

paintLines

protected boolean paintLines

Style settings.

dashedLines

protected boolean dashedLines

linesColor

protected java.awt.Color linesColor

rowPainter

@DefaultPainter(value=AlternateTreeRowPainter.class)
protected ITreeRowPainter rowPainter

Tree rows background painter. It can be used to provide background customization for specific tree rows.

hoverPainter

@DefaultPainter(value=TreeNodePainter.class)
protected ITreeNodePainter hoverPainter

Hover node background painter. It can be used to provide background for hover nodes.

selectionPainter

@DefaultPainter(value=TreeNodePainter.class)
protected ITreeNodePainter selectionPainter

Selected nodes background painter. It can be used to provide background for selected nodes. WebLaF uses this painter instead of cell renderer -based selection decoration.

dropLocationPainter

@DefaultPainter(value=TreeDropLocationPainter.class)
protected ITreeDropLocationPainter dropLocationPainter

Tree drop location painter. Provides visual representation for drag-and-drop operation on tree nodes.

selectorPainter

@DefaultPainter(value=TreeSelectorPainter.class)
protected ITreeSelectorPainter selectorPainter

Tree nodes selector painter. It can be provided to enable nodes multiselector.

treeSelectionListener

protected javax.swing.event.TreeSelectionListener treeSelectionListener

Listeners.

treeExpansionListener

protected javax.swing.event.TreeExpansionListener treeExpansionListener

mouseAdapter

protected java.awt.event.MouseAdapter mouseAdapter

initialSelection

protected java.util.List<java.lang.Integer> initialSelection

Runtime variables.

selectionStart

protected java.awt.Point selectionStart

selectionEnd

protected java.awt.Point selectionEnd

draggablePath

protected javax.swing.tree.TreePath draggablePath

totalChildIndent

protected int totalChildIndent

Painting variables.

depthOffset

protected int depthOffset

treeModel

protected javax.swing.tree.TreeModel treeModel

treeState

protected javax.swing.tree.AbstractLayoutCache treeState

paintingCache

protected java.util.Hashtable<javax.swing.tree.TreePath,java.lang.Boolean> paintingCache

rendererPane

protected javax.swing.CellRendererPane rendererPane

currentCellRenderer

protected javax.swing.tree.TreeCellRenderer currentCellRenderer

editingRow

protected int editingRow

lastSelectionRow

protected int lastSelectionRow

Constructor Detail

TreePainter

public TreePainter()

Method Detail

install

public void install(E c,
                    U ui)

Description copied from interface: Painter

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

install in interface Painter<E extends javax.swing.JTree,U extends WebTreeUI>

Overrides:

install in class AbstractDecorationPainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

public void uninstall(E c,
                      U ui)

Description copied from interface: Painter

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

uninstall in interface Painter<E extends javax.swing.JTree,U extends WebTreeUI>

Overrides:

uninstall in class AbstractDecorationPainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

propertyChange

protected void propertyChange(java.lang.String property,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)

Description copied from class: AbstractPainter

Performs various updates on property changes.

Overrides:

propertyChange in class AbstractDecorationPainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>

Parameters:

property - modified property

oldValue - old property value

newValue - new property value

getSectionPainters

protected java.util.List<SectionPainter<E,U>> getSectionPainters()

Description copied from class: AbstractDecorationPainter

Returns section painters used within this painter. Might also return null in case no section painters are used within this one. This method is used for various internal update mechanisms involving section painters.

Overrides:

getSectionPainters in class AbstractDecorationPainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>

Returns:

section painters used within this painter

paintContent

protected void paintContent(java.awt.Graphics2D g2d,
                            java.awt.Rectangle bounds,
                            E c,
                            U ui)

Description copied from class: AbstractDecorationPainter

Paints content decorated by this painter. todo This method should eventually be removed since all content will be painted by IContent implementations

Overrides:

paintContent in class AbstractDecorationPainter<E extends javax.swing.JTree,U extends WebTreeUI,D extends IDecoration<E,D>>

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

paintBackground

protected void paintBackground(java.awt.Graphics2D g2d)

Paints tree background.

Parameters:

g2d - graphics context

prepareToPaint

public void prepareToPaint(java.util.Hashtable<javax.swing.tree.TreePath,java.lang.Boolean> paintingCache,
                           javax.swing.tree.TreeCellRenderer currentCellRenderer)

Description copied from interface: ITreePainter

Prepares painter to pain tree.

Specified by:

prepareToPaint in interface ITreePainter<E extends javax.swing.JTree,U extends WebTreeUI>

Parameters:

paintingCache - vertical lines drawing cache

currentCellRenderer - current cell renderer

paintCentered

protected void paintCentered(java.awt.Component c,
                             java.awt.Graphics2D g2d,
                             javax.swing.Icon icon,
                             int x,
                             int y)

Paints centered icon.

Parameters:

c - component

g2d - graphics

icon - icon

x - X coordinate

y - Y coordinate

findCenteredX

protected int findCenteredX(int x,
                            int iconWidth)

Returns centered x coordinate for the icon.

Parameters:

x - X coordinate

iconWidth - icon width

Returns:

centered x coordinate

isHoverDecorationSupported

public boolean isHoverDecorationSupported()

Description copied from interface: ITreePainter

Returns whether or not hover node decoration is supported by this tree painter.

Specified by:

isHoverDecorationSupported in interface ITreePainter<E extends javax.swing.JTree,U extends WebTreeUI>

Returns:

true if hover node decoration is supported by this tree painter, false otherwise

paintHoverNodeBackground

protected void paintHoverNodeBackground(java.awt.Graphics2D g2d)

Paints hover node highlight.

Parameters:

g2d - graphics context

paintSelectedNodesBackground

protected void paintSelectedNodesBackground(java.awt.Graphics2D g2d)

Paints special WebLaF tree nodes selection. It is rendered separately from nodes allowing you to simplify your tree cell renderer component.

Parameters:

g2d - graphics context

getSelectionRects

protected java.util.List<java.awt.Rectangle> getSelectionRects()

Returns list of tree selections bounds. This method takes selection style into account.

Returns:

list of tree selections bounds

repaintSelection

protected void repaintSelection()

Repaints all rectangles containing tree selections. This method is optimized to repaint only those area which are actually have selection in them.

paintTree

protected void paintTree(java.awt.Graphics2D g2d)

Paints all base tree elements. This is almost the same method as in BasicTreeUI but it doesn't paint drop line.

Parameters:

g2d - graphics context

isLocationInExpandControl

protected boolean isLocationInExpandControl(javax.swing.tree.TreePath path,
                                            int mouseX,
                                            int mouseY)

Returns whether or not mouseX and mouseY fall in the area of row that is used to expand/collapse the node and the node at row does not represent a leaf.

Parameters:

path - tree path

mouseX - mouse X location

mouseY - mouse Y location

Returns:

true if mouseX and mouseY fall in the area of row that is used to expand/collapse the node and the node at row does not represent a leaf, false otherwise

paintExpandControl

protected void paintExpandControl(java.awt.Graphics2D g2d,
                                  java.awt.Rectangle clipBounds,
                                  java.awt.Insets insets,
                                  java.awt.Rectangle bounds,
                                  javax.swing.tree.TreePath path,
                                  int row,
                                  boolean isExpanded,
                                  boolean hasBeenExpanded,
                                  boolean isLeaf)

Paints the expand (toggle) part of a row. The receiver should NOT modify clipBounds, or insets.

Parameters:

g2d - graphics context

clipBounds - clip bounds

insets - tree insets

bounds - tree path bounds

path - tree path

row - row index

isExpanded - whether row is expanded or not

hasBeenExpanded - whether row has been expanded once before or not

isLeaf - whether node is leaf or not

paintRow

protected void paintRow(java.awt.Graphics2D g2d,
                        java.awt.Rectangle clipBounds,
                        java.awt.Insets insets,
                        java.awt.Rectangle bounds,
                        javax.swing.tree.TreePath path,
                        int row,
                        boolean isExpanded,
                        boolean hasBeenExpanded,
                        boolean isLeaf)

Paints the renderer part of a row. The receiver should NOT modify clipBounds, or insets.

Parameters:

g2d - graphics context

clipBounds - clip bounds

insets - tree insets

bounds - tree path bounds

path - tree path

row - row index

isExpanded - whether row is expanded or not

hasBeenExpanded - whether row has been expanded once before or not

isLeaf - whether node is leaf or not

shouldPaintExpandControl

protected boolean shouldPaintExpandControl(javax.swing.tree.TreePath path,
                                           int row,
                                           boolean isExpanded,
                                           boolean hasBeenExpanded,
                                           boolean isLeaf)

Returns whether or not the expand (toggle) control should be painted for the specified row.

Parameters:

path - tree path

row - row index

isExpanded - whether row is expanded or not

hasBeenExpanded - whether row has been expanded once before or not

isLeaf - whether node is leaf or not

Returns:

true if the expand (toggle) control should be painted for the specified row, false otherwise

isRootVisible

protected boolean isRootVisible()

Returns whether or not root is visible.

Returns:

true if root is visible, false otherwise

getShowsRootHandles

protected boolean getShowsRootHandles()

Returns whether or not root handles should be displayed.

Returns:

true if root handles should be displayed, false otherwise

paintHorizontalPartOfLeg

protected void paintHorizontalPartOfLeg(java.awt.Graphics2D g2d,
                                        java.awt.Rectangle clipBounds,
                                        java.awt.Insets insets,
                                        java.awt.Rectangle bounds,
                                        javax.swing.tree.TreePath path,
                                        int row,
                                        boolean isExpanded,
                                        boolean hasBeenExpanded,
                                        boolean isLeaf)

Paints the horizontal part of the leg.

Parameters:

g2d - graphics

clipBounds - clip bounds

insets - tree insets

bounds - tree path bounds

path - tree path

row - row index

isExpanded - whether row is expanded or not

hasBeenExpanded - whether row has been expanded once before or not

isLeaf - whether node is leaf or not

getHorizontalLegIndent

protected int getHorizontalLegIndent()

Returns horizontal leg indent.

Returns:

horizontal leg indent

paintVerticalPartOfLeg

protected void paintVerticalPartOfLeg(java.awt.Graphics2D g2d,
                                      java.awt.Rectangle clipBounds,
                                      java.awt.Insets insets,
                                      javax.swing.tree.TreePath path)

Paints the vertical part of the leg.

Parameters:

g2d - graphics

clipBounds - clip bounds

insets - tree insets

path - tree path

getLastChildPath

protected javax.swing.tree.TreePath getLastChildPath(javax.swing.tree.TreePath parent)

Returns a path to the last child of parent.

Parameters:

parent - parent tree path

Returns:

path to the last child of parent

paintVerticalLine

protected void paintVerticalLine(java.awt.Graphics2D g2d,
                                 int x,
                                 int y1,
                                 int y2)

Paints a vertical line.

Parameters:

g2d - graphics context

x - X coordinate

y1 - start Y coordinate

y2 - end Y coordinate

paintDashedVerticalLine

protected void paintDashedVerticalLine(java.awt.Graphics2D g2d,
                                       int x,
                                       int y1,
                                       int y2)

Paints dashed vertical line. This method assumes that y1 <= y2 always. todo Change to proper stroke usage instead as this implementation is slow

Parameters:

g2d - graphics context

x - X coordinate

y1 - start Y coordinate

y2 - end Y coordinate

paintHorizontalLine

protected void paintHorizontalLine(java.awt.Graphics2D g2d,
                                   int y,
                                   int x1,
                                   int x2)

Paints a horizontal line.

Parameters:

g2d - graphics context

y - Y coordinate

x1 - start X coordinate

x2 - end X coordinate

paintDashedHorizontalLine

protected void paintDashedHorizontalLine(java.awt.Graphics2D g2d,
                                         int y,
                                         int x1,
                                         int x2)

Paints dashed horizontal line. This method assumes that x1 <= x2 always. todo Change to proper stroke usage instead as this implementation is slow

Parameters:

g2d - graphics context

y - Y coordinate

x1 - start X coordinate

x2 - end X coordinate

getRowX

protected int getRowX(int row,
                      int depth)

Returns the location, along the x-axis, to render a particular row at. The return value does not include any Insets specified on the JTree. This does not check for the validity of the row or depth, it is assumed to be correct and will not throw an Exception if the row or depth doesn't match that of the tree.

Parameters:

row - Row to return x location for

depth - Depth of the row

Returns:

amount to indent the given row.

updateDepthOffset

protected void updateDepthOffset()

Updates how much each depth should be offset by.

getVerticalLegIndent

protected int getVerticalLegIndent()

The vertical element of legs between nodes starts at the bottom of the parent node by default. This method makes the leg start below that.

Returns:

vertical leg indent

paintDropLocation

protected void paintDropLocation(java.awt.Graphics2D g2d,
                                 java.awt.Rectangle bounds,
                                 E c,
                                 U ui)

Paints drop location if it is available.

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

isDropLocationAvailable

protected boolean isDropLocationAvailable()

Returns whether or not drop location is available.

Returns:

true if drop location is available, false otherwise

paintMultiselector

protected void paintMultiselector(java.awt.Graphics2D g2d)

Paints custom WebLaF multiselector.

Parameters:

g2d - graphics context

isSelectorAvailable

protected boolean isSelectorAvailable()

Returns whether selector is available for current tree or not.

Returns:

true if selector is available for current tree, false otherwise

getPathBounds

protected java.awt.Rectangle getPathBounds(javax.swing.tree.TreePath path)

Returns the Rectangle enclosing the label portion that the last item in path will be painted into. Will return null if any component in path is currently valid.

Parameters:

path - tree path

Returns:

Rectangle enclosing the label portion that the last item in path will be painted into

getPathBounds

protected java.awt.Rectangle getPathBounds(javax.swing.tree.TreePath path,
                                           java.awt.Insets insets,
                                           java.awt.Rectangle bounds)

Returns path bounds used for painting.

Parameters:

path - tree path

insets - tree insets

bounds - bounds buffer

Returns:

path bounds

isFullLineSelection

protected boolean isFullLineSelection()

Returns whether tree selection style points that the whole line is a single cell or not.

Returns:

true if tree selection style points that the whole line is a single cell, false otherwise

isDragAvailable

protected boolean isDragAvailable()

Returns whether tree nodes drag available or not.

Returns:

true if tree nodes drag available, false otherwise