javax.swing.plaf.metal

Class MetalTreeUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.TreeUI

javax.swing.plaf.basic.BasicTreeUI

javax.swing.plaf.metal.MetalTreeUI

public class MetalTreeUI
extends javax.swing.plaf.basic.BasicTreeUI

A UI delegate for the 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 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

Constructor Summary

Constructors

Constructor and Description
MetalTreeUI() Constructs a new instance of MetalTreeUI.

Method Summary

Methods

Modifier and Type	Method and Description
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent component) Returns a new instance of MetalTreeUI.
protected void	decodeLineStyle(java.lang.Object lineStyleFlag) This function converts between the string passed into the client property and the internal representation (currently an int).
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.
void	installUI(javax.swing.JComponent c) Configures the specified component appropriate for the look and feel.
protected boolean	isLocationInExpandControl(int row, int rowLevel, int mouseX, int mouseY) Checks if the location is in expand control.
void	paint(java.awt.Graphics g, javax.swing.JComponent c) Paints the specified component appropriate for the look and feel.
protected void	paintHorizontalPartOfLeg(java.awt.Graphics g, 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	paintHorizontalSeparators(java.awt.Graphics g, javax.swing.JComponent c) Paints the horizontal separators.
protected void	paintVerticalPartOfLeg(java.awt.Graphics g, java.awt.Rectangle clipBounds, java.awt.Insets insets, javax.swing.tree.TreePath path) Paints the vertical part of the leg.
void	uninstallUI(javax.swing.JComponent c) Reverses configuration which was done on the specified component during installUI.

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

cancelEditing, checkForClickInExpandControl, completeEditing, completeEditing, completeUIInstall, completeUIUninstall, configureLayoutCache, createCellEditorListener, createCellRendererPane, createComponentListener, createDefaultCellEditor, createDefaultCellRenderer, createFocusListener, createKeyListener, createLayoutCache, createMouseListener, createNodeDimensions, createPropertyChangeListener, createSelectionModelPropertyChangeListener, createTreeExpansionListener, createTreeModelListener, createTreeSelectionListener, drawCentered, drawDashedHorizontalLine, drawDashedVerticalLine, ensureRowsAreVisible, getCellEditor, getCellRenderer, getClosestPathForLocation, getCollapsedIcon, getEditingPath, getExpandedIcon, getHashColor, getLastChildPath, getLeftChildIndent, getMaximumSize, getMinimumSize, getModel, getPathBounds, getPathForRow, getPreferredMinSize, getPreferredSize, getPreferredSize, getRightChildIndent, getRowCount, getRowForPath, getRowHeight, getRowX, getSelectionModel, getShowsRootHandles, getVerticalLegBuffer, handleExpandControlClick, installComponents, installDefaults, installKeyboardActions, installListeners, isEditable, isEditing, isLargeModel, isLeaf, isLocationInExpandControl, isMultiSelectEvent, isRootVisible, isToggleEvent, isToggleSelectionEvent, paintExpandControl, paintHorizontalLine, paintRow, paintVerticalLine, pathWasCollapsed, pathWasExpanded, prepareForUIInstall, prepareForUIUninstall, selectPathForEvent, 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, 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

Constructor Detail

MetalTreeUI

public MetalTreeUI()

Constructs a new instance of MetalTreeUI.

Method Detail

createUI

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

Returns a new instance of MetalTreeUI.

Parameters:

component - the component for which we return an UI instance

Returns:

A new instance of MetalTreeUI.

getHorizontalLegBuffer

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. This method makes the leg end before that.

Overrides:

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

Returns:

the horizontal leg buffer

installUI

public void installUI(javax.swing.JComponent c)

Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following: 1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden. 2. Install a LayoutManager on the component if necessary. 3. Create/add any required sub-components to the component. 4. Create/install event listeners on the component. 5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately. 6. Install keyboard UI (mnemonics, traversal, etc.) on the component. 7. Initialize any appropriate instance data.

Overrides:

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

Parameters:

c - the component to install UI for

See Also:

ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following: 1. Remove any UI-set borders from the component. 2. Remove any UI-set layout managers on the component. 3. Remove any UI-added sub-components from the component. 4. Remove any UI-added event/property listeners from the component. 5. Remove any UI-installed keyboard UI from the component. 6. Nullify any allocated instance data objects to allow for GC.

Overrides:

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

Parameters:

c - the component to uninstall UI for

See Also:

ComponentUI.installUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

decodeLineStyle

protected void decodeLineStyle(java.lang.Object lineStyleFlag)

This function converts between the string passed into the client property and the internal representation (currently an int).

Parameters:

lineStyleFlag - - String representation

isLocationInExpandControl

protected boolean isLocationInExpandControl(int row,
                                int rowLevel,
                                int mouseX,
                                int mouseY)

Checks if the location is in expand control.

Parameters:

row - - current row

rowLevel - - current level

mouseX - - current x location of the mouse click

mouseY - - current y location of the mouse click

paint

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

Paints the specified component appropriate for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

Overrides:

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

Parameters:

g - - the current graphics configuration.

c - - the current component to draw

paintHorizontalSeparators

protected void paintHorizontalSeparators(java.awt.Graphics g,
                             javax.swing.JComponent c)

Paints the horizontal separators.

Parameters:

g - - the current graphics configuration.

c - - the current component to draw

paintVerticalPartOfLeg

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

Paints the vertical part of the leg. The receiver should NOT modify clipBounds, insets.

Overrides:

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

Parameters:

g - - the current graphics configuration.

clipBounds - -

insets - -

path - - the current path

paintHorizontalPartOfLeg

protected void paintHorizontalPartOfLeg(java.awt.Graphics g,
                            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. The receiver should NOT \ modify clipBounds, or insets. NOTE: parentRow can be -1 if the root is not visible.

Overrides:

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

Parameters:

g - - the graphics configuration

clipBounds - -

insets - -

bounds - - bounds of the cell

path - - path to draw leg for

row - - row to start drawing at

isExpanded - - is the row expanded

hasBeenExpanded - - has the row already been expanded

isLeaf - - is the path a leaf