com.zfqjava.swing
Class JDirChooser

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.zfqjava.swing.JDirChooser

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class JDirChooser

extends javax.swing.JComponent

implements javax.accessibility.Accessible

JDirChooser provides a tree control to allow a user select a directory.
Examples:

	JDirChooser dirChooser = new JDirChooser();
	int value = dirChooser.showDialog(null);
	if(value == JDirChooser.OK_OPTION) {
	    File file = dirChooser.getSelectedFile();
	    System.out.println("Selected File: " + file);
	} 
 

Client Property:

Name	Value	Default Value
JDirChooser.recursiveModeEnabled	Boolean.TRUE Boolean.FALSE	Boolean.FALSE

See Also:

Serialized Form

Inner Class Summary

protected class

JDirChooser.AccessibleJDirChooser This class implements accessibility support for the JDirChooser class.

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Field Summary

protected javax.accessibility.AccessibleContext	accessibleContext
static int	CANCEL_OPTION Return value if cancel is chosen.
static int	DIRECTORIES_ONLY Instruction to display only directories.
static java.lang.String	FILE_FILTER_CHANGED_PROPERTY User changed the kind of files to display.
static java.lang.String	FILE_HIDING_CHANGED_PROPERTY Identifies a change in the display-hidden-files property.
static java.lang.String	FILE_SELECTION_MODE_CHANGED_PROPERTY Identifies a change in the kind of selection (single, multiple, etc.).
static java.lang.String	FILE_SYSTEM_VIEW_CHANGED_PROPERTY Says that a different object is being used to find available drives on the system.
static java.lang.String	FILE_VIEW_CHANGED_PROPERTY Says that a different object is being used to retrieve file information.
static int	FILES_AND_DIRECTORIES Instruction to display both files and directories.
static java.lang.String	MULTI_SELECTION_ENABLED_CHANGED_PROPERTY Enables multiple-file selections.
static int	OK_OPTION Return value if ok is chosen.
static java.lang.String	ROOT_FILE_CHANGED_PROPERTY Identifies change in the root directory property.
static java.lang.String	SELECTED_FILE_CHANGED_PROPERTY Identifies change in user's single-file selection.
static java.lang.String	SELECTED_FILES_CHANGED_PROPERTY Identifies change in user's multiple-file selection.

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

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

JDirChooser()
Constructs a JDirChooser pointing to the user's root directory, in win32 platform, that's desktop.

JDirChooser(java.io.File rootDirectory)
Constructs a JDirChooser using the given directory as the root directory.

JDirChooser(java.io.File rootDirectory, javax.swing.filechooser.FileSystemView fsv)
Constructs a JDirChooser using the given root directory and the given FileSystemView.

JDirChooser(javax.swing.filechooser.FileSystemView fsv)
Constructs a JDirChooser using the given FileSystemView.

JDirChooser(java.lang.String rootDirectoryPath)
Constructs a JDirChooser use the given directory as the root directory.

JDirChooser(java.lang.String rootFilePath, javax.swing.filechooser.FileSystemView fsv)
Constructs a JDirChooser using the given root directory path and the the given FileSystemView.

Method Summary

protected javax.swing.JDialog	createDialog(java.awt.Component parent, java.lang.String msg, javax.swing.Icon icon, java.lang.String title, JDirChooser dirChooser, java.awt.event.ActionListener okListener, java.awt.event.ActionListener cancelListener) Creates the dialog for the JDirChooser.
void	ensureFileIsVisible(java.io.File f) Ensure the file can visible in the JDirChooser, the JDirChooser can be represented as a JTree, then this can scroll it's container to make it's child visible.
javax.accessibility.AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this JDirChooser.
javax.swing.filechooser.FileFilter	getFileFilter() Returns the currently selected file filter.
int	getFileSelectionMode() Returns the current file-selection mode.
javax.swing.filechooser.FileSystemView	getFileSystemView() Returns the file system view.
javax.swing.filechooser.FileView	getFileView() Returns the current file view.
java.io.File	getRootFile() Returns the root directory in use, the default is desktop in windows.
java.io.File	getSelectedFile() Returns the current selected file, may be null.
java.io.File[]	getSelectedFiles() Returns the current selected files if the dir chooser is set to allow multiple selection.
DirChooserUI	getUI() Gets the UI object which implements the L&F for this component.
java.lang.String	getUIClassID() Returns a string that specifies the name of the L&F class that renders this component.
boolean	isFileHidingEnabled() Returns true if hidden files are not shown in the dir chooser, otherwise, returns false.
boolean	isMultiSelectionEnabled() Returns true if multiple files can be selected.
boolean	isSelectable(java.io.File f) Returns true if a file is selectable, that's mean the specify file exist in the file system.
void	newFolder() Makes a new folder on current path.
protected java.lang.String	paramString() Returns a string representation of this JDirChooser.
void	refresh() Refreshs the current JDirChooser, this will reload the file object from file system.
void	refresh(java.io.File dir) Refresh the specify directory, this will reload the file object from file system.
void	setFileFilter(javax.swing.filechooser.FileFilter fileFilter) Sets the current file filter.
void	setFileHidingEnabled(boolean b) Sets file hiding on or off.
void	setFileSelectionMode(int mode) Sets the JDirChooser to allow the user to just select directories, or select both files and directories.
void	setFileSystemView(javax.swing.filechooser.FileSystemView fsv) Sets the file system view that the JDirChooser uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.
void	setFileView(javax.swing.filechooser.FileView fileView) Sets the file view to used to retrieve UI information, such as the icon that represents a file or the type description of a file.
void	setMultiSelectionEnabled(boolean b) Sets the file chooser to allow multiple file selections.
void	setRootFile(java.io.File rootFile) Sets the JDirChooser root directory, the default is desktop in windows.
void	setSelectedFile(java.io.File selectedFile) Sets the current selected file.
void	setSelectedFiles(java.io.File[] selectedFiles) Sets the current selected files if the dir chooser is set to allow multiple selection.
int	showDialog(java.awt.Component parent) Pops up a dialog contains the JDirChooser and parented to parent with the dialog having a default title.
int	showDialog(java.awt.Component parent, java.lang.String msg, javax.swing.Icon icon) Pops up a dialog contains the JDirChooser and parented to parent with the dialog having a default title and message msg and icon icon.
int	showDialog(java.awt.Component parent, java.lang.String msg, javax.swing.Icon icon, java.lang.String title) Pops up a dialog contains the JDirChooser, and parented to parent with the dialog having the title title and message msg and icon icon.
void	updateUI() Notification from the UIFactory that the L&F has changed.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

OK_OPTION

public static final int OK_OPTION

Return value if ok is chosen.

CANCEL_OPTION

public static final int CANCEL_OPTION

Return value if cancel is chosen.

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY

Instruction to display only directories.

FILES_AND_DIRECTORIES

public static final int FILES_AND_DIRECTORIES

Instruction to display both files and directories.

SELECTED_FILE_CHANGED_PROPERTY

public static final java.lang.String SELECTED_FILE_CHANGED_PROPERTY

Identifies change in user's single-file selection.

SELECTED_FILES_CHANGED_PROPERTY

public static final java.lang.String SELECTED_FILES_CHANGED_PROPERTY

Identifies change in user's multiple-file selection.

FILE_SELECTION_MODE_CHANGED_PROPERTY

public static final java.lang.String FILE_SELECTION_MODE_CHANGED_PROPERTY

Identifies a change in the kind of selection (single, multiple, etc.).

ROOT_FILE_CHANGED_PROPERTY

public static final java.lang.String ROOT_FILE_CHANGED_PROPERTY

Identifies change in the root directory property.

MULTI_SELECTION_ENABLED_CHANGED_PROPERTY

public static final java.lang.String MULTI_SELECTION_ENABLED_CHANGED_PROPERTY

Enables multiple-file selections.

FILE_SYSTEM_VIEW_CHANGED_PROPERTY

public static final java.lang.String FILE_SYSTEM_VIEW_CHANGED_PROPERTY

Says that a different object is being used to find available drives on the system.

FILE_VIEW_CHANGED_PROPERTY

public static final java.lang.String FILE_VIEW_CHANGED_PROPERTY

Says that a different object is being used to retrieve file information.

FILE_HIDING_CHANGED_PROPERTY

public static final java.lang.String FILE_HIDING_CHANGED_PROPERTY

Identifies a change in the display-hidden-files property.

FILE_FILTER_CHANGED_PROPERTY

public static final java.lang.String FILE_FILTER_CHANGED_PROPERTY

User changed the kind of files to display.

accessibleContext

protected javax.accessibility.AccessibleContext accessibleContext

Constructor Detail

JDirChooser

public JDirChooser()

Constructs a JDirChooser pointing to the user's root directory, in win32 platform, that's desktop.

JDirChooser

public JDirChooser(java.lang.String rootDirectoryPath)

Constructs a JDirChooser use the given directory as the root directory.

Parameters:

rootDirectoryPath - a String giving the path to directory

JDirChooser

public JDirChooser(java.io.File rootDirectory)

Constructs a JDirChooser using the given directory as the root directory.

Parameters:

rootDirectory - a File giving the path to directory

JDirChooser

public JDirChooser(javax.swing.filechooser.FileSystemView fsv)

Constructs a JDirChooser using the given FileSystemView.

Parameters:

fsv - the FileSystemView object

JDirChooser

public JDirChooser(java.lang.String rootFilePath,
                   javax.swing.filechooser.FileSystemView fsv)

Constructs a JDirChooser using the given root directory path and the the given FileSystemView.

Parameters:

rootDirectoryPath - a String giving the path to directory

fsv - the FileSystemView object

JDirChooser

public JDirChooser(java.io.File rootDirectory,
                   javax.swing.filechooser.FileSystemView fsv)

Constructs a JDirChooser using the given root directory and the given FileSystemView.

Parameters:

rootDirectory - the root file of this JDirChooser

fsv - the FileSystemView object

Method Detail

updateUI

public void updateUI()

Notification from the UIFactory that the L&F has changed.

Overrides:

updateUI in class javax.swing.JComponent

See Also:

JComponent.updateUI()

getUIClassID

public java.lang.String getUIClassID()

Returns a string that specifies the name of the L&F class that renders this component.

Overrides:

getUIClassID in class javax.swing.JComponent

Returns:

the string "DirChooserUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getUI

public DirChooserUI getUI()

Gets the UI object which implements the L&F for this component.

Returns:

the DirChooserUI object that implements the DirChooserUI L&F

getSelectedFile

public java.io.File getSelectedFile()

Returns the current selected file, may be null. Use getSelectedFiles() if isMultiSelectionEnabled() return true.

Returns:

the current selected file

See Also:

setSelectedFile(java.io.File)

setSelectedFile

public void setSelectedFile(java.io.File selectedFile)

Sets the current selected file. Use setSelectedFiles(java.io.File[]) if isMultiSelectionEnabled() return true.

Parameters:

selectedFile - the current selected file

See Also:

getSelectedFile()

getSelectedFiles

public java.io.File[] getSelectedFiles()

Returns the current selected files if the dir chooser is set to allow multiple selection. Use getSelectedFile() if isMultiSelectionEnabled() return false.

Returns:

the current selected files

See Also:

setSelectedFiles(java.io.File[])

setSelectedFiles

public void setSelectedFiles(java.io.File[] selectedFiles)

Sets the current selected files if the dir chooser is set to allow multiple selection. Use setSelectedFile(java.io.File) if isMultiSelectionEnabled() return false.

Parameters:

selectedFiles - the current selected files

See Also:

getSelectedFiles()

setRootFile

public void setRootFile(java.io.File rootFile)

Sets the JDirChooser root directory, the default is desktop in windows.

Parameters:

rootFile - the root directory

See Also:

getRootFile()

getRootFile

public java.io.File getRootFile()

Returns the root directory in use, the default is desktop in windows.

Returns:

the root directory

See Also:

setRootFile(java.io.File)

setFileSystemView

public void setFileSystemView(javax.swing.filechooser.FileSystemView fsv)

Sets the file system view that the JDirChooser uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.

Parameters:

fsv - the new FileSystemView

See Also:

FileSystemView

getFileSystemView

public javax.swing.filechooser.FileSystemView getFileSystemView()

Returns the file system view.

Returns:

the FileSystemView object

See Also:

setFileSystemView(javax.swing.filechooser.FileSystemView)

setFileView

public void setFileView(javax.swing.filechooser.FileView fileView)

Sets the file view to used to retrieve UI information, such as the icon that represents a file or the type description of a file.

See Also:

getFileView()

getFileView

public javax.swing.filechooser.FileView getFileView()

Returns the current file view.

See Also:

setFileView(javax.swing.filechooser.FileView)

setFileSelectionMode

public void setFileSelectionMode(int mode)

Sets the JDirChooser to allow the user to just select directories, or select both files and directories. The default is JDirChooser.DIRECTORIES_ONLY.

Parameters:

mode - the type of files to be displayed:

• JDirChooser.DIRECTORIES_ONLY
• JDirChooser.FILES_AND_DIRECTORIES

Throws:

java.lang.IllegalArgumentException - if mode is an illegal mode

See Also:

getFileSelectionMode()

getFileSelectionMode

public int getFileSelectionMode()

Returns the current file-selection mode. The default is JDirChooser.DIRECTORIES_ONLY.

Returns:

the type of files to be displayed, one of the following:

• JDirChooser.DIRECTORIES_ONLY
• JDirChooser.FILES_AND_DIRECTORIES

See Also:

setFileSelectionMode(int)

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean b)

Sets the file chooser to allow multiple file selections. The default is false.

Parameters:

b - true if multiple files may be selected

See Also:

isMultiSelectionEnabled()

isMultiSelectionEnabled

public boolean isMultiSelectionEnabled()

Returns true if multiple files can be selected. The default is false.

Returns:

true if multiple files can be selected

See Also:

setMultiSelectionEnabled(boolean)

isFileHidingEnabled

public boolean isFileHidingEnabled()

Returns true if hidden files are not shown in the dir chooser, otherwise, returns false. The default is true.

Returns:

the status of the file hiding property

See Also:

setFileHidingEnabled(boolean)

setFileHidingEnabled

public void setFileHidingEnabled(boolean b)

Sets file hiding on or off. If true, hidden files are not shown in the file chooser. The job of determining which files are shown is done by the FileView. The default is true.

Parameters:

b - the boolean value that determines whether file hiding is turned on

See Also:

isFileHidingEnabled()

setFileFilter

public void setFileFilter(javax.swing.filechooser.FileFilter fileFilter)

Sets the current file filter. The file filter is used by the file chooser to filter out files from the user's view.

Parameters:

filter - the new current file filter to use

See Also:

getFileFilter()

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Returns the currently selected file filter.

Returns:

the current file filter

See Also:

setFileFilter(javax.swing.filechooser.FileFilter)

ensureFileIsVisible

public void ensureFileIsVisible(java.io.File f)

Ensure the file can visible in the JDirChooser, the JDirChooser can be represented as a JTree, then this can scroll it's container to make it's child visible.

Parameters:

f - the file that need visible

isSelectable

public boolean isSelectable(java.io.File f)

Returns true if a file is selectable, that's mean the specify file exist in the file system.

Parameters:

f - the file that need check

Returns:

true if the specify file exist in file system, false otherwise

refresh

public void refresh()

Refreshs the current JDirChooser, this will reload the file object from file system.

refresh

public void refresh(java.io.File dir)

Refresh the specify directory, this will reload the file object from file system.

Parameters:

dir - the specify directory to refresh

newFolder

public void newFolder()

Makes a new folder on current path.

showDialog

public int showDialog(java.awt.Component parent)

Pops up a dialog contains the JDirChooser and parented to parent with the dialog having a default title.

Parameters:

parent - the parent of the dialog

Returns:

the return state of the dir chooser on popdown:

• JDirChooser.OK_OPTION
• JDirChooser.CANCEL_OPTION

See Also:

showDialog(java.awt.Component)

showDialog

public int showDialog(java.awt.Component parent,
                      java.lang.String msg,
                      javax.swing.Icon icon)

Pops up a dialog contains the JDirChooser and parented to parent with the dialog having a default title and message msg and icon icon.

Parameters:

parent - the parent of the dialog

msg - the message show in the dialog

icon - the icon show in the dialog

Returns:

the return state of the dir chooser on popdown:

• JDirChooser.OK_OPTION
• JDirChooser.CANCEL_OPTION

See Also:

showDialog(java.awt.Component)

showDialog

public int showDialog(java.awt.Component parent,
                      java.lang.String msg,
                      javax.swing.Icon icon,
                      java.lang.String title)

Pops up a dialog contains the JDirChooser, and parented to parent with the dialog having the title title and message msg and icon icon.

Parameters:

parent - the parent of the dialog

msg - the message show in the dialog

icon - the icon show in the dialog

title - the title of the dialog

Returns:

the return state of the dir chooser on popdown:

• JDirChooser.OK_OPTION
• JDirChooser.CANCEL_OPTION

See Also:

showDialog(java.awt.Component)

createDialog

protected javax.swing.JDialog createDialog(java.awt.Component parent,
                                           java.lang.String msg,
                                           javax.swing.Icon icon,
                                           java.lang.String title,
                                           JDirChooser dirChooser,
                                           java.awt.event.ActionListener okListener,
                                           java.awt.event.ActionListener cancelListener)

Creates the dialog for the JDirChooser.

Parameters:

parent - the parent of the dialog

msg - the message show in the dialog

icon - the icon show in the dialog

title - the title of the dialog

paramString

protected java.lang.String paramString()

Returns a string representation of this JDirChooser. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class javax.swing.JComponent

Returns:

a string representation of this JDirChooser

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JDirChooser. For color choosers, the AccessibleContext takes the form of an AccessibleJDirChooser. A new AccessibleJDirChooser instance is created if necessary.

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class javax.swing.JComponent

Returns:

an AccessibleJDirChooser that serves as the AccessibleContext of this JDirChooser