org.xnap.commons.gui
Class DirectoryChooser

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.xnap.commons.gui.DefaultDialog
                          org.xnap.commons.gui.DirectoryChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TreeSelectionListener, RootPaneContainer, WindowConstants

public class DirectoryChooser
extends DefaultDialog
implements TreeSelectionListener

Provides a dialog with a JTree that contains the local directory structure for directory selection and a button for quick selection of the user's home directory.

The usage of this class is similar to JFileChooser. TODO add auto completed input field for entering directory

See Also:

Serialized Form

Nested Class Summary

class

DirectoryChooser.HomeAction

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static int	APPROVE_OPTION
static int	CANCEL_OPTION

Fields inherited from class org.xnap.commons.gui.DefaultDialog

BUTTON_APPLY, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTEXT_HELP, BUTTON_DEFAULTS, BUTTON_HELP, BUTTON_NONE, BUTTON_OKAY, isOkay

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

DirectoryChooser()
Creates a directory chooser.

DirectoryChooser(JDialog owner)
Creates a directory chooser.

DirectoryChooser(JFrame owner)
Creates a directory chooser.

Method Summary

boolean	apply() Called by ApplyAction and OkayAction when the dialog is closed.
void	cancelled()
File	getSelectedDirectory() Returns the currently selected directory.
void	setSelectedDirectory(File dir) Selects the specified directory in the tree.
int	showChooseDialog(Component c)
void	valueChanged(TreeSelectionEvent e)

Methods inherited from class org.xnap.commons.gui.DefaultDialog

close, contextHelp, defaults, getApplyAction, getButtonPanel, getCancelAction, getCloseAction, getContextHelpAction, getDefaultsAction, getHelpAction, getMainPanel, getOkayAction, getTopPanel, help, isOkay, setApplyOnEnter, setButtonSeparatorVisible, setMainComponent, show

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

APPROVE_OPTION

public static final int APPROVE_OPTION

See Also:

Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION

See Also:

Constant Field Values

Constructor Detail

DirectoryChooser

public DirectoryChooser(JFrame owner)

Creates a directory chooser.

Parameters:

owner - the dialog's parent

DirectoryChooser

public DirectoryChooser(JDialog owner)

Creates a directory chooser.

Parameters:

owner - the dialog's parent

DirectoryChooser

public DirectoryChooser()

Creates a directory chooser.

Method Detail

apply

public boolean apply()

Description copied from class: DefaultDialog

Called by ApplyAction and OkayAction when the dialog is closed.

Overrides:

apply in class DefaultDialog

Returns:

true, if apply was successful and close() should be invoked; false, otherwise

cancelled

public void cancelled()

Overrides:

cancelled in class DefaultDialog

getSelectedDirectory

public File getSelectedDirectory()

Returns the currently selected directory.

Returns:

the selected directory; null, if no directory is selected

setSelectedDirectory

public void setSelectedDirectory(File dir)

Selects the specified directory in the tree. The tree is expanded as necessary and scrolled to ensure visibility of the directory.

Parameters:

dir - the directory to be selected

showChooseDialog

public int showChooseDialog(Component c)

valueChanged

public void valueChanged(TreeSelectionEvent e)

Specified by:

valueChanged in interface TreeSelectionListener