javax.swing.plaf.basic
Class BasicTreeUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      javax.swing.plaf.TreeUI
          javax.swing.plaf.basic.BasicTreeUI

Direct Known Subclasses:

MetalTreeUI

public class BasicTreeUI
extends TreeUI

The basic L&F for a hierarchical data structure.

Nested Class Summary
class	BasicTreeUI.CellEditorHandler           Listener responsible for getting cell editing events and updating the tree accordingly.
class	BasicTreeUI.ComponentHandler           Updates the preferred size when scrolling (if necessary).
class	BasicTreeUI.FocusHandler           Repaints the lead selection row when focus is lost/gained.
class	BasicTreeUI.KeyHandler           This is used to get mutliple key down events to appropriately generate events.
class	BasicTreeUI.MouseHandler           TreeMouseListener is responsible for updating the selection based on mouse events.
class	BasicTreeUI.MouseInputHandler           MouseInputHandler handles passing all mouse events, including mouse motion events, until the mouse is released to the destination it is constructed with.
class	BasicTreeUI.NodeDimensionsHandler           Class responsible for getting size of node, method is forwarded to BasicTreeUI method.
class	BasicTreeUI.PropertyChangeHandler           PropertyChangeListener for the tree.
class	BasicTreeUI.SelectionModelPropertyChangeHandler           Listener on the TreeSelectionModel, resets the row selection if any of the properties of the model change.
class	BasicTreeUI.TreeCancelEditingAction           ActionListener that invokes cancelEditing when action performed.
class	BasicTreeUI.TreeExpansionHandler           Updates the TreeState in response to nodes expanding/collapsing.
class	BasicTreeUI.TreeHomeAction           TreeHomeAction is used to handle end/home actions.
class	BasicTreeUI.TreeIncrementAction           TreeIncrementAction is used to handle up/down actions.
class	BasicTreeUI.TreeModelHandler           Forwards all TreeModel events to the TreeState.
class	BasicTreeUI.TreePageAction           TreePageAction handles page up and page down events.
class	BasicTreeUI.TreeSelectionHandler           Listens for changes in the selection model and updates the display accordingly.
class	BasicTreeUI.TreeToggleAction           For the first selected row expandedness will be toggled.
class	BasicTreeUI.TreeTraverseAction           TreeTraverseAction is the action used for left/right keys.

 

Field Summary
protected  TreeCellEditor	cellEditor           Editor for the tree.
protected  Icon	collapsedIcon
protected  boolean	createdCellEditor           Set to true if editor that is currently in the tree was created by this instance.
protected  boolean	createdRenderer           Set to true if the renderer that is currently in the tree was created by this instance.
protected  TreeCellRenderer	currentCellRenderer           Renderer that is being used to do the actual cell drawing.
protected  int	depthOffset           How much the depth should be offset to properly calculate x locations.
protected  Hashtable<TreePath,Boolean>	drawingCache           Used for minimizing the drawing of vertical lines.
protected  Component	editingComponent           When editing, this will be the Component that is doing the actual editing.
protected  TreePath	editingPath           Path that is being edited.
protected  int	editingRow           Row that is being edited.
protected  boolean	editorHasDifferentSize           Set to true if the editor has a different size than the renderer.
protected  Icon	expandedIcon
protected  boolean	largeModel           True if doing optimizations for a largeModel.
protected  int	lastSelectedRow           Index of the row that was last selected.
protected  int	leftChildIndent           Distance between left margin and where vertical dashes will be drawn.
protected  AbstractLayoutCache.NodeDimensions	nodeDimensions           Reponsible for telling the TreeState the size needed for a node.
protected  Dimension	preferredMinSize           Minimum preferred size.
protected  Dimension	preferredSize           Size needed to completely display all the nodes.
protected  CellRendererPane	rendererPane           Used to paint the TreeCellRenderer.
protected  int	rightChildIndent           Distance to add to leftChildIndent to determine where cell contents will be drawn.
protected  boolean	stopEditingInCompleteEditing           Set to false when editing and shouldSelectCell() returns true meaning the node should be selected before editing, used in completeEditing.
protected  int	totalChildIndent           Total distance that will be indented.
protected  JTree	tree           Component that we're going to be drawing into.
protected  TreeModel	treeModel           Used to determine what to display.
protected  TreeSelectionModel	treeSelectionModel           Model maintaing the selection.
protected  AbstractLayoutCache	treeState           Object responsible for handling sizing and expanded issues.
protected  boolean	validCachedPreferredSize           Is the preferredSize valid?

 

Constructor Summary
BasicTreeUI()

 

Method Summary
void	cancelEditing(JTree tree)           Cancels the current editing session.
protected  void	checkForClickInExpandControl(TreePath path, int mouseX, int mouseY)           If the mouseX and mouseY are in the expand/collapse region of the row, this will toggle the row.
protected  void	completeEditing()           Messages to stop the editing session.
protected  void	completeEditing(boolean messageStop, boolean messageCancel, boolean messageTree)           Stops the editing session.
protected  void	completeUIInstall()           Invoked from installUI after all the defaults/listeners have been installed.
protected  void	completeUIUninstall()
protected  void	configureLayoutCache()           Resets the TreeState instance based on the tree we're providing the look and feel for.
protected  CellEditorListener	createCellEditorListener()           Creates a listener to handle events from the current editor.
protected  CellRendererPane	createCellRendererPane()           Returns the renderer pane that renderer components are placed in.
protected  ComponentListener	createComponentListener()           Creates and returns a new ComponentHandler.
protected  TreeCellEditor	createDefaultCellEditor()           Creates a default cell editor.
protected  TreeCellRenderer	createDefaultCellRenderer()           Returns the default cell renderer that is used to do the stamping of each node.
protected  FocusListener	createFocusListener()           Creates a listener that is responsible for updating the display when focus is lost/gained.
protected  KeyListener	createKeyListener()           Creates the listener reponsible for getting key events from the tree.
protected  AbstractLayoutCache	createLayoutCache()           Creates the object responsible for managing what is expanded, as well as the size of nodes.
protected  MouseListener	createMouseListener()           Creates the listener responsible for updating the selection based on mouse events.
protected  AbstractLayoutCache.NodeDimensions	createNodeDimensions()           Creates an instance of NodeDimensions that is able to determine the size of a given node in the tree.
protected  PropertyChangeListener	createPropertyChangeListener()           Creates a listener that is responsible that updates the UI based on how the tree changes.
protected  PropertyChangeListener	createSelectionModelPropertyChangeListener()           Creates the listener responsible for getting property change events from the selection model.
protected  TreeExpansionListener	createTreeExpansionListener()           Creates and returns the object responsible for updating the treestate when nodes expanded state changes.
protected  TreeModelListener	createTreeModelListener()           Returns a listener that can update the tree when the model changes.
protected  TreeSelectionListener	createTreeSelectionListener()           Creates the listener that updates the display based on selection change methods.
static ComponentUI	createUI(JComponent x)
protected  void	drawCentered(Component c, Graphics graphics, Icon icon, int x, int y)
protected  void	drawDashedHorizontalLine(Graphics g, int y, int x1, int x2)
protected  void	drawDashedVerticalLine(Graphics g, int x, int y1, int y2)
protected  void	ensureRowsAreVisible(int beginRow, int endRow)           Ensures that the rows identified by beginRow through endRow are visible.
int	getBaseline(JComponent c, int width, int height)           Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior(JComponent c)           Returns an enum indicating how the baseline of the component changes as the size changes.
protected  TreeCellEditor	getCellEditor()
protected  TreeCellRenderer	getCellRenderer()           Return currentCellRenderer, which will either be the trees renderer, or defaultCellRenderer, which ever wasn't null.
TreePath	getClosestPathForLocation(JTree tree, int x, int y)           Returns the path to the node that is closest to x,y.
Icon	getCollapsedIcon()
TreePath	getEditingPath(JTree tree)           Returns the path to the element that is being edited.
Icon	getExpandedIcon()
protected  Color	getHashColor()
protected  int	getHorizontalLegBuffer()           The horizontal element of legs between nodes starts at the right of the left-hand side of the child node by default.
protected  TreePath	getLastChildPath(TreePath parent)           Returns a path to the last child of parent.
int	getLeftChildIndent()
Dimension	getMaximumSize(JComponent c)           Returns the maximum size for this component, which will be the preferred size if the instance is currently in a JTree, or 0, 0.
Dimension	getMinimumSize(JComponent c)           Returns the minimum size for this component.
protected  TreeModel	getModel()
Rectangle	getPathBounds(JTree tree, TreePath path)           Returns the Rectangle enclosing the label portion that the last item in path will be drawn into.
TreePath	getPathForRow(JTree tree, int row)           Returns the path for passed in row.
Dimension	getPreferredMinSize()           Returns the minimum preferred size.
Dimension	getPreferredSize(JComponent c)           Returns the preferred size to properly display the tree, this is a cover method for getPreferredSize(c, false).
Dimension	getPreferredSize(JComponent c, boolean checkConsistancy)           Returns the preferred size to represent the tree in c.
int	getRightChildIndent()
int	getRowCount(JTree tree)           Returns the number of rows that are being displayed.
int	getRowForPath(JTree tree, TreePath path)           Returns the row that the last item identified in path is visible at.
protected  int	getRowHeight()
protected  int	getRowX(int row, int depth)           Returns the location, along the x-axis, to render a particular row at.
protected  TreeSelectionModel	getSelectionModel()
protected  boolean	getShowsRootHandles()
protected  int	getVerticalLegBuffer()           The vertical element of legs between nodes starts at the bottom of the parent node by default.
protected  void	handleExpandControlClick(TreePath path, int mouseX, int mouseY)           Messaged when the user clicks the particular row, this invokes toggleExpandState.
protected  void	installComponents()           Intalls the subcomponents of the tree, which is the renderer pane.
protected  void	installDefaults()
protected  void	installKeyboardActions()
protected  void	installListeners()
void	installUI(JComponent c)           Configures the specified component appropriate for the look and feel.
protected  boolean	isEditable()
boolean	isEditing(JTree tree)           Returns true if the tree is being edited.
protected  boolean	isLargeModel()
protected  boolean	isLeaf(int row)
protected  boolean	isLocationInExpandControl(TreePath path, int mouseX, int mouseY)           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.
protected  boolean	isMultiSelectEvent(MouseEvent event)           Returning true signifies a mouse event on the node should select from the anchor point.
protected  boolean	isRootVisible()
protected  boolean	isToggleEvent(MouseEvent event)           Returning true indicates the row under the mouse should be toggled based on the event.
protected  boolean	isToggleSelectionEvent(MouseEvent event)           Returning true signifies a mouse event on the node should toggle the selection of only the row under mouse.
void	paint(Graphics g, JComponent c)           Paints the specified component appropriate for the look and feel.
protected  void	paintExpandControl(Graphics g, Rectangle clipBounds, Insets insets, Rectangle bounds, TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf)           Paints the expand (toggle) part of a row.
protected  void	paintHorizontalLine(Graphics g, JComponent c, int y, int left, int right)           Paints a horizontal line.
protected  void	paintHorizontalPartOfLeg(Graphics g, Rectangle clipBounds, Insets insets, Rectangle bounds, TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf)           Paints the horizontal part of the leg.
protected  void	paintRow(Graphics g, Rectangle clipBounds, Insets insets, Rectangle bounds, TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf)           Paints the renderer part of a row.
protected  void	paintVerticalLine(Graphics g, JComponent c, int x, int top, int bottom)           Paints a vertical line.
protected  void	paintVerticalPartOfLeg(Graphics g, Rectangle clipBounds, Insets insets, TreePath path)           Paints the vertical part of the leg.
protected  void	pathWasCollapsed(TreePath path)           Messaged from the VisibleTreeNode after it has collapsed.
protected  void	pathWasExpanded(TreePath path)           Messaged from the VisibleTreeNode after it has been expanded.
protected  void	prepareForUIInstall()           Invoked after the tree instance variable has been set, but before any defaults/listeners have been installed.
protected  void	prepareForUIUninstall()
protected  void	selectPathForEvent(TreePath path, MouseEvent event)           Messaged to update the selection based on a MouseEvent over a particular row.
protected  void	setCellEditor(TreeCellEditor editor)           Sets the cell editor.
protected  void	setCellRenderer(TreeCellRenderer tcr)           Sets the TreeCellRenderer to tcr.
void	setCollapsedIcon(Icon newG)
protected  void	setEditable(boolean newValue)           Configures the receiver to allow, or not allow, editing.
void	setExpandedIcon(Icon newG)
protected  void	setHashColor(Color color)
protected  void	setLargeModel(boolean largeModel)           Updates the componentListener, if necessary.
void	setLeftChildIndent(int newAmount)
protected  void	setModel(TreeModel model)           Sets the TreeModel.
void	setPreferredMinSize(Dimension newSize)           Sets the preferred minimum size.
void	setRightChildIndent(int newAmount)
protected  void	setRootVisible(boolean newValue)           Sets the root to being visible.
protected  void	setRowHeight(int rowHeight)           Sets the row height, this is forwarded to the treeState.
protected  void	setSelectionModel(TreeSelectionModel newLSM)           Resets the selection model.
protected  void	setShowsRootHandles(boolean newValue)           Determines whether the node handles are to be displayed.
protected  boolean	shouldPaintExpandControl(TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf)           Returns true if the expand (toggle) control should be drawn for the specified row.
protected  boolean	startEditing(TreePath path, MouseEvent event)           Will start editing for node if there is a cellEditor and shouldSelectCell returns true.
void	startEditingAtPath(JTree tree, TreePath path)           Selects the last item in path and tries to edit it.
boolean	stopEditing(JTree tree)           Stops the current editing session.
protected  void	toggleExpandState(TreePath path)           Expands path if it is not expanded, or collapses row if it is expanded.
protected  void	uninstallComponents()           Uninstalls the renderer pane.
protected  void	uninstallDefaults()
protected  void	uninstallKeyboardActions()
protected  void	uninstallListeners()
void	uninstallUI(JComponent c)           Reverses configuration which was done on the specified component during installUI.
protected  void	updateCachedPreferredSize()           Updates the preferredSize instance variable, which is returned from getPreferredSize().
protected  void	updateCellEditor()           Updates the cellEditor based on the editability of the JTree that we're contained in.
protected  void	updateDepthOffset()           Updates how much each depth should be offset by.
protected  void	updateExpandedDescendants(TreePath path)           Updates the expanded state of all the descendants of path by getting the expanded descendants from the tree and forwarding to the tree state.
protected  void	updateLayoutCacheExpandedNodes()           Makes all the nodes that are expanded in JTree expanded in LayoutCache.
protected  void	updateRenderer()           Messaged from the tree we're in when the renderer has changed.
protected  void	updateSize()           Marks the cached size as being invalid, and messages the tree with treeDidChange.

 

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

collapsedIcon

protected transient Icon collapsedIcon

expandedIcon

protected transient Icon expandedIcon

leftChildIndent

protected int leftChildIndent

Distance between left margin and where vertical dashes will be drawn.

rightChildIndent

protected int rightChildIndent

Distance to add to leftChildIndent to determine where cell contents will be drawn.

totalChildIndent

protected int totalChildIndent

Total distance that will be indented. The sum of leftChildIndent and rightChildIndent.

preferredMinSize

protected Dimension preferredMinSize

Minimum preferred size.

lastSelectedRow

protected int lastSelectedRow

Index of the row that was last selected.

tree

protected JTree tree

Component that we're going to be drawing into.

currentCellRenderer

protected transient TreeCellRenderer currentCellRenderer

Renderer that is being used to do the actual cell drawing.

createdRenderer

protected boolean createdRenderer

Set to true if the renderer that is currently in the tree was created by this instance.

cellEditor

protected transient TreeCellEditor cellEditor

Editor for the tree.

createdCellEditor

protected boolean createdCellEditor

Set to true if editor that is currently in the tree was created by this instance.

stopEditingInCompleteEditing

protected boolean stopEditingInCompleteEditing

Set to false when editing and shouldSelectCell() returns true meaning the node should be selected before editing, used in completeEditing.

rendererPane

protected CellRendererPane rendererPane

Used to paint the TreeCellRenderer.

preferredSize

protected Dimension preferredSize

Size needed to completely display all the nodes.

validCachedPreferredSize

protected boolean validCachedPreferredSize

Is the preferredSize valid?

treeState

protected AbstractLayoutCache treeState

Object responsible for handling sizing and expanded issues.

drawingCache

protected Hashtable<TreePath,Boolean> drawingCache

Used for minimizing the drawing of vertical lines.

largeModel

protected boolean largeModel

True if doing optimizations for a largeModel. Subclasses that don't support this may wish to override createLayoutCache to not return a FixedHeightLayoutCache instance.

nodeDimensions

protected AbstractLayoutCache.NodeDimensions nodeDimensions

Reponsible for telling the TreeState the size needed for a node.

treeModel

protected TreeModel treeModel

Used to determine what to display.

treeSelectionModel

protected TreeSelectionModel treeSelectionModel

Model maintaing the selection.

depthOffset

protected int depthOffset

How much the depth should be offset to properly calculate x locations. This is based on whether or not the root is visible, and if the root handles are visible.

editingComponent

protected Component editingComponent

When editing, this will be the Component that is doing the actual editing.

editingPath

protected TreePath editingPath

Path that is being edited.

editingRow

protected int editingRow

Row that is being edited. Should only be referenced if editingComponent is not null.

editorHasDifferentSize

protected boolean editorHasDifferentSize

Set to true if the editor has a different size than the renderer.

BasicTreeUI

public BasicTreeUI()

createUI

public static ComponentUI createUI(JComponent x)

getHashColor

protected Color getHashColor()

setHashColor

protected void setHashColor(Color color)

setLeftChildIndent

public void setLeftChildIndent(int newAmount)

getLeftChildIndent

public int getLeftChildIndent()

setRightChildIndent

public void setRightChildIndent(int newAmount)

getRightChildIndent

public int getRightChildIndent()

setExpandedIcon

public void setExpandedIcon(Icon newG)

getExpandedIcon

public Icon getExpandedIcon()

setCollapsedIcon

public void setCollapsedIcon(Icon newG)

getCollapsedIcon

public Icon getCollapsedIcon()

setLargeModel

protected void setLargeModel(boolean largeModel)

Updates the componentListe