javax.swing

Class JFileChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JFileChooser

All Implemented Interfaces:

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

public class JFileChooser
extends JComponent
implements javax.accessibility.Accessible

A component that provides the user a dialog box to browse through a filesystem and choose one or more files or directories. A JFileChooser can be configured to filter the displayed file list by adding a FileFilter instance using addChoosableFileFilter(FileFilter). Additional components can be embedded in the file chooser using setAccessory(JComponent). The JFileChooser properties also provide mechanisms to customize the behaviour of the file chooser.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JFileChooser.AccessibleJFileChooser Provides the accessibility features for the JFileChooser component.

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

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY The name of the 'accept all file filter used' property.
protected javax.accessibility.AccessibleContext	accessibleContext The accessible context.
static java.lang.String	ACCESSORY_CHANGED_PROPERTY The name of the 'accessory' property.
static java.lang.String	APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY The name of the property for the approve button mnemonic.
static java.lang.String	APPROVE_BUTTON_TEXT_CHANGED_PROPERTY The name of the property for the approve button text.
static java.lang.String	APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY The name of the property for the approve button tool tip text.
static int	APPROVE_OPTION A return value indicating the file chooser has been closed by approving the selection.
static java.lang.String	APPROVE_SELECTION Action command string for approving the current selection.
static int	CANCEL_OPTION A return value indicating the file chooser has been closed by cancelling.
static java.lang.String	CANCEL_SELECTION Action command string for cancelling the current selection.
static java.lang.String	CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY The name of the 'choosable file filters' property.
static java.lang.String	CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY The name of the property for control button visibility.
static int	CUSTOM_DIALOG A dialog type for some custom purpose.
static java.lang.String	DIALOG_TITLE_CHANGED_PROPERTY The name of the 'dialog title' property.
static java.lang.String	DIALOG_TYPE_CHANGED_PROPERTY The name of the 'dialog type' property.
static int	DIRECTORIES_ONLY A selection mode constant indicating acceptance of directories only.
static java.lang.String	DIRECTORY_CHANGED_PROPERTY The name of the property for the current directory.
static int	ERROR_OPTION A return value indicating the file chooser has been closed by some error.
static java.lang.String	FILE_FILTER_CHANGED_PROPERTY The name of the 'file filter' property.
static java.lang.String	FILE_HIDING_CHANGED_PROPERTY The name of the 'file hiding enabled' property.
static java.lang.String	FILE_SELECTION_MODE_CHANGED_PROPERTY The name of the 'file selection mode' property.
static java.lang.String	FILE_SYSTEM_VIEW_CHANGED_PROPERTY The name of the 'file system view' property.
static java.lang.String	FILE_VIEW_CHANGED_PROPERTY The name of the 'file view' property.
static int	FILES_AND_DIRECTORIES A selection mode constant indicating acceptance of files and directories.
static int	FILES_ONLY A selection mode constant indicating acceptance of files only.
static java.lang.String	MULTI_SELECTION_ENABLED_CHANGED_PROPERTY The name of the property for multi-selection.
static int	OPEN_DIALOG A dialog type for selecting a file to open.
static int	SAVE_DIALOG A dialog type for selecting a file to save.
static java.lang.String	SELECTED_FILE_CHANGED_PROPERTY The name of the property for the selected file.
static java.lang.String	SELECTED_FILES_CHANGED_PROPERTY The name of the property for the selected files.

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

Constructors

Constructor and Description
JFileChooser() Creates a new JFileChooser object.
JFileChooser(java.io.File currentDirectory) Creates a new JFileChooser object.
JFileChooser(java.io.File currentDirectory, javax.swing.filechooser.FileSystemView fsv) Creates a new JFileChooser object.
JFileChooser(javax.swing.filechooser.FileSystemView fsv) Creates a new JFileChooser object.
JFileChooser(java.lang.String currentDirectoryPath) Creates a new JFileChooser object.
JFileChooser(java.lang.String currentDirectoryPath, javax.swing.filechooser.FileSystemView fsv) Creates a new JFileChooser object with the specified directory and FileSystemView.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File f) Returns true if the file is accepted by the current file filter.
void	addActionListener(java.awt.event.ActionListener l) Adds an ActionListener to the file chooser.
void	addChoosableFileFilter(javax.swing.filechooser.FileFilter filter) Adds a file filter to the list of available filters and sends a PropertyChangeEvent (with the property name CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY) to all registered listeners.
void	approveSelection() Approves the selection.
void	cancelSelection() Cancels the selection.
void	changeToParentDirectory() Called by the UI delegate when the parent directory is changed.
protected JDialog	createDialog(java.awt.Component parent) Creates a modal dialog in which to display the file chooser.
void	ensureFileIsVisible(java.io.File f) Ensures the the specified file is visible (this is handled by the UI delegate).
protected void	fireActionPerformed(java.lang.String command) Sends an @link {ActionEvent} to all registered listeners.
javax.swing.filechooser.FileFilter	getAcceptAllFileFilter() Returns the 'accept all' file filter from the UI delegate.
javax.accessibility.AccessibleContext	getAccessibleContext() Returns the object that provides accessibility features for this JFileChooser component.
JComponent	getAccessory() Returns the accessory component for the file chooser.
java.awt.event.ActionListener[]	getActionListeners() Returns the action listeners registered with this file chooser.
int	getApproveButtonMnemonic() Returns the approve button mnemonic, or zero if no mnemonic has been set.
java.lang.String	getApproveButtonText() Returns the approve button text.
java.lang.String	getApproveButtonToolTipText() Returns the tool tip text for the approve button.
javax.swing.filechooser.FileFilter[]	getChoosableFileFilters() Returns the available file filters for this file chooser.
boolean	getControlButtonsAreShown() Returns the flag that controls whether or not the control buttons are shown on the file chooser.
java.io.File	getCurrentDirectory() Returns the current directory.
java.lang.String	getDescription(java.io.File f) Returns the description of the file, generated by the current (or default) FileView.
java.lang.String	getDialogTitle() Returns the dialog title.
int	getDialogType() Returns the type of file chooser.
boolean	getDragEnabled() Returns true if dragging is enabled.
javax.swing.filechooser.FileFilter	getFileFilter() Returns the file filter.
int	getFileSelectionMode() Returns the file selection mode, one of: FILES_ONLY, DIRECTORIES_ONLY or FILES_AND_DIRECTORIES.
javax.swing.filechooser.FileSystemView	getFileSystemView() Returns the file system view being used by this file chooser.
javax.swing.filechooser.FileView	getFileView() Returns the custom FileView for the file chooser.
Icon	getIcon(java.io.File f) Returns the icon provided by the current (or default) FileView.
java.lang.String	getName(java.io.File f) Returns the name of the file, generated by the current (or default) FileView.
java.io.File	getSelectedFile() Returns the selected file, if there is one.
java.io.File[]	getSelectedFiles() Returns the selected file or files in an array.
java.lang.String	getTypeDescription(java.io.File f) Returns the type description for the file, generated by the current (or default) FileView.
javax.swing.plaf.FileChooserUI	getUI() Returns the UI delegate for the component.
java.lang.String	getUIClassID() Returns the UI delegate class identifier.
boolean	isAcceptAllFileFilterUsed() Returns the flag that controls whether or not the 'accept all' file filter is included in the list of filters.
boolean	isDirectorySelectionEnabled() Returns true if directory selection is enabled, and false otherwise.
boolean	isFileHidingEnabled() Returns true if hidden files are to be hidden, and false otherwise.
boolean	isFileSelectionEnabled() Returns true if file selection is enabled, and false otherwise.
boolean	isMultiSelectionEnabled() Returns true if multiple selections are allowed within this file chooser, and false otherwise.
boolean	isTraversable(java.io.File f) Returns true if the file is traversable, and false otherwise.
protected java.lang.String	paramString() Returns a string describing the attributes for the JFileChooser component, for use in debugging.
void	removeActionListener(java.awt.event.ActionListener l) Removes an ActionListener from this file chooser.
boolean	removeChoosableFileFilter(javax.swing.filechooser.FileFilter f) Removes a file filter from the list of available filters and sends a PropertyChangeEvent (with the property name CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY) to all registered listeners.
void	rescanCurrentDirectory() Rescans the current directory (this is handled by the UI delegate).
void	resetChoosableFileFilters() Clears the list of choosable file filters and installs the 'accept all' filter from the UI delegate.
void	setAcceptAllFileFilterUsed(boolean b) Sets the flag that controls whether or not the 'accept all' file filter is included in the list of filters, and sends a PropertyChangeEvent (with the property name ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY) to all registered listeners.
void	setAccessory(JComponent newAccessory) Sets the accessory component for the file chooser and sends a PropertyChangeEvent to all registered listeners.
void	setApproveButtonMnemonic(char mnemonic) Sets the mnemonic for the approve button and sends a PropertyChangeEvent (with the property name APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY) to all registered listeners.
void	setApproveButtonMnemonic(int mnemonic) Sets the mnemonic for the approve button and sends a PropertyChangeEvent (with the property name APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY) to all registered listeners.
void	setApproveButtonText(java.lang.String approveButtonText) Sets the approve button text and fires a PropertyChangeEvent (with the property name APPROVE_BUTTON_TEXT_CHANGED_PROPERTY) to all registered listeners.
void	setApproveButtonToolTipText(java.lang.String toolTipText) Sets the tool tip text for the approve button and sends a PropertyChangeEvent (with the property name APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY) to all registered listeners.
void	setControlButtonsAreShown(boolean b) Sets the flag that controls whether or not the control buttons are shown and, if it changes, sends a PropertyChangeEvent (with the property name CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY) to all registered listeners.
void	setCurrentDirectory(java.io.File dir) Sets the current directory and fires a PropertyChangeEvent (with the property name DIRECTORY_CHANGED_PROPERTY) to all registered listeners.
void	setDialogTitle(java.lang.String dialogTitle) Sets the dialog title and sends a PropertyChangeEvent (with the property name DIALOG_TITLE_CHANGED_PROPERTY) to all registered listeners.
void	setDialogType(int dialogType) Sets the dialog type and fires a PropertyChangeEvent (with the property name DIALOG_TYPE_CHANGED_PROPERTY) to all registered listeners.
void	setDragEnabled(boolean b) Sets the dragEnabled property, this disables/enables automatic drag handling (drag and drop) on this component.
void	setFileFilter(javax.swing.filechooser.FileFilter filter) Sets the file filter and sends a PropertyChangeEvent (with the property name FILE_FILTER_CHANGED_PROPERTY) to all registered listeners.
void	setFileHidingEnabled(boolean b) Sets the flag that controls whether or not hidden files are displayed, and sends a PropertyChangeEvent (with the property name FILE_HIDING_CHANGED_PROPERTY) to all registered listeners.
void	setFileSelectionMode(int mode) Sets the file selection mode and sends a PropertyChangeEvent to all registered listeners.
void	setFileSystemView(javax.swing.filechooser.FileSystemView fsv) Sets the file system view for the file chooser and sends a PropertyChangeEvent to all registered listeners.
void	setFileView(javax.swing.filechooser.FileView fileView) Sets a custom FileView for the file chooser and sends a PropertyChangeEvent to all registered listeners.
void	setMultiSelectionEnabled(boolean b) Sets the flag that controls whether multiple selections are allowed in this filechooser and sends a PropertyChangeEvent (with the property name MULTI_SELECTION_ENABLED_CHANGED_PROPERTY) to all registered listeners.
void	setSelectedFile(java.io.File file) Sets the selected file and sends a PropertyChangeEvent to all registered listeners.
void	setSelectedFiles(java.io.File[] selectedFiles) Sets the selected files and sends a PropertyChangeEvent (with the name SELECTED_FILES_CHANGED_PROPERTY) to all registered listeners.
protected void	setup(javax.swing.filechooser.FileSystemView view) Sets up the file chooser.
int	showDialog(java.awt.Component parent, java.lang.String approveButtonText) Displays the file chooser in a modal dialog using the CUSTOM_DIALOG type.
int	showOpenDialog(java.awt.Component parent) Displays the file chooser in a modal dialog using the OPEN_DIALOG type.
int	showSaveDialog(java.awt.Component parent) Displays the file chooser in a modal dialog using the SAVE_DIALOG type.
void	updateUI() Installs the UI delegate for the current look and feel.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, 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, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, 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, setFocusTraversalKeys, 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, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, 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, hide, 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, processMouseEvent, 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, setMaximumSize, setMinimumSize, setName, setPreferredSize, 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

OPEN_DIALOG

public static final int OPEN_DIALOG

A dialog type for selecting a file to open.

See Also:

setDialogType(int), Constant Field Values

SAVE_DIALOG

public static final int SAVE_DIALOG

A dialog type for selecting a file to save.

See Also:

setDialogType(int), Constant Field Values

CUSTOM_DIALOG

public static final int CUSTOM_DIALOG

A dialog type for some custom purpose.

See Also:

setDialogType(int), Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION

A return value indicating the file chooser has been closed by cancelling.

See Also:

showOpenDialog(Component), showSaveDialog(Component), Constant Field Values

APPROVE_OPTION

public static final int APPROVE_OPTION

A return value indicating the file chooser has been closed by approving the selection.

See Also:

showOpenDialog(Component), showSaveDialog(Component), Constant Field Values

ERROR_OPTION

public static final int ERROR_OPTION

A return value indicating the file chooser has been closed by some error.

See Also:

showOpenDialog(Component), showSaveDialog(Component), Constant Field Values

FILES_ONLY

public static final int FILES_ONLY

A selection mode constant indicating acceptance of files only.

See Also:

setFileSelectionMode(int), Constant Field Values

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY

A selection mode constant indicating acceptance of directories only.

See Also:

setFileSelectionMode(int), Constant Field Values

FILES_AND_DIRECTORIES

public static final int FILES_AND_DIRECTORIES

A selection mode constant indicating acceptance of files and directories.

See Also:

setFileSelectionMode(int), Constant Field Values

CANCEL_SELECTION

public static final java.lang.String CANCEL_SELECTION

Action command string for cancelling the current selection.

See Also:

cancelSelection(), Constant Field Values

APPROVE_SELECTION

public static final java.lang.String APPROVE_SELECTION

Action command string for approving the current selection.

See Also:

cancelSelection(), Constant Field Values

APPROVE_BUTTON_TEXT_CHANGED_PROPERTY

public static final java.lang.String APPROVE_BUTTON_TEXT_CHANGED_PROPERTY

The name of the property for the approve button text.

See Also:

setApproveButtonText(String), Constant Field Values

APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY

public static final java.lang.String APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY

The name of the property for the approve button tool tip text.

See Also:

setApproveButtonToolTipText(String), Constant Field Values

APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY

public static final java.lang.String APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY

The name of the property for the approve button mnemonic.

See Also:

setApproveButtonMnemonic(int), Constant Field Values

CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY

public static final java.lang.String CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY

The name of the property for control button visibility.

See Also:

setControlButtonsAreShown(boolean), Constant Field Values

DIRECTORY_CHANGED_PROPERTY

public static final java.lang.String DIRECTORY_CHANGED_PROPERTY

The name of the property for the current directory.

See Also:

setCurrentDirectory(File), Constant Field Values

SELECTED_FILE_CHANGED_PROPERTY

public static final java.lang.String SELECTED_FILE_CHANGED_PROPERTY

The name of the property for the selected file.

See Also:

setSelectedFile(File), Constant Field Values

SELECTED_FILES_CHANGED_PROPERTY

public static final java.lang.String SELECTED_FILES_CHANGED_PROPERTY

The name of the property for the selected files.

See Also:

setSelectedFiles(File[]), Constant Field Values

MULTI_SELECTION_ENABLED_CHANGED_PROPERTY

public static final java.lang.String MULTI_SELECTION_ENABLED_CHANGED_PROPERTY

The name of the property for multi-selection.

See Also:

setMultiSelectionEnabled(boolean), Constant Field Values

FILE_SYSTEM_VIEW_CHANGED_PROPERTY

public static final java.lang.String FILE_SYSTEM_VIEW_CHANGED_PROPERTY

The name of the 'file system view' property.

See Also:

setFileSystemView(FileSystemView), Constant Field Values

FILE_VIEW_CHANGED_PROPERTY

public static final java.lang.String FILE_VIEW_CHANGED_PROPERTY

The name of the 'file view' property.

See Also:

setFileView(FileView), Constant Field Values

FILE_HIDING_CHANGED_PROPERTY

public static final java.lang.String FILE_HIDING_CHANGED_PROPERTY

The name of the 'file hiding enabled' property.

See Also:

setFileHidingEnabled(boolean), Constant Field Values

FILE_FILTER_CHANGED_PROPERTY

public static final java.lang.String FILE_FILTER_CHANGED_PROPERTY

The name of the 'file filter' property.

See Also:

setFileFilter(FileFilter), Constant Field Values

FILE_SELECTION_MODE_CHANGED_PROPERTY

public static final java.lang.String FILE_SELECTION_MODE_CHANGED_PROPERTY

The name of the 'file selection mode' property.

See Also:

setFileSelectionMode(int), Constant Field Values

ACCESSORY_CHANGED_PROPERTY

public static final java.lang.String ACCESSORY_CHANGED_PROPERTY

The name of the 'accessory' property.

See Also:

setAccessory(JComponent), Constant Field Values

ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY

public static final java.lang.String ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY

The name of the 'accept all file filter used' property.

See Also:

setAcceptAllFileFilterUsed(boolean), Constant Field Values

DIALOG_TITLE_CHANGED_PROPERTY

public static final java.lang.String DIALOG_TITLE_CHANGED_PROPERTY

The name of the 'dialog title' property.

See Also:

setDialogTitle(String), Constant Field Values

DIALOG_TYPE_CHANGED_PROPERTY

public static final java.lang.String DIALOG_TYPE_CHANGED_PROPERTY

The name of the 'dialog type' property.

See Also:

setDialogType(int), Constant Field Values

CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY

public static final java.lang.String CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY

The name of the 'choosable file filters' property.

See Also:

addChoosableFileFilter(FileFilter), Constant Field Values

accessibleContext

protected javax.accessibility.AccessibleContext accessibleContext

The accessible context.

See Also:

getAccessibleContext()

Constructor Detail

JFileChooser

public JFileChooser()

Creates a new JFileChooser object.

JFileChooser

public JFileChooser(java.lang.String currentDirectoryPath)

Creates a new JFileChooser object.

Parameters:

currentDirectoryPath - the directory that should initially be shown in the filechooser (if null, the user's home directory is used).

JFileChooser

public JFileChooser(java.lang.String currentDirectoryPath,
            javax.swing.filechooser.FileSystemView fsv)

Creates a new JFileChooser object with the specified directory and FileSystemView.

Parameters:

currentDirectoryPath - the directory that should initially be shown in the filechooser (if null, the user's home directory is used).

fsv - the file system view (if null, the default file system view is used).

JFileChooser

public JFileChooser(java.io.File currentDirectory)

Creates a new JFileChooser object.

Parameters:

currentDirectory - the directory that should initially be shown in the filechooser (if null, the user's home directory is used).

JFileChooser

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

Creates a new JFileChooser object.

Parameters:

fsv - the file system view (if null, the default file system view is used).

JFileChooser

public JFileChooser(java.io.File currentDirectory,
            javax.swing.filechooser.FileSystemView fsv)

Creates a new JFileChooser object.

Parameters:

currentDirectory - the directory that should initially be shown in the filechooser (if null, the user's home directory is used).

fsv - the file system view (if null, the default file system view is used).

Method Detail

setup

protected void setup(javax.swing.filechooser.FileSystemView view)

Sets up the file chooser. This method is called by all the constructors.

Parameters:

view - the file system view (if null, the default file system view is used).

See Also:

FileSystemView.getFileSystemView()

setDragEnabled

public void setDragEnabled(boolean b)

Sets the dragEnabled property, this disables/enables automatic drag handling (drag and drop) on this component. The default value of the dragEnabled property is false. Some look and feels might not support automatic drag and drop; they will ignore this property.

Parameters:

b - - the new dragEnabled value

getDragEnabled

public boolean getDragEnabled()

Returns true if dragging is enabled.

Returns:

true if dragging is enabled.

getSelectedFile

public java.io.File getSelectedFile()

Returns the selected file, if there is one.

Returns:

The selected file (possibly null).

See Also:

setSelectedFile(File)

setSelectedFile

public void setSelectedFile(java.io.File file)

Sets the selected file and sends a PropertyChangeEvent to all registered listeners. The property name is SELECTED_FILE_CHANGED_PROPERTY.

Parameters:

file - the file (null permitted).

getSelectedFiles

public java.io.File[] getSelectedFiles()

Returns the selected file or files in an array. If no files are selected, an empty array is returned.

Returns:

An array of the selected files (possibly empty).

setSelectedFiles

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

Sets the selected files and sends a PropertyChangeEvent (with the name SELECTED_FILES_CHANGED_PROPERTY) to all registered listeners.

Parameters:

selectedFiles - the selected files (null permitted).

getCurrentDirectory

public java.io.File getCurrentDirectory()

Returns the current directory.

Returns:

The current directory.

setCurrentDirectory

public void setCurrentDirectory(java.io.File dir)

Sets the current directory and fires a PropertyChangeEvent (with the property name DIRECTORY_CHANGED_PROPERTY) to all registered listeners. If dir is null, the current directory is set to the default directory returned by the file system view.

Parameters:

dir - the new directory (null permitted).

See Also:

FileSystemView.getDefaultDirectory()

changeToParentDirectory

public void changeToParentDirectory()

Called by the UI delegate when the parent directory is changed.

rescanCurrentDirectory

public void rescanCurrentDirectory()

Rescans the current directory (this is handled by the UI delegate).

ensureFileIsVisible

public void ensureFileIsVisible(java.io.File f)

Ensures the the specified file is visible (this is handled by the UI delegate).

Parameters:

f - the file.

showOpenDialog

public int showOpenDialog(java.awt.Component parent)
                   throws java.awt.HeadlessException

Displays the file chooser in a modal dialog using the OPEN_DIALOG type.

Parameters:

parent - the parent component.

Returns:

A return value indicating how the dialog was closed (one of APPROVE_OPTION, CANCEL_OPTION and ERROR_OPTION).

Throws:

java.awt.HeadlessException - DOCUMENT ME!

showSaveDialog

public int showSaveDialog(java.awt.Component parent)
                   throws java.awt.HeadlessException

Displays the file chooser in a modal dialog using the SAVE_DIALOG type.

Parameters:

parent - the parent component.

Returns:

A return value indicating how the dialog was closed (one of APPROVE_OPTION, CANCEL_OPTION and ERROR_OPTION).

Throws:

java.awt.HeadlessException - DOCUMENT ME!

showDialog

public int showDialog(java.awt.Component parent,
             java.lang.String approveButtonText)
               throws java.awt.HeadlessException

Displays the file chooser in a modal dialog using the CUSTOM_DIALOG type.

Parameters:

parent - the parent component.

Returns:

A return value indicating how the dialog was closed (one of APPROVE_OPTION, CANCEL_OPTION and ERROR_OPTION).

Throws:

java.awt.HeadlessException - DOCUMENT ME!

createDialog

protected JDialog createDialog(java.awt.Component parent)
                        throws java.awt.HeadlessException

Creates a modal dialog in which to display the file chooser.

Parameters:

parent - the parent component.

Returns:

The dialog.

Throws:

java.awt.HeadlessException - DOCUMENT ME!

getControlButtonsAreShown

public boolean getControlButtonsAreShown()

Returns the flag that controls whether or not the control buttons are shown on the file chooser.

Returns:

A boolean.

See Also:

setControlButtonsAreShown(boolean)

setControlButtonsAreShown

public void setControlButtonsAreShown(boolean b)

Sets the flag that controls whether or not the control buttons are shown and, if it changes, sends a PropertyChangeEvent (with the property name CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY) to all registered listeners.

Parameters:

b - the new value for the flag.

getDialogType

public int getDialogType()

Returns the type of file chooser.

Returns:

OPEN_DIALOG, SAVE_DIALOG or CUSTOM_DIALOG.

See Also:

setDialogType(int)

setDialogType

public void setDialogType(int dialogType)

Sets the dialog type and fires a PropertyChangeEvent (with the property name DIALOG_TYPE_CHANGED_PROPERTY) to all registered listeners.

Parameters:

dialogType - the dialog type (one of: OPEN_DIALOG, SAVE_DIALOG, CUSTOM_DIALOG).

Throws:

java.lang.IllegalArgumentException - if dialogType is not valid.

setDialogTitle

public void setDialogTitle(java.lang.String dialogTitle)

Sets the dialog title and sends a PropertyChangeEvent (with the property name DIALOG_TITLE_CHANGED_PROPERTY) to all registered listeners.

Parameters:

dialogTitle - the dialog title (null permitted).

See Also:

getDialogTitle()

getDialogTitle

public java.lang.String getDialogTitle()

Returns the dialog title.

Returns:

The dialog title (possibly null).

See Also:

setDialogTitle(String)

setApproveButtonToolTipText

public void setApproveButtonToolTipText(java.lang.String toolTipText)

Sets the tool tip text for the approve button and sends a PropertyChangeEvent (with the property name APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY) to all registered listeners.

Parameters:

toolTipText - the text.

getApproveButtonToolTipText

public java.lang.String getApproveButtonToolTipText()

Returns the tool tip text for the approve button.

Returns:

The tool tip text for the approve button.

See Also:

setApproveButtonToolTipText(String)

getApproveButtonMnemonic

public int getApproveButtonMnemonic()

Returns the approve button mnemonic, or zero if no mnemonic has been set.

Returns:

The approve button mnemonic.

See Also:

setApproveButtonMnemonic(int)

setApproveButtonMnemonic

public void setApproveButtonMnemonic(int mnemonic)

Sets the mnemonic for the approve button and sends a PropertyChangeEvent (with the property name APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY) to all registered listeners.

Parameters:

mnemonic - the mnemonic.

See Also:

setApproveButtonMnemonic(char)

setApproveButtonMnemonic

public void setApproveButtonMnemonic(char mnemonic)

Sets the mnemonic for the approve button and sends a PropertyChangeEvent (with the property name APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY) to all registered listeners.

Parameters:

mnemonic - the mnemonic.

See Also:

setApproveButtonMnemonic(int)

setApproveButtonText

public void setApproveButtonText(java.lang.String approveButtonText)

Sets the approve button text and fires a PropertyChangeEvent (with the property name APPROVE_BUTTON_TEXT_CHANGED_PROPERTY) to all registered listeners.

Parameters:

approveButtonText - the text (null permitted).

See Also:

getApproveButtonText()

getApproveButtonText

public java.lang.String getApproveButtonText()

Returns the approve button text.

Returns:

The approve button text (possibly null).

See Also:

setApproveButtonText(String)

getChoosableFileFilters

public javax.swing.filechooser.FileFilter[] getChoosableFileFilters()

Returns the available file filters for this file chooser.

Returns:

The available file filters.

addChoosableFileFilter

public void addChoosableFileFilter(javax.swing.filechooser.FileFilter filter)

Adds a file filter to the list of available filters and sends a PropertyChangeEvent (with the property name CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY) to all registered listeners.

Parameters:

filter - the filter (null permitted).

removeChoosableFileFilter

public boolean removeChoosableFileFilter(javax.swing.filechooser.FileFilter f)

Removes a file filter from the list of available filters and sends a PropertyChangeEvent (with the property name CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY) to all registered listeners.

Parameters:

f - the file filter.

Returns:

true if the filter was removed and false otherwise.

resetChoosableFileFilters

public void resetChoosableFileFilters()

Clears the list of choosable file filters and installs the 'accept all' filter from the UI delegate.

getAcceptAllFileFilter

public javax.swing.filechooser.FileFilter getAcceptAllFileFilter()

Returns the 'accept all' file filter from the UI delegate.

Returns:

The 'accept all' file filter.

isAcceptAllFileFilterUsed

public boolean isAcceptAllFileFilterUsed()

Returns the flag that controls whether or not the 'accept all' file filter is included in the list of filters.

Returns:

A boolean.

See Also:

setAcceptAllFileFilterUsed(boolean)

setAcceptAllFileFilterUsed

public void setAcceptAllFileFilterUsed(boolean b)

Sets the flag that controls whether or not the 'accept all' file filter is included in the list of filters, and sends a PropertyChangeEvent (with the property name ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY) to all registered listeners.

Parameters:

b - the new value of the flag.

getAccessory

public JComponent getAccessory()

Returns the accessory component for the file chooser. The default value is null.

Returns:

The accessory component (possibly null).

See Also:

setAccessory(JComponent)

setAccessory

public void setAccessory(JComponent newAccessory)

Sets the accessory component for the file chooser and sends a PropertyChangeEvent to all registered listeners. The property name is ACCESSORY_CHANGED_PROPERTY.

Parameters:

newAccessory - the accessory component.

setFileSelectionMode

public void setFileSelectionMode(int mode)

Sets the file selection mode and sends a PropertyChangeEvent to all registered listeners. The property name is FILE_SELECTION_MODE_CHANGED_PROPERTY.

Parameters:

mode - the mode (FILES_ONLY, DIRECTORIES_ONLY or FILES_AND_DIRECTORIES).

Throws:

java.lang.IllegalArgumentException - if the mode is invalid.

getFileSelectionMode

public int getFileSelectionMode()

Returns the file selection mode, one of: FILES_ONLY, DIRECTORIES_ONLY or FILES_AND_DIRECTORIES. The default is FILES_ONLY.

Returns:

The file selection mode.

See Also:

setFileSelectionMode(int)

isFileSelectionEnabled

public boolean isFileSelectionEnabled()

Returns true if file selection is enabled, and false otherwise. File selection is enabled when the file selection mode is FILES_ONLY or FILES_AND_DIRECTORIES.

Returns:

true if file selection is enabled.

See Also:

getFileSelectionMode()

isDirectorySelectionEnabled

public boolean isDirectorySelectionEnabled()

Returns true if directory selection is enabled, and false otherwise. Directory selection is enabled when the file selection mode is DIRECTORIES_ONLY or FILES_AND_DIRECTORIES.

Returns:

true if file selection is enabled.

See Also:

getFileSelectionMode()

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean b)

Sets the flag that controls whether multiple selections are allowed in this filechooser and sends a PropertyChangeEvent (with the property name MULTI_SELECTION_ENABLED_CHANGED_PROPERTY) to all registered listeners.

Parameters:

b - the new value of the flag.

isMultiSelectionEnabled

public boolean isMultiSelectionEnabled()

Returns true if multiple selections are allowed within this file chooser, and false otherwise.

Returns:

A boolean.

See Also:

setMultiSelectionEnabled(boolean)

isFileHidingEnabled

public boolean isFileHidingEnabled()

Returns true if hidden files are to be hidden, and false otherwise.

Returns:

A boolean.

See Also:

setFileHidingEnabled(boolean)

setFileHidingEnabled

public void setFileHidingEnabled(boolean b)

Sets the flag that controls whether or not hidden files are displayed, and sends a PropertyChangeEvent (with the property name FILE_HIDING_CHANGED_PROPERTY) to all registered listeners.

Parameters:

b - the new value of the flag.

setFileFilter

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

Sets the file filter and sends a PropertyChangeEvent (with the property name FILE_FILTER_CHANGED_PROPERTY) to all registered listeners.

Parameters:

filter - the filter (null permitted).

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Returns the file filter.

Returns:

The file filter.

See Also:

setFileFilter(FileFilter)

setFileView

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

Sets a custom FileView for the file chooser and sends a PropertyChangeEvent to all registered listeners. The property name is FILE_VIEW_CHANGED_PROPERTY.

Parameters:

fileView - the file view (null permitted).

See Also:

getFileView()

getFileView

public javax.swing.filechooser.FileView getFileView()

Returns the custom FileView for the file chooser.

Returns:

The file view (possibly null).

getName

public java.lang.String getName(java.io.File f)

Returns the name of the file, generated by the current (or default) FileView.

Parameters:

f - the file.

Returns:

The file name.

getDescription

public java.lang.String getDescription(java.io.File f)

Returns the description of the file, generated by the current (or default) FileView.

Parameters:

f - the file.

Returns:

The file description.

getTypeDescription

public java.lang.String getTypeDescription(java.io.File f)

Returns the type description for the file, generated by the current (or default) FileView.

Parameters:

f - the file.

Returns:

The file type description.

getIcon

public Icon getIcon(java.io.File f)

Returns the icon provided by the current (or default) FileView.

Parameters:

f - the file.

Returns:

An icon representing the file.

isTraversable

public boolean isTraversable(java.io.File f)

Returns true if the file is traversable, and false otherwise.

Parameters:

f - the file or directory.

Returns:

A boolean.

accept

public boolean accept(java.io.File f)

Returns true if the file is accepted by the current file filter.

Parameters:

f - the file.

Returns:

A boolean.

setFileSystemView

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

Sets the file system view for the file chooser and sends a PropertyChangeEvent to all registered listeners.

Parameters:

fsv - the file system view.

getFileSystemView

public javax.swing.filechooser.FileSystemView getFileSystemView()

Returns the file system view being used by this file chooser.

Returns:

The file system view.

See Also:

setFileSystemView(FileSystemView)

approveSelection

public void approveSelection()

Approves the selection. An ActionEvent is sent to all registered listeners.

cancelSelection

public void cancelSelection()

Cancels the selection. An ActionEvent is sent to all registered listeners.

addActionListener

public void addActionListener(java.awt.event.ActionListener l)

Adds an ActionListener to the file chooser.

Parameters:

l - the listener.

removeActionListener

public void removeActionListener(java.awt.event.ActionListener l)

Removes an ActionListener from this file chooser.

Parameters:

l - the listener.

getActionListeners

public java.awt.event.ActionListener[] getActionListeners()

Returns the action listeners registered with this file chooser.

Returns:

An array of listeners.

fireActionPerformed

protected void fireActionPerformed(java.lang.String command)

Sends an @link {ActionEvent} to all registered listeners.

Parameters:

command - the action command.

updateUI

public void updateUI()

Installs the UI delegate for the current look and feel.

Overrides:

updateUI in class JComponent

getUIClassID

public java.lang.String getUIClassID()

Returns the UI delegate class identifier.

Overrides:

getUIClassID in class JComponent

Returns:

FileChooserUI.

See Also:

JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

getUI

public javax.swing.plaf.FileChooserUI getUI()

Returns the UI delegate for the component.

Returns:

The UI delegate.

paramString

protected java.lang.String paramString()

Returns a string describing the attributes for the JFileChooser component, for use in debugging. The return value is guaranteed to be non-null, but the format of the string may vary between implementations.

Overrides:

paramString in class JComponent

Returns:

A string describing the attributes of the JFileChooser.

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Returns the object that provides accessibility features for this JFileChooser component.

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class JComponent

Returns:

The accessible context (an instance of JFileChooser.AccessibleJFileChooser).