- java.lang.Object
-
- javax.swing.plaf.ComponentUI
-
- javax.swing.plaf.TreeUI
-
- javax.swing.plaf.basic.BasicTreeUI
-
- Direct Known Subclasses:
MetalTreeUI,SynthTreeUI
public class BasicTreeUI extends TreeUI
The basic L&F for a hierarchical data structure.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classBasicTreeUI.CellEditorHandlerListener responsible for getting cell editing events and updating the tree accordingly.classBasicTreeUI.ComponentHandlerUpdates the preferred size when scrolling (if necessary).classBasicTreeUI.FocusHandlerRepaints the lead selection row when focus is lost/gained.classBasicTreeUI.KeyHandlerThis is used to get multiple key down events to appropriately generate events.classBasicTreeUI.MouseHandlerTreeMouseListener is responsible for updating the selection based on mouse events.classBasicTreeUI.MouseInputHandlerMouseInputHandler handles passing all mouse events, including mouse motion events, until the mouse is released to the destination it is constructed with.classBasicTreeUI.NodeDimensionsHandlerClass responsible for getting size of node, method is forwarded to BasicTreeUI method.classBasicTreeUI.PropertyChangeHandlerPropertyChangeListener for the tree.classBasicTreeUI.SelectionModelPropertyChangeHandlerListener on the TreeSelectionModel, resets the row selection if any of the properties of the model change.classBasicTreeUI.TreeCancelEditingActionActionListener that invokes cancelEditing when action performed.classBasicTreeUI.TreeExpansionHandlerUpdates the TreeState in response to nodes expanding/collapsing.classBasicTreeUI.TreeHomeActionTreeHomeAction is used to handle end/home actions.classBasicTreeUI.TreeIncrementActionTreeIncrementAction is used to handle up/down actions.classBasicTreeUI.TreeModelHandlerForwards all TreeModel events to the TreeState.classBasicTreeUI.TreePageActionTreePageAction handles page up and page down events.classBasicTreeUI.TreeSelectionHandlerListens for changes in the selection model and updates the display accordingly.classBasicTreeUI.TreeToggleActionFor the first selected row expandedness will be toggled.classBasicTreeUI.TreeTraverseActionTreeTraverseActionis the action used for left/right keys.
-
Field Summary
Fields Modifier and Type Field Description protected TreeCellEditorcellEditorEditor for the tree.protected IconcollapsedIconThe collapsed icon.protected booleancreatedCellEditorSet to true if editor that is currently in the tree was created by this instance.protected booleancreatedRendererSet to true if the renderer that is currently in the tree was created by this instance.protected TreeCellRenderercurrentCellRendererRenderer that is being used to do the actual cell drawing.protected intdepthOffsetHow much the depth should be offset to properly calculate x locations.protected Hashtable<TreePath,Boolean>drawingCacheUsed for minimizing the drawing of vertical lines.protected ComponenteditingComponentWhen editing, this will be the Component that is doing the actual editing.protected TreePatheditingPathPath that is being edited.protected inteditingRowRow that is being edited.protected booleaneditorHasDifferentSizeSet to true if the editor has a different size than the renderer.protected IconexpandedIconThe expanded icon.protected booleanlargeModelTrue if doing optimizations for a largeModel.protected intlastSelectedRowIndex of the row that was last selected.protected intleftChildIndentDistance between left margin and where vertical dashes will be drawn.protected AbstractLayoutCache.NodeDimensionsnodeDimensionsReponsible for telling the TreeState the size needed for a node.protected DimensionpreferredMinSizeMinimum preferred size.protected DimensionpreferredSizeSize needed to completely display all the nodes.protected CellRendererPanerendererPaneUsed to paint the TreeCellRenderer.protected intrightChildIndentDistance to add to leftChildIndent to determine where cell contents will be drawn.protected booleanstopEditingInCompleteEditingSet to false when editing and shouldSelectCell() returns true meaning the node should be selected before editing, used in completeEditing.protected inttotalChildIndentTotal distance that will be indented.protected JTreetreeComponent that we're going to be drawing into.protected TreeModeltreeModelUsed to determine what to display.protected TreeSelectionModeltreeSelectionModelModel maintaining the selection.protected AbstractLayoutCachetreeStateObject responsible for handling sizing and expanded issues.protected booleanvalidCachedPreferredSizeIs the preferredSize valid?
-
Constructor Summary
Constructors Constructor Description BasicTreeUI()Constructs a new instance ofBasicTreeUI.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcancelEditing(JTree tree)Cancels the current editing session.protected voidcheckForClickInExpandControl(TreePath path, int mouseX, int mouseY)If themouseXandmouseYare in the expand/collapse region of therow, this will toggle the row.protected voidcompleteEditing()Messages to stop the editing session.protected voidcompleteEditing(boolean messageStop, boolean messageCancel, boolean messageTree)Stops the editing session.protected voidcompleteUIInstall()Invoked from installUI after all the defaults/listeners have been installed.protected voidcompleteUIUninstall()Uninstalls UI.protected voidconfigureLayoutCache()Resets the TreeState instance based on the tree we're providing the look and feel for.protected CellEditorListenercreateCellEditorListener()Creates a listener to handle events from the current editor.protected CellRendererPanecreateCellRendererPane()Returns the renderer pane that renderer components are placed in.protected ComponentListenercreateComponentListener()Creates and returns a new ComponentHandler.protected TreeCellEditorcreateDefaultCellEditor()Creates a default cell editor.protected TreeCellRenderercreateDefaultCellRenderer()Returns the default cell renderer that is used to do the stamping of each node.protected FocusListenercreateFocusListener()Creates a listener that is responsible for updating the display when focus is lost/gained.protected KeyListenercreateKeyListener()Creates the listener responsible for getting key events from the tree.protected AbstractLayoutCachecreateLayoutCache()Creates the object responsible for managing what is expanded, as well as the size of nodes.protected MouseListenercreateMouseListener()Creates the listener responsible for updating the selection based on mouse events.protected AbstractLayoutCache.NodeDimensionscreateNodeDimensions()Creates an instance ofNodeDimensionsthat is able to determine the size of a given node in the tree.protected PropertyChangeListenercreatePropertyChangeListener()Creates a listener that is responsible that updates the UI based on how the tree changes.protected PropertyChangeListenercreateSelectionModelPropertyChangeListener()Creates the listener responsible for getting property change events from the selection model.protected TreeExpansionListenercreateTreeExpansionListener()Creates and returns the object responsible for updating the treestate when nodes expanded state changes.protected TreeModelListenercreateTreeModelListener()Returns a listener that can update the tree when the model changes.protected TreeSelectionListenercreateTreeSelectionListener()Creates the listener that updates the display based on selection change methods.static ComponentUIcreateUI(JComponent x)Constructs a new instance ofBasicTreeUI.protected voiddrawCentered(Component c, Graphics graphics, Icon icon, int x, int y)Draws theiconcentered at (x,y).protected voiddrawDashedHorizontalLine(Graphics g, int y, int x1, int x2)Draws a horizontal dashed line.protected voiddrawDashedVerticalLine(Graphics g, int x, int y1, int y2)Draws a vertical dashed line.protected voidensureRowsAreVisible(int beginRow, int endRow)Ensures that the rows identified bybeginRowthroughendRoware visible.intgetBaseline(JComponent c, int width, int height)Returns the baseline.Component.BaselineResizeBehaviorgetBaselineResizeBehavior(JComponent c)Returns an enum indicating how the baseline of the component changes as the size changes.protected TreeCellEditorgetCellEditor()Returns an instance ofTreeCellEditor.protected TreeCellRenderergetCellRenderer()ReturncurrentCellRenderer, which will either be the trees renderer, ordefaultCellRenderer, which ever wasn't null.TreePathgetClosestPathForLocation(JTree tree, int x, int y)Returns the path to the node that is closest to x,y.IcongetCollapsedIcon()Returns the collapsed icon.protected RectanglegetDropLineRect(JTree.DropLocation loc)Returns a unbounding box for the drop line.TreePathgetEditingPath(JTree tree)Returns the path to the element that is being edited.IcongetExpandedIcon()Returns the expanded icon.protected ColorgetHashColor()Returns the hash color.protected intgetHorizontalLegBuffer()The horizontal element of legs between nodes starts at the right of the left-hand side of the child node by default.protected TreePathgetLastChildPath(TreePath parent)Returns a path to the last child ofparent.protected intgetLeadSelectionRow()Returns the lead row of the selection.intgetLeftChildIndent()Returns the left child indent.DimensiongetMaximumSize(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.DimensiongetMinimumSize(JComponent c)Returns the minimum size for this component.protected TreeModelgetModel()Returns the tree model.RectanglegetPathBounds(JTree tree, TreePath path)Returns the Rectangle enclosing the label portion that the last item in path will be drawn into.TreePathgetPathForRow(JTree tree, int row)Returns the path for passed in row.DimensiongetPreferredMinSize()Returns the minimum preferred size.DimensiongetPreferredSize(JComponent c)Returns the preferred size to properly display the tree, this is a cover method forgetPreferredSize(c, true).DimensiongetPreferredSize(JComponent c, boolean checkConsistency)Returns the preferred size to represent the tree in c.intgetRightChildIndent()Returns the right child indent.intgetRowCount(JTree tree)Returns the number of rows that are being displayed.intgetRowForPath(JTree tree, TreePath path)Returns the row that the last item identified in path is visible at.protected intgetRowHeight()Returns the row height.protected intgetRowX(int row, int depth)Returns the location, along the x-axis, to render a particular row at.protected TreeSelectionModelgetSelectionModel()Returns the tree selection model.protected booleangetShowsRootHandles()Returnstrueif the root handles are to be displayed.protected intgetVerticalLegBuffer()The vertical element of legs between nodes starts at the bottom of the parent node by default.protected voidhandleExpandControlClick(TreePath path, int mouseX, int mouseY)Messaged when the user clicks the particular row, this invokestoggleExpandState.protected voidinstallComponents()Intalls the subcomponents of the tree, which is the renderer pane.protected voidinstallDefaults()Installs default properties.protected voidinstallKeyboardActions()Registers keyboard actions.protected voidinstallListeners()Registers listeners.protected booleanisDropLine(JTree.DropLocation loc)Tells if aDropLocationshould be indicated by a line between nodes.protected booleanisEditable()Returnstrueif the tree is editable.booleanisEditing(JTree tree)Returns true if the tree is being edited.protected booleanisLargeModel()Returnstrueif large model is set.protected booleanisLeaf(int row)Returnstrueif the node atrowis a leaf.protected booleanisLocationInExpandControl(TreePath path, int mouseX, int mouseY)ReturnstrueifmouseXandmouseYfall in the area of row that is used to expand/collapse the node and the node atrowdoes not represent a leaf.protected booleanisMultiSelectEvent(MouseEvent event)Returningtruesignifies a mouse event on the node should select from the anchor point.protected booleanisRootVisible()Returnstrueif the tree root is visible.protected booleanisToggleEvent(MouseEvent event)Returningtrueindicates the row under the mouse should be toggled based on the event.protected booleanisToggleSelectionEvent(MouseEvent event)Returningtruesignifies a mouse event on the node should toggle the selection of only the row under mouse.protected voidpaintDropLine(Graphics g)Paints the drop line.protected voidpaintExpandControl(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 voidpaintHorizontalLine(Graphics g, JComponent c, int y, int left, int right)Paints a horizontal line.protected voidpaintHorizontalPartOfLeg(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 voidpaintRow(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 voidpaintVerticalLine(Graphics g, JComponent c, int x, int top, int bottom)Paints a vertical line.protected voidpaintVerticalPartOfLeg(Graphics g, Rectangle clipBounds, Insets insets, TreePath path)Paints the vertical part of the leg.protected voidpathWasCollapsed(TreePath path)Messaged from theVisibleTreeNodeafter it has collapsed.protected voidpathWasExpanded(TreePath path)Messaged from theVisibleTreeNodeafter it has been expanded.protected voidprepareForUIInstall()Invoked after thetreeinstance variable has been set, but before any defaults/listeners have been installed.protected voidprepareForUIUninstall()Invoked before unstallation of UI.protected voidselectPathForEvent(TreePath path, MouseEvent event)Messaged to update the selection based on aMouseEventover a particular row.protected voidsetCellEditor(TreeCellEditor editor)Sets the cell editor.protected voidsetCellRenderer(TreeCellRenderer tcr)Sets theTreeCellRenderertotcr.voidsetCollapsedIcon(Icon newG)Sets the collapsed icon.protected voidsetEditable(boolean newValue)Configures the receiver to allow, or not allow, editing.voidsetExpandedIcon(Icon newG)Sets the expanded icon.protected voidsetHashColor(Color color)Sets the hash color.protected voidsetLargeModel(boolean largeModel)Updates the componentListener, if necessary.voidsetLeftChildIndent(int newAmount)Sets the left child indent.protected voidsetModel(TreeModel model)Sets theTreeModel.voidsetPreferredMinSize(Dimension newSize)Sets the preferred minimum size.voidsetRightChildIndent(int newAmount)Sets the right child indent.protected voidsetRootVisible(boolean newValue)Sets the root to being visible.protected voidsetRowHeight(int rowHeight)Sets the row height, this is forwarded to the treeState.protected voidsetSelectionModel(TreeSelectionModel newLSM)Resets the selection model.protected voidsetShowsRootHandles(boolean newValue)Determines whether the node handles are to be displayed.protected booleanshouldPaintExpandControl(TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf)Returnstrueif the expand (toggle) control should be drawn for the specified row.protected booleanstartEditing(TreePath path, MouseEvent event)Will start editing for node if there is acellEditorandshouldSelectCellreturnstrue.voidstartEditingAtPath(JTree tree, TreePath path)Selects the last item in path and tries to edit it.booleanstopEditing(JTree tree)Stops the current editing session.protected voidtoggleExpandState(TreePath path)Expands path if it is not expanded, or collapses row if it is expanded.protected voiduninstallComponents()Uninstalls the renderer pane.protected voiduninstallDefaults()Uninstalls default properties.protected voiduninstallKeyboardActions()Unregisters keyboard actions.protected voiduninstallListeners()Unregisters listeners.protected voidupdateCachedPreferredSize()Updates thepreferredSizeinstance variable, which is returned fromgetPreferredSize().protected voidupdateCellEditor()Updates the cellEditor based on the editability of the JTree that we're contained in.protected voidupdateDepthOffset()Updates how much each depth should be offset by.protected voidupdateExpandedDescendants(TreePath path)Updates the expanded state of all the descendants ofpathby getting the expanded descendants from the tree and forwarding to the tree state.protected voidupdateLayoutCacheExpandedNodes()Makes all the nodes that are expanded in JTree expanded in LayoutCache.protected voidupdateLeadSelectionRow()Updates the lead row of the selection.protected voidupdateRenderer()Messaged from the tree we're in when the renderer has changed.protected voidupdateSize()Marks the cached size as being invalid, and messages the tree withtreeDidChange.-
Methods declared in class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, installUI, paint, uninstallUI, update
-
-
-
-
Field Detail
-
collapsedIcon
protected transient Icon collapsedIcon
The collapsed icon.
-
expandedIcon
protected transient Icon expandedIcon
The expanded icon.
-
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 maintaining 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.
-
-
Method Detail
-
createUI
public static ComponentUI createUI(JComponent x)
Constructs a new instance ofBasicTreeUI.- Parameters:
x- a component- Returns:
- a new instance of
BasicTreeUI
-
getHashColor
protected Color getHashColor()
Returns the hash color.- Returns:
- the hash color
-
setHashColor
protected void setHashColor(Color color)
Sets the hash color.- Parameters:
color- the hash color
-
setLeftChildIndent
public void setLeftChildIndent(int newAmount)
Sets the left child indent.- Parameters:
newAmount- the left child indent
-
getLeftChildIndent
public int getLeftChildIndent()
Returns the left child indent.- Returns:
- the left child indent
-
setRightChildIndent
public void setRightChildIndent(int newAmount)
Sets the right child indent.- Parameters:
newAmount- the right child indent
-
getRightChildIndent
public int getRightChildIndent()
Returns the right child indent.- Returns:
- the right child indent
-
setExpandedIcon
public void setExpandedIcon(Icon newG)
Sets the expanded icon.- Parameters:
newG- the expanded icon
-
getExpandedIcon
public Icon getExpandedIcon()
Returns the expanded icon.- Returns:
- the expanded icon
-
setCollapsedIcon
public void setCollapsedIcon(Icon newG)
Sets the collapsed icon.- Parameters:
newG- the collapsed icon
-
getCollapsedIcon
public Icon getCollapsedIcon()
Returns the collapsed icon.- Returns:
- the collapsed icon
-
setLargeModel
protected void setLargeModel(boolean largeModel)
Updates the componentListener, if necessary.- Parameters:
largeModel- the new value
-
isLargeModel
protected boolean isLargeModel()
Returnstrueif large model is set.- Returns:
trueif large model is set
-
setRowHeight
protected void setRowHeight(int rowHeight)
Sets the row height, this is forwarded to the treeState.- Parameters:
rowHeight- the row height
-
getRowHeight
protected int getRowHeight()
Returns the row height.- Returns:
- the row height
-
setCellRenderer
protected void setCellRenderer(TreeCellRenderer tcr)
Sets theTreeCellRenderertotcr. This invokesupdateRenderer.- Parameters:
tcr- the new value
-
getCellRenderer
protected TreeCellRenderer getCellRenderer()
ReturncurrentCellRenderer, which will either be the trees renderer, ordefaultCellRenderer, which ever wasn't null.- Returns:
- an instance of
TreeCellRenderer
-
setModel
protected void setModel(TreeModel model)
Sets theTreeModel.- Parameters:
model- the new value
-
getModel
protected TreeModel getModel()
Returns the tree model.- Returns:
- the tree model
-
setRootVisible
protected void setRootVisible(boolean newValue)
Sets the root to being visible.- Parameters:
newValue- the new value
-
isRootVisible
protected boolean isRootVisible()
Returnstrueif the tree root is visible.- Returns:
trueif the tree root is visible
-
setShowsRootHandles
protected void setShowsRootHandles(boolean newValue)
Determines whether the node handles are to be displayed.- Parameters:
newValue- the new value
-
getShowsRootHandles
protected boolean getShowsRootHandles()
Returnstrueif the root handles are to be displayed.- Returns:
trueif the root handles are to be displayed
-
setCellEditor
protected void setCellEditor(TreeCellEditor editor)
Sets the cell editor.- Parameters:
editor- the new cell editor
-
getCellEditor
protected TreeCellEditor getCellEditor()
Returns an instance ofTreeCellEditor.- Returns:
- an instance of
TreeCellEditor
-
setEditable
protected void setEditable(boolean newValue)
Configures the receiver to allow, or not allow, editing.- Parameters:
newValue- the new value
-
isEditable
protected boolean isEditable()
Returnstrueif the tree is editable.- Returns:
trueif the tree is editable
-
setSelectionModel
protected void setSelectionModel(TreeSelectionModel newLSM)
Resets the selection model. The appropriate listener are installed on the model.- Parameters:
newLSM- new selection model
-
getSelectionModel
protected TreeSelectionModel getSelectionModel()
Returns the tree selection model.- Returns:
- the tree selection model
-
getPathBounds
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.- Specified by:
getPathBoundsin classTreeUI- Parameters:
tree- theJTreeforpathpath- theTreePathidentifying the node- Returns:
- the
Rectangleenclosing the label portion that the last item in path will be drawn into,nullif any component in path is currently valid.
-
getPathForRow
public TreePath getPathForRow(JTree tree, int row)
Returns the path for passed in row. If row is not visible null is returned.- Specified by:
getPathForRowin classTreeUI- Parameters:
tree- aJTreeobjectrow- an integer specifying a row- Returns:
- the
pathforrowornullifrowis not visible
-
getRowForPath
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.- Specified by:
getRowForPathin classTreeUI- Parameters:
tree- theJTreeforpathpath- theTreePathobject to look in- Returns:
- an integer specifying the row at which the last item
identified is visible, -1 if any of the elements in
pathare not currently visible
-
getRowCount
public int getRowCount(JTree tree)
Returns the number of rows that are being displayed.- Specified by:
getRowCountin classTreeUI- Parameters:
tree- theJTreefor which to count rows- Returns:
- an integer specifying the number of row being displayed
-
getClosestPathForLocation
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.- Specified by:
getClosestPathForLocationin classTreeUI- Parameters:
tree- aJTreeobjectx- an integer giving the number of pixels horizontally from the left edge of the display areay- an integer giving the number of pixels vertically from the top of the display area, minus any top margin- Returns:
- the
TreePathnode closest tox,yornullif there is nothing currently visible
-
isEditing
public boolean isEditing(JTree tree)
Returns true if the tree is being edited. The item that is being edited can be returned by getEditingPath().
-
stopEditing
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.- Specified by:
stopEditingin classTreeUI- Parameters:
tree- aJTreeobject- Returns:
- true if the editor allows the editing session to stop
-
cancelEditing
public void cancelEditing(JTree tree)
Cancels the current editing session.- Specified by:
cancelEditingin classTreeUI- Parameters:
tree- aJTreeobject
-
startEditingAtPath
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.- Specified by:
startEditingAtPathin classTreeUI- Parameters:
tree- theJTreebeing editedpath- theTreePathto be edited
-
getEditingPath
public TreePath getEditingPath(JTree tree)
Returns the path to the element that is being edited.- Specified by:
getEditingPathin classTreeUI- Parameters:
tree- theJTreefor which to return a path- Returns:
- a
TreePathcontaining the path totree
-
prepareForUIInstall
protected void prepareForUIInstall()
Invoked after thetreeinstance variable has been set, but before any defaults/listeners have been installed.
-
completeUIInstall
protected void completeUIInstall()
Invoked from installUI after all the defaults/listeners have been installed.
-
installDefaults
protected void installDefaults()
Installs default properties.
-
installListeners
protected void installListeners()
Registers listeners.
-
installKeyboardActions
protected void installKeyboardActions()
Registers keyboard actions.
-
installComponents
protected void installComponents()
Intalls the subcomponents of the tree, which is the renderer pane.
-
createNodeDimensions
protected AbstractLayoutCache.NodeDimensions createNodeDimensions()
Creates an instance ofNodeDimensionsthat is able to determine the size of a given node in the tree.- Returns:
- an instance of
NodeDimensions
-
createPropertyChangeListener
protected PropertyChangeListener createPropertyChangeListener()
Creates a listener that is responsible that updates the UI based on how the tree changes.- Returns:
- an instance of the
PropertyChangeListener
-
createMouseListener
protected MouseListener createMouseListener()
Creates the listener responsible for updating the selection based on mouse events.- Returns:
- an instance of the
MouseListener
-
createFocusListener
protected FocusListener createFocusListener()
Creates a listener that is responsible for updating the display when focus is lost/gained.- Returns:
- an instance of the
FocusListener
-
createKeyListener
protected KeyListener createKeyListener()
Creates the listener responsible for getting key events from the tree.- Returns:
- an instance of the
KeyListener
-
createSelectionModelPropertyChangeListener
protected PropertyChangeListener createSelectionModelPropertyChangeListener()
Creates the listener responsible for getting property change events from the selection model.- Returns:
- an instance of the
PropertyChangeListener
-
createTreeSelectionListener
protected TreeSelectionListener createTreeSelectionListener()
Creates the listener that updates the display based on selection change methods.- Returns:
- an instance of the
TreeSelectionListener
-
createCellEditorListener
protected CellEditorListener createCellEditorListener()
Creates a listener to handle events from the current editor.- Returns:
- an instance of the
CellEditorListener
-
createComponentListener
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.- Returns:
- an instance of the
ComponentListener
-
createTreeExpansionListener
protected TreeExpansionListener createTreeExpansionListener()
Creates and returns the object responsible for updating the treestate when nodes expanded state changes.- Returns:
- an instance of the
TreeExpansionListener
-
createLayoutCache
protected AbstractLayoutCache createLayoutCache()
Creates the object responsible for managing what is expanded, as well as the size of nodes.- Returns:
- the object responsible for managing what is expanded
-
createCellRendererPane
protected CellRendererPane createCellRendererPane()
Returns the renderer pane that renderer components are placed in.- Returns:
- an instance of the
CellRendererPane
-
createDefaultCellEditor
protected TreeCellEditor createDefaultCellEditor()
Creates a default cell editor.- Returns:
- a default cell editor
-
createDefaultCellRenderer
protected TreeCellRenderer createDefaultCellRenderer()
Returns the default cell renderer that is used to do the stamping of each node.- Returns:
- an instance of
TreeCellRenderer
-
createTreeModelListener
protected TreeModelListener createTreeModelListener()
Returns a listener that can update the tree when the model changes.- Returns:
- an instance of the
TreeModelListener.
-
prepareForUIUninstall
protected void prepareForUIUninstall()
Invoked before unstallation of UI.
-
completeUIUninstall
protected void completeUIUninstall()
Uninstalls UI.
-
uninstallDefaults
protected void uninstallDefaults()
Uninstalls default properties.
-
uninstallListeners
protected void uninstallListeners()
Unregisters listeners.
-
uninstallKeyboardActions
protected void uninstallKeyboardActions()
Unregisters keyboard actions.
-
uninstallComponents
protected void uninstallComponents()
Uninstalls the renderer pane.
-
getBaseline
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.- Overrides:
getBaselinein classComponentUI- Parameters:
c-JComponentbaseline is being requested forwidth- the width to get the baseline forheight- the height to get the baseline for- Returns:
- baseline or a value < 0 indicating there is no reasonable baseline
- Throws:
NullPointerException- ifcisnullIllegalArgumentException- if width or height is < 0- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
getBaselineResizeBehavior
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.- Overrides:
getBaselineResizeBehaviorin classComponentUI- Parameters:
c-JComponentto return baseline resize behavior for- Returns:
- an enum indicating how the baseline changes as the component size changes
- Throws:
NullPointerException- ifcisnull- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
isDropLine
protected boolean isDropLine(JTree.DropLocation loc)
Tells if aDropLocationshould be indicated by a line between nodes. This is meant forjavax.swing.DropMode.INSERTandjavax.swing.DropMode.ON_OR_INSERTdrop modes.- Parameters:
loc- aDropLocation- Returns:
trueif the drop location should be shown as a line- Since:
- 1.7
-
paintDropLine
protected void paintDropLine(Graphics g)
Paints the drop line.- Parameters:
g-Graphicsobject to draw on- Since:
- 1.7
-
getDropLineRect
protected Rectangle getDropLineRect(JTree.DropLocation loc)
Returns a unbounding box for the drop line.- Parameters:
loc- aDropLocation- Returns:
- bounding box for the drop line
- Since:
- 1.7
-
paintHorizontalPartOfLeg
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 modifyclipBounds, orinsets.NOTE:
parentRowcan be -1 if the root is not visible.- Parameters:
g- a graphics contextclipBounds- a clipped rectangleinsets- insetsbounds- a bounding rectanglepath- a tree pathrow- a rowisExpanded-trueif the path is expandedhasBeenExpanded-trueif the path has been expandedisLeaf-trueif the path is leaf
-
paintVerticalPartOfLeg
protected void paintVerticalPartOfLeg(Graphics g, Rectangle clipBounds, Insets insets, TreePath path)
Paints the vertical part of the leg. The receiver should NOT modifyclipBounds,insets.- Parameters:
g- a graphics contextclipBounds- a clipped rectangleinsets- insetspath- a tree path
-
paintExpandControl
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 modifyclipBounds, orinsets.- Parameters:
g- a graphics contextclipBounds- a clipped rectangleinsets- insetsbounds- a bounding rectanglepath- a tree pathrow- a rowisExpanded-trueif the path is expandedhasBeenExpanded-trueif the path has been expandedisLeaf-trueif the row is leaf
-
paintRow
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 modifyclipBounds, orinsets.- Parameters:
g- a graphics contextclipBounds- a clipped rectangleinsets- insetsbounds- a bounding rectanglepath- a tree pathrow- a rowisExpanded-trueif the path is expandedhasBeenExpanded-trueif the path has been expandedisLeaf-trueif the path is leaf
-
shouldPaintExpandControl
protected boolean shouldPaintExpandControl(TreePath path, int row, boolean isExpanded, boolean hasBeenExpanded, boolean isLeaf)
Returnstrueif the expand (toggle) control should be drawn for the specified row.- Parameters:
path- a tree pathrow- a rowisExpanded-trueif the path is expandedhasBeenExpanded-trueif the path has been expandedisLeaf-trueif the row is leaf- Returns:
trueif the expand (toggle) control should be drawn for the specified row
-
paintVerticalLine
protected void paintVerticalLine(Graphics g, JComponent c, int x, int top, int bottom)
Paints a vertical line.- Parameters:
g- a graphics contextc- a componentx- an X coordinatetop- an Y1 coordinatebottom- an Y2 coordinate
-
paintHorizontalLine
protected void paintHorizontalLine(Graphics g, JComponent c, int y, int left, int right)
Paints a horizontal line.- Parameters:
g- a graphics contextc- a componenty- an Y coordinateleft- an X1 coordinateright- an X2 coordinate
-
getVerticalLegBuffer
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.- Returns:
- the vertical leg buffer
-
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.- Returns:
- the horizontal leg buffer
-
drawCentered
protected void drawCentered(Component c, Graphics graphics, Icon icon, int x, int y)
Draws theiconcentered at (x,y).- Parameters:
c- a componentgraphics- a graphics contexticon- an iconx- an X coordinatey- an Y coordinate
-
drawDashedHorizontalLine
protected void drawDashedHorizontalLine(Graphics g, int y, int x1, int x2)
Draws a horizontal dashed line. It is assumedx1<=x2. Ifx1is greater thanx2, the method draws nothing.- Parameters:
g- an instance ofGraphicsy- an Y coordinatex1- an X1 coordinatex2- an X2 coordinate
-
drawDashedVerticalLine
protected void drawDashedVerticalLine(Graphics g, int x, int y1, int y2)
Draws a vertical dashed line. It is assumedy1<=y2. Ify1is greater thany2, the method draws nothing.- Parameters:
g- an instance ofGraphicsx- an X coordinatey1- an Y1 coordinatey2- an Y2 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 fordepth- Depth of the row- Returns:
- amount to indent the given row.
- Since:
- 1.5
-
updateLayoutCacheExpandedNodes
protected void updateLayoutCacheExpandedNodes()
Makes all the nodes that are expanded in JTree expanded in LayoutCache. This invokes updateExpandedDescendants with the root path.
-
updateExpandedDescendants
protected void updateExpandedDescendants(TreePath path)
Updates the expanded state of all the descendants ofpathby getting the expanded descendants from the tree and forwarding to the tree state.- Parameters:
path- a tree path
-
getLastChildPath
protected TreePath getLastChildPath(TreePath parent)
Returns a path to the last child ofparent.- Parameters:
parent- a tree path- Returns:
- a path to the last child of
parent
-
updateDepthOffset
protected void updateDepthOffset()
Updates how much each depth should be offset by.
-
updateCellEditor
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.
-
updateRenderer
protected void updateRenderer()
Messaged from the tree we're in when the renderer has changed.
-
configureLayoutCache
protected void configureLayoutCache()
Resets the TreeState instance based on the tree we're providing the look and feel for.
-
updateSize
protected void updateSize()
Marks the cached size as being invalid, and messages the tree withtreeDidChange.
-
updateCachedPreferredSize
protected void updateCachedPreferredSize()
Updates thepreferredSizeinstance variable, which is returned fromgetPreferredSize().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.
-
pathWasExpanded
protected void pathWasExpanded(TreePath path)
Messaged from theVisibleTreeNodeafter it has been expanded.- Parameters:
path- a tree path
-
pathWasCollapsed
protected void pathWasCollapsed(TreePath path)
Messaged from theVisibleTreeNodeafter it has collapsed.- Parameters:
path- a tree path
-
ensureRowsAreVisible
protected void ensureRowsAreVisible(int beginRow, int endRow)Ensures that the rows identified bybeginRowthroughendRoware visible.- Parameters:
beginRow- the begin rowendRow- the end row
-
setPreferredMinSize
public void setPreferredMinSize(Dimension newSize)
Sets the preferred minimum size.- Parameters:
newSize- the new preferred size
-
getPreferredMinSize
public Dimension getPreferredMinSize()
Returns the minimum preferred size.- Returns:
- the minimum preferred size
-
getPreferredSize
public Dimension getPreferredSize(JComponent c)
Returns the preferred size to properly display the tree, this is a cover method forgetPreferredSize(c, true).- Overrides:
getPreferredSizein classComponentUI- Parameters:
c- a component- Returns:
- the preferred size to represent the tree in the component
- See Also:
JComponent.getPreferredSize(),LayoutManager.preferredLayoutSize(java.awt.Container)
-
getPreferredSize
public Dimension getPreferredSize(JComponent c, boolean checkConsistency)
Returns the preferred size to represent the tree in c. If checkConsistency istruecheckConsistency is messaged first.- Parameters:
c- a componentcheckConsistency- iftrueconsistency is checked- Returns:
- the preferred size to represent the tree in the component
-
getMinimumSize
public Dimension getMinimumSize(JComponent c)
Returns the minimum size for this component. Which will be the min preferred size or 0, 0.- Overrides:
getMinimumSizein classComponentUI- Parameters:
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- Returns:
- a
Dimensionobject ornull - See Also:
JComponent.getMinimumSize(),LayoutManager.minimumLayoutSize(java.awt.Container),ComponentUI.getPreferredSize(javax.swing.JComponent)
-
getMaximumSize
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.- Overrides:
getMaximumSizein classComponentUI- Parameters:
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- Returns:
- a
Dimensionobject ornull - See Also:
JComponent.getMaximumSize(),LayoutManager2.maximumLayoutSize(java.awt.Container)
-
completeEditing
protected void completeEditing()
Messages to stop the editing session. If the UI the receiver is providing the look and feel for returns true fromgetInvokesStopCellEditing, stopCellEditing will invoked on the current editor. Then completeEditing will be messaged with false, true, false to cancel any lingering editing.
-
completeEditing
protected void completeEditing(boolean messageStop, boolean messageCancel, boolean messageTree)Stops the editing session. IfmessageStopistruethe editor is messaged withstopEditing, ifmessageCancelistruethe editor is messaged withcancelEditing. IfmessageTreeistruethetreeModelis messaged withvalueForPathChanged.- Parameters:
messageStop- message to stop editingmessageCancel- message to cancel editingmessageTree- message to tree
-
startEditing
protected boolean startEditing(TreePath path, MouseEvent event)
Will start editing for node if there is acellEditorandshouldSelectCellreturnstrue.This assumes that path is valid and visible.
- Parameters:
path- a tree pathevent- a mouse event- Returns:
trueif the editing is successful
-
checkForClickInExpandControl
protected void checkForClickInExpandControl(TreePath path, int mouseX, int mouseY)
If themouseXandmouseYare in the expand/collapse region of therow, this will toggle the row.- Parameters:
path- a tree pathmouseX- an X coordinatemouseY- an Y coordinate
-
isLocationInExpandControl
protected boolean isLocationInExpandControl(TreePath path, int mouseX, int mouseY)
ReturnstrueifmouseXandmouseYfall in the area of row that is used to expand/collapse the node and the node atrowdoes not represent a leaf.- Parameters:
path- a tree pathmouseX- an X coordinatemouseY- an Y coordinate- Returns:
trueif the mouse cursor fall in the area of row that is used to expand/collapse the node and the node is not a leaf.
-
handleExpandControlClick
protected void handleExpandControlClick(TreePath path, int mouseX, int mouseY)
Messaged when the user clicks the particular row, this invokestoggleExpandState.- Parameters:
path- a tree pathmouseX- an X coordinatemouseY- an Y coordinate
-
toggleExpandState
protected void toggleExpandState(TreePath path)
Expands path if it is not expanded, or collapses row if it is expanded. If expanding a path andJTreescrolls on expand,ensureRowsAreVisibleis invoked to scroll as many of the children to visible as possible (tries to scroll to last visible descendant of path).- Parameters:
path- a tree path
-
isToggleSelectionEvent
protected boolean isToggleSelectionEvent(MouseEvent event)
Returningtruesignifies a mouse event on the node should toggle the selection of only the row under mouse.- Parameters:
event- a mouse event- Returns:
trueif a mouse event on the node should toggle the selection
-
isMultiSelectEvent
protected boolean isMultiSelectEvent(MouseEvent event)
Returningtruesignifies a mouse event on the node should select from the anchor point.- Parameters:
event- a mouse event- Returns:
trueif a mouse event on the node should select from the anchor point
-
isToggleEvent
protected boolean isToggleEvent(MouseEvent event)
Returningtrueindicates the row under the mouse should be toggled based on the event. This is invoked aftercheckForClickInExpandControl, implying the location is not in the expand (toggle) control.- Parameters:
event- a mouse event- Returns:
trueif the row under the mouse should be toggled
-
selectPathForEvent
protected void selectPathForEvent(TreePath path, MouseEvent event)
Messaged to update the selection based on aMouseEventover 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.- Parameters:
path- the selected pathevent- the mouse event
-
isLeaf
protected boolean isLeaf(int row)
Returnstrueif the node atrowis a leaf.- Parameters:
row- a row- Returns:
trueif the node atrowis a leaf
-
updateLeadSelectionRow
protected void updateLeadSelectionRow()
Updates the lead row of the selection.- Since:
- 1.7
-
getLeadSelectionRow
protected int getLeadSelectionRow()
Returns the lead row of the selection.- Returns:
- selection lead row
- Since:
- 1.7
-
-