public class BasicTreeUI extends TreeUI
The basic L&F for a hierarchical data structure.
|Modifier and Type||Class and Description|
Listener responsible for getting cell editing events and updating the tree accordingly.
Updates the preferred size when scrolling (if necessary).
Repaints the lead selection row when focus is lost/gained.
This is used to get multiple key down events to appropriately generate events.
TreeMouseListener is responsible for updating the selection based on mouse events.
MouseInputHandler handles passing all mouse events, including mouse motion events, until the mouse is released to the destination it is constructed with.
Class responsible for getting size of node, method is forwarded to BasicTreeUI method.
PropertyChangeListener for the tree.
Listener on the TreeSelectionModel, resets the row selection if any of the properties of the model change.
ActionListener that invokes cancelEditing when action performed.
Updates the TreeState in response to nodes expanding/collapsing.
TreeHomeAction is used to handle end/home actions.
TreeIncrementAction is used to handle up/down actions.
Forwards all TreeModel events to the TreeState.
TreePageAction handles page up and page down events.
Listens for changes in the selection model and updates the display accordingly.
For the first selected row expandedness will be toggled.
protected transient Icon collapsedIcon
protected transient Icon expandedIcon
protected int leftChildIndent
Distance between left margin and where vertical dashes will be drawn.
protected int rightChildIndent
Distance to add to leftChildIndent to determine where cell contents will be drawn.
protected int totalChildIndent
Total distance that will be indented. The sum of leftChildIndent and rightChildIndent.
protected Dimension preferredMinSize
Minimum preferred size.
protected int lastSelectedRow
Index of the row that was last selected.
protected JTree tree
Component that we're going to be drawing into.
protected transient TreeCellRenderer currentCellRenderer
Renderer that is being used to do the actual cell drawing.
protected boolean createdRenderer
Set to true if the renderer that is currently in the tree was created by this instance.
protected transient TreeCellEditor cellEditor
Editor for the tree.
protected boolean createdCellEditor
Set to true if editor that is currently in the tree was created by this instance.
protected boolean stopEditingInCompleteEditing
Set to false when editing and shouldSelectCell() returns true meaning the node should be selected before editing, used in completeEditing.
protected CellRendererPane rendererPane
Used to paint the TreeCellRenderer.
protected Dimension preferredSize
Size needed to completely display all the nodes.
protected boolean validCachedPreferredSize
Is the preferredSize valid?
protected AbstractLayoutCache treeState
Object responsible for handling sizing and expanded issues.
protected Hashtable<TreePath,Boolean> drawingCache
Used for minimizing the drawing of vertical lines.
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.
protected AbstractLayoutCache.NodeDimensions nodeDimensions
Reponsible for telling the TreeState the size needed for a node.
protected TreeModel treeModel
Used to determine what to display.
protected TreeSelectionModel treeSelectionModel
Model maintaining the selection.
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.
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. Should only be referenced if editingComponent is not null.
protected boolean editorHasDifferentSize
Set to true if the editor has a different size than the renderer.
public static ComponentUI createUI(JComponent x)
protected Color getHashColor()
protected void setHashColor(Color color)
public void setLeftChildIndent(int newAmount)
public int getLeftChildIndent()
public void setRightChildIndent(int newAmount)
public int getRightChildIndent()
public void setExpandedIcon(Icon newG)
public Icon getExpandedIcon()
public void setCollapsedIcon(Icon newG)
public Icon getCollapsedIcon()
protected void setLargeModel(boolean largeModel)
Updates the componentListener, if necessary.
protected boolean isLargeModel()
protected void setRowHeight(int rowHeight)
Sets the row height, this is forwarded to the treeState.
protected int getRowHeight()
protected void setCellRenderer(TreeCellRenderer tcr)
Sets the TreeCellRenderer to
tcr. This invokes
protected TreeCellRenderer getCellRenderer()
Return currentCellRenderer, which will either be the trees renderer, or defaultCellRenderer, which ever wasn't null.
protected void setModel(TreeModel model)
Sets the TreeModel.
protected TreeModel getModel()
protected void setRootVisible(boolean newValue)
Sets the root to being visible.
protected boolean isRootVisible()
protected void setShowsRootHandles(boolean newValue)
Determines whether the node handles are to be displayed.
protected boolean getShowsRootHandles()
protected void setCellEditor(TreeCellEditor editor)
Sets the cell editor.
protected TreeCellEditor getCellEditor()
protected void setEditable(boolean newValue)
Configures the receiver to allow, or not allow, editing.
protected boolean isEditable()
protected void setSelectionModel(TreeSelectionModel newLSM)
Resets the selection model. The appropriate listener are installed on the model.
protected TreeSelectionModel getSelectionModel()
public Rectangle getPathBounds(JTree tree, TreePath path)
Returns the Rectangle enclosing the label portion that the last item in path will be drawn into. Will return null if any component in path is currently valid.
public TreePath getPathForRow(JTree tree, int row)
Returns the path for passed in row. If row is not visible null is returned.
public int getRowForPath(JTree tree, TreePath path)
Returns the row that the last item identified in path is visible at. Will return -1 if any of the elements in path are not currently visible.
public int getRowCount(JTree tree)
Returns the number of rows that are being displayed.
public TreePath getClosestPathForLocation(JTree tree, int x, int y)
Returns the path to the node that is closest to x,y. If there is nothing currently visible this will return null, otherwise it'll always return a valid path. If you need to test if the returned object is exactly at x, y you should get the bounds for the returned path and test x, y against that.
public boolean isEditing(JTree tree)
Returns true if the tree is being edited. The item that is being edited can be returned by getEditingPath().
public boolean stopEditing(JTree tree)
Stops the current editing session. This has no effect if the tree isn't being edited. Returns true if the editor allows the editing session to stop.
public void cancelEditing(JTree tree)
Cancels the current editing session.
public void startEditingAtPath(JTree tree, TreePath path)
Selects the last item in path and tries to edit it. Editing will fail if the CellEditor won't allow it for the selected item.
public TreePath getEditingPath(JTree tree)
Returns the path to the element that is being edited.
public void installUI(JComponent c)
Description copied from class:
Configures the specified component appropriately 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:
LayoutManageron the component if necessary.
PropertyChangeListeneron the component in order to detect and respond to component property changes appropriately.
c- the component where this UI delegate is being installed
protected void prepareForUIInstall()
Invoked after the
tree instance variable has been set, but before any defaults/listeners have been installed.
protected void completeUIInstall()
Invoked from installUI after all the defaults/listeners have been installed.
protected void installDefaults()
protected void installListeners()
protected void installKeyboardActions()
protected void installComponents()
Intalls the subcomponents of the tree, which is the renderer pane.
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 MouseListener createMouseListener()
Creates the listener responsible for updating the selection based on mouse events.
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 PropertyChangeListener createSelectionModelPropertyChangeListener()
Creates the listener responsible for getting property change events from the selection model.
protected TreeSelectionListener createTreeSelectionListener()
Creates the listener that updates the display based on selection change methods.
protected CellEditorListener createCellEditorListener()
Creates a listener to handle events from the current editor.
protected ComponentListener createComponentListener()
Creates and returns a new ComponentHandler. This is used for the large model to mark the validCachedPreferredSize as invalid when the component moves.
protected TreeExpansionListener createTreeExpansionListener()
Creates and returns the object responsible for updating the treestate when nodes expanded state changes.
protected AbstractLayoutCache createLayoutCache()
Creates the object responsible for managing what is expanded, as well as the size of nodes.
protected CellRendererPane createCellRendererPane()
Returns the renderer pane that renderer components are placed in.
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 TreeModelListener createTreeModelListener()
Returns a listener that can update the tree when the model changes.
public void uninstallUI(JComponent c)
Description copied from class:
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:
c- the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
protected void prepareForUIUninstall()
protected void completeUIUninstall()
protected void uninstallDefaults()
protected void uninstallListeners()
protected void uninstallKeyboardActions()
protected void uninstallComponents()
Uninstalls the renderer pane.
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.
JComponentbaseline is being requested for
width- the width to get the baseline for
height- the height to get the baseline for
IllegalArgumentException- if width or height is < 0
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.
JComponentto return baseline resize behavior for
public void paint(Graphics g, JComponent c)
Description copied from class:
Paints the specified component appropriately 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.
Graphicscontext in which to paint
c- the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
protected boolean isDropLine(JTree.DropLocation loc)
Tells if a
DropLocation should be indicated by a line between nodes. This is meant for
javax.swing.DropMode.ON_OR_INSERT drop modes.
trueif the drop location should be shown as a line
protected void paintDropLine(Graphics g)
Paints the drop line.
Graphicsobject to draw on
protected Rectangle getDropLineRect(JTree.DropLocation loc)
Returns a unbounding box for the drop 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. The receiver should NOT modify
parentRow can be -1 if the root is not visible.
protected void paintVerticalPartOfLeg(Graphics g, Rectangle clipBounds, Insets insets, TreePath path)
Paints the vertical part of the leg. The receiver should NOT modify
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. The receiver should NOT modify
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. The receiver should NOT modify
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 void paintVerticalLine(Graphics g, JComponent c, int x, int top, int bottom)
Paints a vertical line.
protected void paintHorizontalLine(Graphics g, JComponent c, int y, int left, int right)
Paints a horizontal line.
protected int getVerticalLegBuffer()
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.
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.
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 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.
row- Row to return x location for
depth- Depth of the row
protected void updateLayoutCacheExpandedNodes()
Makes all the nodes that are expanded in JTree expanded in LayoutCache. This invokes updateExpandedDescendants with the root path.
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 TreePath getLastChildPath(TreePath parent)
Returns a path to the last child of
protected void updateDepthOffset()
Updates how much each depth should be offset by.
protected void updateCellEditor()
Updates the cellEditor based on the editability of the JTree that we're contained in. If the tree is editable but doesn't have a cellEditor, a basic one will be used.
protected void updateRenderer()
Messaged from the tree we're in when the renderer has changed.
protected void configureLayoutCache()
Resets the TreeState instance based on the tree we're providing the look and feel for.
protected void updateSize()
Marks the cached size as being invalid, and messages the tree with
protected void updateCachedPreferredSize()
preferredSize instance variable, which is returned from
For left to right orientations, the size is determined from the current AbstractLayoutCache. For RTL orientations, the preferred size becomes the width minus the minimum x position.
protected void pathWasExpanded(TreePath path)
Messaged from the VisibleTreeNode after it has been expanded.
protected void pathWasCollapsed(TreePath path)
Messaged from the VisibleTreeNode after it has collapsed.
protected void ensureRowsAreVisible(int beginRow, int endRow)
Ensures that the rows identified by beginRow through endRow are visible.
public void setPreferredMinSize(Dimension newSize)
Sets the preferred minimum size.
public Dimension getPreferredMinSize()
Returns the minimum preferred size.
public Dimension getPreferredSize(JComponent c)
Returns the preferred size to properly display the tree, this is a cover method for getPreferredSize(c, true).
c- the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
public Dimension getPreferredSize(JComponent c, boolean checkConsistency)
Returns the preferred size to represent the tree in c. If checkConsistency is true checkConsistency is messaged first.
public Dimension getMinimumSize(JComponent c)
Returns the minimum size for this component. Which will be the min preferred size or 0, 0.
c- the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
public 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.
c- the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
protected void completeEditing()
Messages to stop the editing session. If the UI the receiver is providing the look and feel for returns true from
getInvokesStopCellEditing, stopCellEditing will invoked on the current editor. Then completeEditing will be messaged with false, true, false to cancel any lingering editing.
protected void completeEditing(boolean messageStop, boolean messageCancel, boolean messageTree)
Stops the editing session. If messageStop is true the editor is messaged with stopEditing, if messageCancel is true the editor is messaged with cancelEditing. If messageTree is true the treeModel is messaged with valueForPathChanged.
protected boolean startEditing(TreePath path, MouseEvent event)
Will start editing for node if there is a cellEditor and shouldSelectCell returns true.
This assumes that path is valid and visible.
protected void checkForClickInExpandControl(TreePath path, int mouseX, int mouseY)
mouseY are in the expand/collapse region of the
row, this will toggle the row.
protected boolean isLocationInExpandControl(TreePath path, int mouseX, int mouseY)
Returns true if
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 void handleExpandControlClick(TreePath path, int mouseX, int mouseY)
Messaged when the user clicks the particular row, this invokes toggleExpandState.
protected void toggleExpandState(TreePath path)
Expands path if it is not expanded, or collapses row if it is expanded. If expanding a path and JTree scrolls on expand, ensureRowsAreVisible is invoked to scroll as many of the children to visible as possible (tries to scroll to last visible descendant of path).
protected boolean isToggleSelectionEvent(MouseEvent event)
Returning true signifies a mouse event on the node should toggle the selection of only the row under mouse.
protected boolean isMultiSelectEvent(MouseEvent event)
Returning true signifies a mouse event on the node should select from the anchor point.
protected boolean isToggleEvent(MouseEvent event)
Returning true indicates the row under the mouse should be toggled based on the event. This is invoked after checkForClickInExpandControl, implying the location is not in the expand (toggle) control
protected void selectPathForEvent(TreePath path, MouseEvent event)
Messaged to update the selection based on a MouseEvent over a particular row. If the event is a toggle selection event, the row is either selected, or deselected. If the event identifies a multi selection event, the selection is updated from the anchor point. Otherwise the row is selected, and if the event specified a toggle event the row is expanded/collapsed.
protected boolean isLeaf(int row)
rowis a leaf.
protected void updateLeadSelectionRow()
Updates the lead row of the selection.
protected int getLeadSelectionRow()
Returns the lead row of the selection.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.