Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.tree

Interface TreeBuilder

All Superinterfaces:

ComponentBuilder<JTree,TreeBuilder>, Supplier<JTree>

public interface TreeBuilder
extends ComponentBuilder<JTree,TreeBuilder>

A builder for JTree.

The tree selects the row under the mouse before a JPopupMenu is shown, so that the popup menu actions apply to what was clicked, where a JTree leaves the selection as is: the row, unless already selected, and nothing below the last row, clearing the selection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TreeBuilder.ModelStep	Provides a TreeBuilder.

Method Summary

Modifier and Type	Method	Description
static TreeBuilder.ModelStep	builder()
TreeBuilder	cellRenderer(TreeCellRenderer cellRenderer)
TreeBuilder	doubleClick(Action doubleClick)	Performs the given action on a double-click with the left mouse button on a selected node, the first click selecting it, if the action is enabled.
TreeBuilder	dragEnabled(boolean dragEnabled)
TreeBuilder	dropMode(DropMode dropMode)
TreeBuilder	editable(boolean editable)
TreeBuilder	expandsSelectedPaths(boolean expandsSelectedPaths)
TreeBuilder	invokesStopCellEditing(boolean invokesStopCellEditing)
TreeBuilder	largeModel(boolean largeModel)
TreeBuilder	rootVisible(boolean rootVisible)
TreeBuilder	rowHeight(int rowHeight)
TreeBuilder	scrollsOnExpand(boolean scrollsOnExpand)
TreeBuilder	selectionMode(int selectionMode)
TreeBuilder	showsRootHandles(boolean showsRootHandles)
TreeBuilder	toggleClickCount(int toggleClickCount)
TreeBuilder	treeExpansionListener(TreeExpansionListener treeExpansionListener)
TreeBuilder	treeSelectionListener(TreeSelectionListener treeSelectionListener)
TreeBuilder	treeWillExpandListener(TreeWillExpandListener treeWillExpandListener)
TreeBuilder	ui(TreeUI ui)	Sets the UI before any other setting, since a look and feel may adjust what is set while its own UI is installed, such as removing the default icons of a DefaultTreeCellRenderer.
TreeBuilder	visibleRowCount(int visibleRowCount)

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

ancestorListener, background, border, build, build, clientProperty, componentListener, componentOrientation, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, get, hierarchyListener, keyEvent, keyListener, label, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupControl, popupControls, popupControls, popupMenu, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Method Details

ui

TreeBuilder ui(TreeUI ui)

Sets the UI before any other setting, since a look and feel may adjust what is set while its own UI is installed, such as removing the default icons of a DefaultTreeCellRenderer.

Parameters:

ui - the tree UI

Returns:

this builder instance

See Also:

• JTree.setUI(TreeUI)

rootVisible

TreeBuilder rootVisible(boolean rootVisible)

Parameters:

rootVisible - true if the root node should be visible

Returns:

this builder instance

See Also:

• JTree.setRootVisible(boolean)

showsRootHandles

TreeBuilder showsRootHandles(boolean showsRootHandles)

Parameters:

showsRootHandles - true if root handles should be shown

Returns:

this builder instance

See Also:

• JTree.setShowsRootHandles(boolean)

cellRenderer

TreeBuilder cellRenderer(TreeCellRenderer cellRenderer)

Parameters:

cellRenderer - the cell renderer

Returns:

this builder instance

See Also:

• JTree.setCellRenderer(TreeCellRenderer)

dragEnabled

TreeBuilder dragEnabled(boolean dragEnabled)

Parameters:

dragEnabled - true if drag should be enabled

Returns:

this builder instance

See Also:

• JTree.setDragEnabled(boolean)

dropMode

TreeBuilder dropMode(DropMode dropMode)

Parameters:

dropMode - the drop mode

Returns:

this builder instance

See Also:

• JTree.setDropMode(DropMode)

editable

TreeBuilder editable(boolean editable)

Parameters:

editable - true if the tree should be editable

Returns:

this builder instance

See Also:

• JTree.setEditable(boolean)

expandsSelectedPaths

TreeBuilder expandsSelectedPaths(boolean expandsSelectedPaths)

Parameters:

expandsSelectedPaths - true if selected paths should be expanded

Returns:

this builder instance

See Also:

• JTree.setExpandsSelectedPaths(boolean)

invokesStopCellEditing

TreeBuilder invokesStopCellEditing(boolean invokesStopCellEditing)

Parameters:

invokesStopCellEditing - true if stop cell editing should be invoked on selection change

Returns:

this builder instance

See Also:

• JTree.setInvokesStopCellEditing(boolean)

rowHeight

TreeBuilder rowHeight(int rowHeight)

Parameters:

rowHeight - the row height

Returns:

this builder instance

See Also:

• JTree.setRowHeight(int)

scrollsOnExpand

TreeBuilder scrollsOnExpand(boolean scrollsOnExpand)

Parameters:

scrollsOnExpand - true if the tree should scroll on expand

Returns:

this builder instance

See Also:

• JTree.setScrollsOnExpand(boolean)

toggleClickCount

TreeBuilder toggleClickCount(int toggleClickCount)

Parameters:

toggleClickCount - the number of clicks required to toggle a node

Returns:

this builder instance

See Also:

• JTree.setToggleClickCount(int)

visibleRowCount

TreeBuilder visibleRowCount(int visibleRowCount)

Parameters:

visibleRowCount - the number of visible rows

Returns:

this builder instance

See Also:

• JTree.setVisibleRowCount(int)

largeModel

TreeBuilder largeModel(boolean largeModel)

Parameters:

largeModel - the large model value

Returns:

this builder instance

See Also:

• JTree.setLargeModel(boolean)

selectionMode

TreeBuilder selectionMode(int selectionMode)

Parameters:

selectionMode - the selection mode

Returns:

this builder instance

See Also:

• TreeSelectionModel.setSelectionMode(int)

doubleClick

TreeBuilder doubleClick(Action doubleClick)

Performs the given action on a double-click with the left mouse button on a selected node, the first click selecting it, if the action is enabled. The ActionEvent source is the MouseEvent.

Parameters:

doubleClick - the action to perform on a double-click

Returns:

this builder instance

treeExpansionListener

TreeBuilder treeExpansionListener(TreeExpansionListener treeExpansionListener)

Parameters:

treeExpansionListener - the tree expansion listener to add

Returns:

this builder instance

See Also:

• JTree.addTreeExpansionListener(TreeExpansionListener)

treeWillExpandListener

TreeBuilder treeWillExpandListener(TreeWillExpandListener treeWillExpandListener)

Parameters:

treeWillExpandListener - the tree will expand listener to add

Returns:

this builder instance

See Also:

• JTree.addTreeWillExpandListener(TreeWillExpandListener)

treeSelectionListener

TreeBuilder treeSelectionListener(TreeSelectionListener treeSelectionListener)

Parameters:

treeSelectionListener - the tree selection listener to add

Returns:

this builder instance

See Also:

• JTree.addTreeSelectionListener(TreeSelectionListener)

builder

static TreeBuilder.ModelStep builder()

Returns:

a builder for a component