org.wandora.utils.swing

Class DragJTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

org.wandora.utils.swing.DragJTree

All Implemented Interfaces:

java.awt.dnd.Autoscroll, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

Direct Known Subclasses:

CustomTopicPanelConfiguration.DraggableTree, LayerTree

public abstract class DragJTree
extends javax.swing.JTree
implements java.awt.dnd.Autoscroll

A JTree that allows moving nodes in the tree with drag and drop. You will need to implement allowDrop and doDrop. allowDrop checks if drop is allowed in the location where user holds the mouse. doDrop is called when the user finishes the drag and drop event. It must modify the model of the tree and notify the tree of changes in the model.

Author:

olli

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DragJTree.MyDropTargetListener
static class	DragJTree.TransferableTreePath

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

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

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private static int	AUTOSCROLL_MARGIN
private javax.swing.tree.TreePath	currentParent
private javax.swing.tree.TreePath	currentPosition
private java.awt.dnd.DragSource	dragSource
private java.awt.dnd.DragSourceContext	dragSourceContext
protected boolean	enableDrag
private java.awt.image.BufferedImage	ghostImage
protected boolean	localDragging
private java.awt.Point	offsetPoint
protected javax.swing.tree.TreePath	selectedTreePath

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
DragJTree() Creates a new instance of DragJTree
DragJTree(java.util.Hashtable<?,?> value)
DragJTree(java.lang.Object[] value)
DragJTree(javax.swing.tree.TreeModel model)
DragJTree(javax.swing.tree.TreeNode root)
DragJTree(javax.swing.tree.TreeNode root, boolean asksAllowsChildren)
DragJTree(java.util.Vector<?> value)

Method Summary

Modifier and Type	Method and Description
abstract int	allowDrop(javax.swing.tree.TreePath destinationParent, javax.swing.tree.TreePath destinationPosition, javax.swing.tree.TreePath source) Checks if drop is allowed in the destination.
void	autoscroll(java.awt.Point pt)
abstract void	doDrop(javax.swing.tree.TreePath destinationParent, javax.swing.tree.TreePath destinationPosition, javax.swing.tree.TreePath source, int action) Performs the drop event.
java.awt.Insets	getAutoscrollInsets()
protected java.awt.datatransfer.Transferable	getTransferable(javax.swing.tree.TreePath path)
protected void	initialize()
static boolean	isDescendant(javax.swing.tree.TreePath parent, javax.swing.tree.TreePath child)
boolean	isDragEnabled()
private boolean	isRootPath(javax.swing.tree.TreePath path)
static void	main(java.lang.String[] args)
void	nonLocalDragEnter(java.awt.dnd.DropTargetDragEvent dtde) Override this method if you wish to process drag and drop events originating from outside this component.
void	nonLocalDragExit(java.awt.dnd.DropTargetEvent dtde) Override this method if you wish to process drag and drop events originating from outside this component.
void	nonLocalDragOver(java.awt.dnd.DropTargetDragEvent dtde) Override this method if you wish to process drag and drop events originating from outside this component.
void	nonLocalDrop(java.awt.dnd.DropTargetDropEvent dtde) Override this method if you wish to process drag and drop events originating from outside this component.
void	nonLocalDropActionChanged(java.awt.dnd.DropTargetDragEvent dtde) Override this method if you wish to process drag and drop events originating from outside this component.
void	setDragEnabled(boolean val) Enable or disable dragging.

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, 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, getModel, 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, isEditing, 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, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setModel, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, 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

Field Detail

selectedTreePath

protected javax.swing.tree.TreePath selectedTreePath

offsetPoint

private java.awt.Point offsetPoint

ghostImage

private java.awt.image.BufferedImage ghostImage

dragSource

private java.awt.dnd.DragSource dragSource

dragSourceContext

private java.awt.dnd.DragSourceContext dragSourceContext

currentParent

private javax.swing.tree.TreePath currentParent

currentPosition

private javax.swing.tree.TreePath currentPosition

enableDrag

protected boolean enableDrag

localDragging

protected boolean localDragging

AUTOSCROLL_MARGIN

private static final int AUTOSCROLL_MARGIN

See Also:

Constant Field Values

Constructor Detail

DragJTree

public DragJTree()

Creates a new instance of DragJTree

DragJTree

public DragJTree(java.util.Hashtable<?,?> value)

DragJTree

public DragJTree(java.lang.Object[] value)

DragJTree

public DragJTree(javax.swing.tree.TreeModel model)

DragJTree

public DragJTree(javax.swing.tree.TreeNode root)

DragJTree

public DragJTree(javax.swing.tree.TreeNode root,
                 boolean asksAllowsChildren)

DragJTree

public DragJTree(java.util.Vector<?> value)

Method Detail

initialize

protected void initialize()

isDragEnabled

public boolean isDragEnabled()

setDragEnabled

public void setDragEnabled(boolean val)

Enable or disable dragging. If disabled DragJTree behaves like a regular JTree.

Overrides:

setDragEnabled in class javax.swing.JTree

autoscroll

public void autoscroll(java.awt.Point pt)

Specified by:

autoscroll in interface java.awt.dnd.Autoscroll

getAutoscrollInsets

public java.awt.Insets getAutoscrollInsets()

Specified by:

getAutoscrollInsets in interface java.awt.dnd.Autoscroll

getTransferable

protected java.awt.datatransfer.Transferable getTransferable(javax.swing.tree.TreePath path)

isRootPath

private boolean isRootPath(javax.swing.tree.TreePath path)

allowDrop

public abstract int allowDrop(javax.swing.tree.TreePath destinationParent,
                              javax.swing.tree.TreePath destinationPosition,
                              javax.swing.tree.TreePath source)

Checks if drop is allowed in the destination.

Parameters:

destinationParent - The parent of the destination where user is about to drop something.

destinationPosition - The position after which user is about to drop something. May be null in which case the item is to be dropped as the first child of destinationParent.

source - The item being dragged.

Returns:

One of action constants in java.awt.dnd.DnDConstants representing the possible drop actions.

doDrop

public abstract void doDrop(javax.swing.tree.TreePath destinationParent,
                            javax.swing.tree.TreePath destinationPosition,
                            javax.swing.tree.TreePath source,
                            int action)

Performs the drop event. Must modify the tree model to actually make the changes in the tree and also notify the model of these changes so that the UI can be updated.

Parameters:

destinationParent - The parent of the destination where user is about to drop something.

destinationPosition - The position after which user is about to drop something. May be null in which case the item is to be dropped as the first child of destinationParent.

source - The item being dragged.

action - The drop action. One of the action constants in java.awt.dnd.DnDConstants.

nonLocalDrop

public void nonLocalDrop(java.awt.dnd.DropTargetDropEvent dtde)

Override this method if you wish to process drag and drop events originating from outside this component. Default implementation calls dtde.rejectDrop().

nonLocalDragEnter

public void nonLocalDragEnter(java.awt.dnd.DropTargetDragEvent dtde)

Override this method if you wish to process drag and drop events originating from outside this component. Default implementation calls dtde.rejectDrag().

nonLocalDragOver

public void nonLocalDragOver(java.awt.dnd.DropTargetDragEvent dtde)

Override this method if you wish to process drag and drop events originating from outside this component. Default implementation calls dtde.rejectDrag().

nonLocalDragExit

public void nonLocalDragExit(java.awt.dnd.DropTargetEvent dtde)

Override this method if you wish to process drag and drop events originating from outside this component. Default implementation does nothing.

nonLocalDropActionChanged

public void nonLocalDropActionChanged(java.awt.dnd.DropTargetDragEvent dtde)

Override this method if you wish to process drag and drop events originating from outside this component. Default implementation calls dtde.rejectDrag().

isDescendant

public static boolean isDescendant(javax.swing.tree.TreePath parent,
                                   javax.swing.tree.TreePath child)

main

public static void main(java.lang.String[] args)