com.alee.laf.tree

Class WebTreeUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.TreeUI

javax.swing.plaf.basic.BasicTreeUI

com.alee.laf.tree.WebTreeUI

All Implemented Interfaces:

MarginSupport, PaddingSupport, ShapeProvider, Styleable

public class WebTreeUI
extends javax.swing.plaf.basic.BasicTreeUI
implements Styleable, ShapeProvider, MarginSupport, PaddingSupport

Custom UI for JTree component.

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.plaf.basic.BasicTreeUI

javax.swing.plaf.basic.BasicTreeUI.CellEditorHandler, javax.swing.plaf.basic.BasicTreeUI.ComponentHandler, javax.swing.plaf.basic.BasicTreeUI.FocusHandler, javax.swing.plaf.basic.BasicTreeUI.KeyHandler, javax.swing.plaf.basic.BasicTreeUI.MouseHandler, javax.swing.plaf.basic.BasicTreeUI.MouseInputHandler, javax.swing.plaf.basic.BasicTreeUI.NodeDimensionsHandler, javax.swing.plaf.basic.BasicTreeUI.PropertyChangeHandler, javax.swing.plaf.basic.BasicTreeUI.SelectionModelPropertyChangeHandler, javax.swing.plaf.basic.BasicTreeUI.TreeCancelEditingAction, javax.swing.plaf.basic.BasicTreeUI.TreeExpansionHandler, javax.swing.plaf.basic.BasicTreeUI.TreeHomeAction, javax.swing.plaf.basic.BasicTreeUI.TreeIncrementAction, javax.swing.plaf.basic.BasicTreeUI.TreeModelHandler, javax.swing.plaf.basic.BasicTreeUI.TreePageAction, javax.swing.plaf.basic.BasicTreeUI.TreeSelectionHandler, javax.swing.plaf.basic.BasicTreeUI.TreeToggleAction, javax.swing.plaf.basic.BasicTreeUI.TreeTraverseAction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.ImageIcon	CLOSED_ICON
static javax.swing.ImageIcon	COLLAPSE_ICON
static javax.swing.ImageIcon	DISABLED_COLLAPSE_ICON
static javax.swing.ImageIcon	DISABLED_EXPAND_ICON
static javax.swing.ImageIcon	EXPAND_ICON Expand and collapse control icons.
protected boolean	expandSelected
protected TreePathHoverBehavior	hoverNodeTracker Listeners.
protected int	hoverRow
static javax.swing.ImageIcon	LEAF_ICON
protected java.awt.Insets	margin Runtime variables.
static javax.swing.ImageIcon	OPEN_ICON
protected java.awt.Insets	padding
protected ITreePainter	painter Component painter.
static javax.swing.ImageIcon	ROOT_ICON Default node icons.
protected TreeSelectionStyle	selectionStyle Style settings.
protected boolean	selectOnHover

Fields inherited from class javax.swing.plaf.basic.BasicTreeUI

cellEditor, collapsedIcon, createdCellEditor, createdRenderer, currentCellRenderer, depthOffset, drawingCache, editingComponent, editingPath, editingRow, editorHasDifferentSize, expandedIcon, largeModel, lastSelectedRow, leftChildIndent, nodeDimensions, preferredMinSize, preferredSize, rendererPane, rightChildIndent, stopEditingInCompleteEditing, totalChildIndent, tree, treeModel, treeSelectionModel, treeState, validCachedPreferredSize

Fields inherited from interface com.alee.managers.style.MarginSupport

EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport

EMPTY

Constructor Summary

Constructors

Constructor and Description
WebTreeUI()

Method Summary

Modifier and Type	Method and Description
protected javax.swing.tree.TreeCellEditor	createDefaultCellEditor() Returns default tree cell editor.
protected javax.swing.tree.TreeCellRenderer	createDefaultCellRenderer() Returns default tree cell renderer.
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent c) Returns an instance of the WebTreeUI for the specified component.
javax.swing.CellRendererPane	getCellRendererPane() Returns tree cell renderer pane.
javax.swing.Icon	getCollapsedIcon() Returns tree structure collapsed node icon.
javax.swing.Icon	getExpandedIcon() Returns tree structure expanded node icon.
java.awt.Rectangle	getFullPathBounds(javax.swing.tree.TreePath path, boolean countFullRow) Returns full path bounds.
java.awt.Rectangle	getFullRowBounds(int row) Returns full row bounds by its index.
int	getHoverRow() Returns current hover row.
java.awt.Insets	getMargin() Returns current margin.
java.awt.Insets	getPadding() Returns current padding.
Painter	getPainter() Returns tree painter.
java.awt.Dimension	getPreferredSize(javax.swing.JComponent c)
java.awt.Rectangle	getRowBounds(int row) Returns row bounds by its index.
java.awt.Rectangle	getRowBounds(int row, boolean countFullRow) Returns row bounds by its index.
int	getRowForPoint(java.awt.Point point) Returns row index for specified point on the tree.
int	getRowForPoint(java.awt.Point point, boolean countFullRow) Returns row index for specified point on the tree.
TreeSelectionStyle	getSelectionStyle() Returns tree selection style.
StyleId	getStyleId() Returns component style ID.
protected ToolTipProvider<? extends WebTree>	getToolTipProvider() Returns custom WebLaF tooltip provider.
javax.swing.tree.AbstractLayoutCache	getTreeState() Returns state of tree.
java.util.Enumeration<javax.swing.tree.TreePath>	getVisiblePaths() Returns visible paths enumeration.
void	installUI(javax.swing.JComponent c) Installs UI in the specified component.
boolean	isExpandSelected() Returns whether tree should expand nodes on selection or not.
protected boolean	isFullLineSelection() Returns whether tree selection style points that the whole line is a single cell or not.
boolean	isLocationInCheckBoxControl(javax.swing.tree.TreePath path, int x, int y) Returns whether location is in the checkbox tree checkbox control or not.
boolean	isSelectOnHover() Returns whether or not nodes should be selected on hover.
void	paint(java.awt.Graphics g, javax.swing.JComponent c)
java.awt.Shape	provideShape() Returns component shape.
protected void	selectPathForEvent(javax.swing.tree.TreePath path, java.awt.event.MouseEvent e) Selects tree path for the specified event.
void	setExpandSelected(boolean expandSelected) Sets whether tree should expand nodes on selection or not.
void	setMargin(java.awt.Insets margin) Sets new margin.
void	setPadding(java.awt.Insets padding) Sets new padding.
void	setPainter(Painter painter) Sets tree painter.
void	setSelectionStyle(TreeSelectionStyle style) Sets tree selection style.
void	setSelectOnHover(boolean select) Sets whether or not nodes should be selected on hover.
StyleId	setStyleId(StyleId id) Sets new component style ID.
void	uninstallUI(javax.swing.JComponent c) Uninstalls UI from the specified component.

Methods inherited from class javax.swing.plaf.basic.BasicTreeUI

cancelEditing, checkForClickInExpandControl, completeEditing, completeEditing, completeUIInstall, completeUIUninstall, configureLayoutCache, createCellEditorListener, createCellRendererPane, createComponentListener, createFocusListener, createKeyListener, createLayoutCache, createMouseListener, createNodeDimensions, createPropertyChangeListener, createSelectionModelPropertyChangeListener, createTreeExpansionListener, createTreeModelListener, createTreeSelectionListener, drawCentered, drawDashedHorizontalLine, drawDashedVerticalLine, ensureRowsAreVisible, getBaseline, getBaselineResizeBehavior, getCellEditor, getCellRenderer, getClosestPathForLocation, getDropLineRect, getEditingPath, getHashColor, getHorizontalLegBuffer, getLastChildPath, getLeadSelectionRow, getLeftChildIndent, getMaximumSize, getMinimumSize, getModel, getPathBounds, getPathForRow, getPreferredMinSize, getPreferredSize, getRightChildIndent, getRowCount, getRowForPath, getRowHeight, getRowX, getSelectionModel, getShowsRootHandles, getVerticalLegBuffer, handleExpandControlClick, installComponents, installDefaults, installKeyboardActions, installListeners, isDropLine, isEditable, isEditing, isLargeModel, isLeaf, isLocationInExpandControl, isMultiSelectEvent, isRootVisible, isToggleEvent, isToggleSelectionEvent, paintDropLine, paintExpandControl, paintHorizontalLine, paintHorizontalPartOfLeg, paintRow, paintVerticalLine, paintVerticalPartOfLeg, pathWasCollapsed, pathWasExpanded, prepareForUIInstall, prepareForUIUninstall, setCellEditor, setCellRenderer, setCollapsedIcon, setEditable, setExpandedIcon, setHashColor, setLargeModel, setLeftChildIndent, setModel, setPreferredMinSize, setRightChildIndent, setRootVisible, setRowHeight, setSelectionModel, setShowsRootHandles, shouldPaintExpandControl, startEditing, startEditingAtPath, stopEditing, toggleExpandState, uninstallComponents, uninstallDefaults, uninstallKeyboardActions, uninstallListeners, updateCachedPreferredSize, updateCellEditor, updateDepthOffset, updateExpandedDescendants, updateLayoutCacheExpandedNodes, updateLeadSelectionRow, updateRenderer, updateSize

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, update

Methods inherited from class java.lang.Object

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

Field Detail

EXPAND_ICON

public static javax.swing.ImageIcon EXPAND_ICON

Expand and collapse control icons.

COLLAPSE_ICON

public static javax.swing.ImageIcon COLLAPSE_ICON

DISABLED_EXPAND_ICON

public static javax.swing.ImageIcon DISABLED_EXPAND_ICON

DISABLED_COLLAPSE_ICON

public static javax.swing.ImageIcon DISABLED_COLLAPSE_ICON

ROOT_ICON

public static javax.swing.ImageIcon ROOT_ICON

Default node icons.

CLOSED_ICON

public static javax.swing.ImageIcon CLOSED_ICON

OPEN_ICON

public static javax.swing.ImageIcon OPEN_ICON

LEAF_ICON

public static javax.swing.ImageIcon LEAF_ICON

selectionStyle

protected TreeSelectionStyle selectionStyle

Style settings.

expandSelected

protected boolean expandSelected

selectOnHover

protected boolean selectOnHover

painter

@DefaultPainter(value=TreePainter.class)
protected ITreePainter painter

Component painter.

hoverNodeTracker

protected TreePathHoverBehavior hoverNodeTracker

Listeners.

margin

protected java.awt.Insets margin

Runtime variables.

padding

protected java.awt.Insets padding

hoverRow

protected int hoverRow

Constructor Detail

WebTreeUI

public WebTreeUI()

Method Detail

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)

Returns an instance of the WebTreeUI for the specified component. This tricky method is used by UIManager to create component UIs when needed.

Parameters:

c - component that will use UI instance

Returns:

instance of the WebTreeUI

installUI

public void installUI(javax.swing.JComponent c)

Installs UI in the specified component.

Overrides:

installUI in class javax.swing.plaf.basic.BasicTreeUI

Parameters:

c - component for this UI

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Uninstalls UI from the specified component.

Overrides:

uninstallUI in class javax.swing.plaf.basic.BasicTreeUI

Parameters:

c - component with this UI

getStyleId

public StyleId getStyleId()

Description copied from interface: Styleable

Returns component style ID.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public StyleId setStyleId(StyleId id)

Description copied from interface: Styleable

Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

Returns:

previously used style ID

provideShape

public java.awt.Shape provideShape()

Description copied from interface: ShapeProvider

Returns component shape.

Specified by:

provideShape in interface ShapeProvider

Returns:

component shape

getMargin

public java.awt.Insets getMargin()

Description copied from interface: MarginSupport

Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.

Specified by:

getMargin in interface MarginSupport

Returns:

current margin

setMargin

public void setMargin(java.awt.Insets margin)

Description copied from interface: MarginSupport

Sets new margin. null can be provided to set an empty [0,0,0,0] margin.

Specified by:

setMargin in interface MarginSupport

Parameters:

margin - new margin

getPadding

public java.awt.Insets getPadding()

Description copied from interface: PaddingSupport

Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.

Specified by:

getPadding in interface PaddingSupport

Returns:

current padding

setPadding

public void setPadding(java.awt.Insets padding)

Description copied from interface: PaddingSupport

Sets new padding. null can be provided to set an empty [0,0,0,0] padding.

Specified by:

setPadding in interface PaddingSupport

Parameters:

padding - new padding

getPainter

public Painter getPainter()

Returns tree painter.

Returns:

tree painter

setPainter

public void setPainter(Painter painter)

Sets tree painter. Pass null to remove tree painter.

Parameters:

painter - new tree painter

getHoverRow

public int getHoverRow()

Returns current hover row.

Returns:

current hover row

paint

public void paint(java.awt.Graphics g,
                  javax.swing.JComponent c)

Overrides:

paint in class javax.swing.plaf.basic.BasicTreeUI

getRowForPoint

public int getRowForPoint(java.awt.Point point)

Returns row index for specified point on the tree. This method takes selection style into account.

Parameters:

point - point on the tree

Returns:

row index for specified point on the tree

getRowForPoint

public int getRowForPoint(java.awt.Point point,
                          boolean countFullRow)

Returns row index for specified point on the tree.

Parameters:

point - point on the tree

countFullRow - whether take the whole row into account or just node renderer rect

Returns:

row index for specified point on the tree

getRowBounds

public java.awt.Rectangle getRowBounds(int row)

Returns row bounds by its index. This method takes selection style into account.

Parameters:

row - row index

Returns:

row bounds by its index

getRowBounds

public java.awt.Rectangle getRowBounds(int row,
                                       boolean countFullRow)

Returns row bounds by its index.

Parameters:

row - row index

countFullRow - whether take the whole row into account or just node renderer rect

Returns:

row bounds by its index

getFullRowBounds

public java.awt.Rectangle getFullRowBounds(int row)

Returns full row bounds by its index.

Parameters:

row - row index

Returns:

full row bounds by its index

getFullPathBounds

public java.awt.Rectangle getFullPathBounds(javax.swing.tree.TreePath path,
                                            boolean countFullRow)

Returns full path bounds.

Parameters:

path - tree path

countFullRow - whether take the whole row into account or just node renderer rect

Returns:

full path bounds

getVisiblePaths

public java.util.Enumeration<javax.swing.tree.TreePath> getVisiblePaths()

Returns visible paths enumeration. This is just a small method for convenient enumeration retrieval.

Returns:

visible paths enumeration

createDefaultCellEditor

protected javax.swing.tree.TreeCellEditor createDefaultCellEditor()

Returns default tree cell editor.

Overrides:

createDefaultCellEditor in class javax.swing.plaf.basic.BasicTreeUI

Returns:

default tree cell editor

createDefaultCellRenderer

protected javax.swing.tree.TreeCellRenderer createDefaultCellRenderer()

Returns default tree cell renderer.

Overrides:

createDefaultCellRenderer in class javax.swing.plaf.basic.BasicTreeUI

Returns:

default tree cell renderer

selectPathForEvent

protected void selectPathForEvent(javax.swing.tree.TreePath path,
                                  java.awt.event.MouseEvent e)

Selects tree path for the specified event.

Overrides:

selectPathForEvent in class javax.swing.plaf.basic.BasicTreeUI

Parameters:

path - tree path to select

e - event to process

isLocationInCheckBoxControl

public boolean isLocationInCheckBoxControl(javax.swing.tree.TreePath path,
                                           int x,
                                           int y)

Returns whether location is in the checkbox tree checkbox control or not. This method is only used when this UI is applied to WebCheckBoxTree. todo Separate UI for WebCheckBoxTree

Parameters:

path - tree path

x - location X coordinate

y - location Y coordinate

Returns:

true if location is in the checkbox tree checkbox control, false otherwise

getToolTipProvider

protected ToolTipProvider<? extends WebTree> getToolTipProvider()

Returns custom WebLaF tooltip provider.

Returns:

custom WebLaF tooltip provider

getExpandedIcon

public javax.swing.Icon getExpandedIcon()

Returns tree structure expanded node icon.

Overrides:

getExpandedIcon in class javax.swing.plaf.basic.BasicTreeUI

Returns:

tree structure expanded node icon

getCollapsedIcon

public javax.swing.Icon getCollapsedIcon()

Returns tree structure collapsed node icon.

Overrides:

getCollapsedIcon in class javax.swing.plaf.basic.BasicTreeUI

Returns:

tree structure collapsed node icon

getCellRendererPane

public javax.swing.CellRendererPane getCellRendererPane()

Returns tree cell renderer pane.

Returns:

tree cell renderer pane

getTreeState

public javax.swing.tree.AbstractLayoutCache getTreeState()

Returns state of tree.

Returns:

state of tree

getSelectionStyle

public TreeSelectionStyle getSelectionStyle()

Returns tree selection style.

Returns:

tree selection style

setSelectionStyle

public void setSelectionStyle(TreeSelectionStyle style)

Sets tree selection style.

Parameters:

style - tree selection style

isExpandSelected

public boolean isExpandSelected()

Returns whether tree should expand nodes on selection or not.

Returns:

true if tree should expand nodes on selection, false otherwise

setExpandSelected

public void setExpandSelected(boolean expandSelected)

Sets whether tree should expand nodes on selection or not.

Parameters:

expandSelected - whether tree should expand nodes on selection or not

isSelectOnHover

public boolean isSelectOnHover()

Returns whether or not nodes should be selected on hover.

Returns:

true if nodes should be selected on hover, false otherwise

setSelectOnHover

public void setSelectOnHover(boolean select)

Sets whether or not nodes should be selected on hover.

Parameters:

select - whether or not nodes should be selected on hover

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

getPreferredSize

public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)

Overrides:

getPreferredSize in class javax.swing.plaf.basic.BasicTreeUI