net.java.truevfs.access.swing

Class TFileTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

net.java.truevfs.access.swing.TFileTree

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public final class TFileTree
extends JTree

A custom JTree to browse files and directories. There are a couple of file creation/modification/removal methods added which notify the tree of any changes in the file system and update the current path expansions and selection.

Author:

Christian Schlichtherle

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JTree

JTree.AccessibleJTree, JTree.DropLocation, JTree.DynamicUtilTreeNode, JTree.EmptySelectionModel, JTree.TreeModelHandler, JTree.TreeSelectionRedirector

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JTree

ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModel, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, visibleRowCount

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TFileTree() Creates an empty TFileTree with no root.
TFileTree(TFile root) Creates a new TFileTree which traverses the given root root file.
TFileTree(TFileTreeModel model) Creates a new TFileTree which traverses the given TFileTreeModel.

Method Summary

Modifier and Type	Method and Description
void	cancelEditing()
String	convertValueToText(Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)
void	cp_p(TFile oldNode, TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the copied node is selected and visible.
void	cp_r(TFile oldNode, TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the recursively copied node is selected and visible.
void	cp_rp(TFile oldNode, TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the recursively copied node is selected and visible.
void	cp(InputStream in, TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the copied node is selected and visible.
void	cp(TFile oldNode, TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the copied node is selected and visible.
boolean	createNewFile(TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the newly created file is selected and visible.
String	getDefaultExtension() Getter for bound property defaultExtension.
TFileTreeModel	getModel()
boolean	isDisplayingExtensions() Getter for bound property displayingExtensions.
boolean	isEditing()
boolean	isEditingExtensions() Getter for bound property editingExtensions.
void	mkdir(TFile node, boolean recursive) Forwards the call to the TFileTreeModel and scrolls the tree so that the newly created directory is selected and visible.
void	mv(TFile oldNode, TFile node) Forwards the call to the TFileTreeModel, restores the expanded paths, selects node and scrolls to it if necessary.
protected void	onEditingStopped(ChangeEvent evt) Called when the editing of a cell has been stopped.
void	refresh() Refreshes the entire tree, restores the expanded and selected paths and scrolls to the lead selection path if necessary.
void	refresh(TFile node) Refreshes the subtree for the given node, restores the expanded and selected paths and scrolls to the lead selection path if necessary.
void	refresh(TreePath[] paths) Refreshes the subtree for the given paths, restores the expanded and selected paths and scrolls to the lead selection path if necessary.
void	rm_r(TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the successor to the deleted node is selected and visible.
void	rm(TFile node) Forwards the call to the TFileTreeModel and scrolls the tree so that the successor to the deleted node is selected and visible.
void	scrollNodeToVisible(TFile node)
void	setDefaultExtension(String defaultExtension) Setter for bound property defaultExtension.
void	setDisplayingExtensions(boolean displayingExtensions) Setter for bound property displayingExtensions.
void	setEditable(boolean editable)
void	setEditingExtensions(boolean editingExtensions) Setter for bound property editingExtensions.
void	setModel(TreeModel model)
void	setSelectionNode(TFile node)
void	setSelectionNodes(TFile[] nodes)
void	startEditingAtPath(TreePath path)
boolean	stopEditing()

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, clearSelection, clearToggledPaths, collapsePath, collapseRow, createTreeModel, createTreeModelListener, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, getShowsRootHandles, getToggleClickCount, getToolTipText, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, makeVisible, paramString, removeDescendantSelectedPaths, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setCellRenderer, setDragEnabled, setDropMode, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, treeDidChange, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TFileTree

public TFileTree()

Creates an empty TFileTree with no root. You shouldn't use this constructor. It's only provided to implement the JavaBean pattern.

TFileTree

public TFileTree(TFile root)

Creates a new TFileTree which traverses the given root root file.

TFileTree

public TFileTree(TFileTreeModel model)

Creates a new TFileTree which traverses the given TFileTreeModel.

Method Detail

cancelEditing

public void cancelEditing()

Overrides:

cancelEditing in class JTree

convertValueToText

public String convertValueToText(Object value,
                                 boolean selected,
                                 boolean expanded,
                                 boolean leaf,
                                 int row,
                                 boolean hasFocus)

Overrides:

convertValueToText in class JTree

cp_p

public void cp_p(TFile oldNode,
                 TFile node)
          throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the copied node is selected and visible.

Throws:

IOException - on any I/O error.

cp_r

public void cp_r(TFile oldNode,
                 TFile node)
          throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the recursively copied node is selected and visible.

Throws:

IOException - on any I/O error.

cp_rp

public void cp_rp(TFile oldNode,
                  TFile node)
           throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the recursively copied node is selected and visible.

Throws:

IOException - on any I/O error.

cp

public void cp(@WillClose
               InputStream in,
               TFile node)
        throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the copied node is selected and visible.

Throws:

IOException - on any I/O error.

cp

public void cp(TFile oldNode,
               TFile node)
        throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the copied node is selected and visible.

Throws:

IOException - on any I/O error.

createNewFile

public boolean createNewFile(TFile node)
                      throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the newly created file is selected and visible. If you would like to create a new file with initial content, please check cp(InputStream, TFile).

Throws:

IOException - on any I/O error.

getDefaultExtension

@Nullable
public String getDefaultExtension()

Getter for bound property defaultExtension.

Returns:

Value of property defaultExtension.

getModel

public TFileTreeModel getModel()

Overrides:

getModel in class JTree

isDisplayingExtensions

public boolean isDisplayingExtensions()

Getter for bound property displayingExtensions.

Returns:

Value of property displayingExtensions.

isEditing

public boolean isEditing()

Overrides:

isEditing in class JTree

isEditingExtensions

public boolean isEditingExtensions()

Getter for bound property editingExtensions.

Returns:

Value of property editingExtensions.

mkdir

public void mkdir(TFile node,
                  boolean recursive)
           throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the newly created directory is selected and visible.

Throws:

IOException - on any I/O error.

mv

public void mv(TFile oldNode,
               TFile node)
        throws IOException

Forwards the call to the TFileTreeModel, restores the expanded paths, selects node and scrolls to it if necessary.

Throws:

IOException - on any I/O error.

onEditingStopped

protected void onEditingStopped(ChangeEvent evt)

Called when the editing of a cell has been stopped. The implementation in this class will rename the edited file, obeying the rules for extension handling and updating the expanded and selected paths accordingly.

Parameters:

evt - The change event passed to CellEditorListener.editingStopped(ChangeEvent).

refresh

public void refresh()

Refreshes the entire tree, restores the expanded and selected paths and scrolls to the lead selection path if necessary.

refresh

public void refresh(TFile node)

Refreshes the subtree for the given node, restores the expanded and selected paths and scrolls to the lead selection path if necessary.

Parameters:

node - The file or directory to refresh. This may not be null.

refresh

public void refresh(TreePath[] paths)

Refreshes the subtree for the given paths, restores the expanded and selected paths and scrolls to the lead selection path if necessary.

Parameters:

paths - The array of TreePaths to refresh. This may be null.

rm_r

public void rm_r(TFile node)
          throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the successor to the deleted node is selected and visible.

Throws:

IOException - on any I/O error.

rm

public void rm(TFile node)
        throws IOException

Forwards the call to the TFileTreeModel and scrolls the tree so that the successor to the deleted node is selected and visible.

Throws:

IOException - on any I/O error.

scrollNodeToVisible

public void scrollNodeToVisible(TFile node)

setDefaultExtension

public void setDefaultExtension(@CheckForNull
                                String defaultExtension)

Setter for bound property defaultExtension. Sets the default extension to use when extensions are shown and allowed to be edited, but the user did not provide an extension when editing a file name. This property defaults to null and is ignored for directories.

Parameters:

defaultExtension - The new default extension. If not null, this parameter is fixed to always start with a '.'.

setDisplayingExtensions

public void setDisplayingExtensions(boolean displayingExtensions)

Setter for bound property displayingExtensions. If this is false, the extension of files will not be displayed in this tree. Defaults to true.

Parameters:

displayingExtensions - New value of property displayingExtensions.

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class JTree

setEditingExtensions

public void setEditingExtensions(boolean editingExtensions)

Setter for bound property editingExtensions. If this is false, the extension of a file will be truncated before editing its name starts. Defaults to true.

Parameters:

editingExtensions - New value of property editingExtensions.

setModel

public void setModel(TreeModel model)

Overrides:

setModel in class JTree

Throws:

ClassCastException - if model is not an instance of TFileTreeModel.

setSelectionNode

public void setSelectionNode(TFile node)

setSelectionNodes

public void setSelectionNodes(TFile[] nodes)

startEditingAtPath

public void startEditingAtPath(TreePath path)

Overrides:

startEditingAtPath in class JTree

stopEditing

public boolean stopEditing()

Overrides:

stopEditing in class JTree