javax.swing
Class JFileChooser

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JFileChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JFileChooser
extends JComponent
implements Accessible

JFileChooser provides a simple mechanism for the user to choose a file. For information about using JFileChooser, see How to Use File Choosers, a section in The Java Tutorial.

The following code pops up a file chooser for the user's home directory that sees only .jpg and .gif images:

    JFileChooser chooser = new JFileChooser();
    FileNameExtensionFilter filter = new FileNameExtensionFilter(
        "JPG & GIF Images", "jpg", "gif");
    chooser.setFileFilter(filter);
    int returnVal = chooser.showOpenDialog(parent);
    if(returnVal == JFileChooser.APPROVE_OPTION) {
       System.out.println("You chose to open this file: " +
            chooser.getSelectedFile().getName());
    }
 

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Nested Class Summary
protected  class	JFileChooser.AccessibleJFileChooser           This class implements accessibility support for the JFileChooser class.

 

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

 

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

 

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

 

Field Summary
static String	ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY           Identifies whether a the AcceptAllFileFilter is used or not.
protected  AccessibleContext	accessibleContext
static String	ACCESSORY_CHANGED_PROPERTY           Says that a different accessory component is in use (for example, to preview files).
static String	APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY           Identifies change in the mnemonic for the approve (yes, ok) button.
static String	APPROVE_BUTTON_TEXT_CHANGED_PROPERTY           Identifies change in the text on the approve (yes, ok) button.
static String	APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY           Identifies change in the tooltip text for the approve (yes, ok) button.
static int	APPROVE_OPTION           Return value if approve (yes, ok) is chosen.
static String	APPROVE_SELECTION           Instruction to approve the current selection (same as pressing yes or ok).
static int	CANCEL_OPTION           Return value if cancel is chosen.
static String	CANCEL_SELECTION           Instruction to cancel the current selection.
static String	CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY           Identifies a change in the list of predefined file filters the user can choose from.
static String	CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY           Instruction to display the control buttons.
static int	CUSTOM_DIALOG           Type value indicating that the JFileChooser supports a developer-specified file operation.
static String	DIALOG_TITLE_CHANGED_PROPERTY           Identifies a change in the dialog title.
static String	DIALOG_TYPE_CHANGED_PROPERTY           Identifies a change in the type of files displayed (files only, directories only, or both files and directories).
static int	DIRECTORIES_ONLY           Instruction to display only directories.
static String	DIRECTORY_CHANGED_PROPERTY           Identifies user's directory change.
static int	ERROR_OPTION           Return value if an error occured.
static String	FILE_FILTER_CHANGED_PROPERTY           User changed the kind of files to display.
static String	FILE_HIDING_CHANGED_PROPERTY           Identifies a change in the display-hidden-files property.
static String	FILE_SELECTION_MODE_CHANGED_PROPERTY           Identifies a change in the kind of selection (single, multiple, etc.).
static String	FILE_SYSTEM_VIEW_CHANGED_PROPERTY           Says that a different object is being used to find available drives on the system.
static 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 int	FILES_ONLY           Instruction to display only files.
static String	MULTI_SELECTION_ENABLED_CHANGED_PROPERTY           Enables multiple-file selections.
static int	OPEN_DIALOG           Type value indicating that the JFileChooser supports an "Open" file operation.
static int	SAVE_DIALOG           Type value indicating that the JFileChooser supports a "Save" file operation.
static String	SELECTED_FILE_CHANGED_PROPERTY           Identifies change in user's single-file selection.
static 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
JFileChooser()           Constructs a JFileChooser pointing to the user's default directory.
JFileChooser(File currentDirectory)           Constructs a JFileChooser using the given File as the path.
JFileChooser(File currentDirectory, FileSystemView fsv)           Constructs a JFileChooser using the given current directory and FileSystemView.
JFileChooser(FileSystemView fsv)           Constructs a JFileChooser using the given FileSystemView.
JFileChooser(String currentDirectoryPath)           Constructs a JFileChooser using the given path.
JFileChooser(String currentDirectoryPath, FileSystemView fsv)           Constructs a JFileChooser using the given current directory path and FileSystemView.

 

Method Summary
boolean	accept(File f)           Returns true if the file should be displayed.
void	addActionListener(ActionListener l)           Adds an ActionListener to the file chooser.
void	addChoosableFileFilter(FileFilter filter)           Adds a filter to the list of user choosable file filters.
void	approveSelection()           Called by the UI when the user hits the Approve button (labeled "Open" or "Save", by default).
void	cancelSelection()           Called by the UI when the user chooses the Cancel button.
void	changeToParentDirectory()           Changes the directory to be set to the parent of the current directory.
protected  JDialog	createDialog(Component parent)           Creates and returns a new JDialog wrapping this centered on the parent in the parent's frame.
void	ensureFileIsVisible(File f)           Makes sure that the specified file is viewable, and not hidden.
protected  void	fireActionPerformed(String command)           Notifies all listeners that have registered interest for notification on this event type.
FileFilter	getAcceptAllFileFilter()           Returns the AcceptAll file filter.
AccessibleContext	getAccessibleContext()           Gets the AccessibleContext associated with this JFileChooser.
JComponent	getAccessory()           Returns the accessory component.
ActionListener[]	getActionListeners()           Returns an array of all the action listeners registered on this file chooser.
int	getApproveButtonMnemonic()           Returns the approve button's mnemonic.
String	getApproveButtonText()           Returns the text used in the ApproveButton in the FileChooserUI.
String	getApproveButtonToolTipText()           Returns the tooltip text used in the ApproveButton.
FileFilter[]	getChoosableFileFilters()           Gets the list of user choosable file filters.
boolean	getControlButtonsAreShown()           Returns the value of the controlButtonsAreShown property.
File	getCurrentDirectory()           Returns the current directory.
String	getDescription(File f)           Returns the file description.
String	getDialogTitle()           Gets the string that goes in the JFileChooser's titlebar.
int	getDialogType()           Returns the type of this dialog.
boolean	getDragEnabled()           Gets the value of the dragEnabled property.
FileFilter	getFileFilter()           Returns the currently selected file filter.
int	getFileSelectionMode()           Returns the current file-selection mode.
FileSystemView	getFileSystemView()           Returns the file system view.
FileView	getFileView()           Returns the current file view.
Icon	getIcon(File f)           Returns the icon for this file or type of file, depending on the system.
String	getName(File f)           Returns the filename.
File	getSelectedFile()           Returns the selected file.
File[]	getSelectedFiles()           Returns a list of selected files if the file chooser is set to allow multiple selection.
String	getTypeDescription(File f)           Returns the file type.
FileChooserUI	getUI()           Gets the UI object which implements the L&F for this component.
String	getUIClassID()           Returns a string that specifies the name of the L&F class that renders this component.
boolean	isAcceptAllFileFilterUsed()           Returns whether the AcceptAll FileFilter is used.
boolean	isDirectorySelectionEnabled()           Convenience call that determines if directories are selectable based on the current file selection mode.
boolean	isFileHidingEnabled()           Returns true if hidden files are not shown in the file chooser; otherwise, returns false.
boolean	isFileSelectionEnabled()           Convenience call that determines if files are selectable based on the current file selection mode.
boolean	isMultiSelectionEnabled()           Returns true if multiple files can be selected.
boolean	isTraversable(File f)           Returns true if the file (directory) can be visited.
protected  String	paramString()           Returns a string representation of this JFileChooser.
void	removeActionListener(ActionListener l)           Removes an ActionListener from the file chooser.
boolean	removeChoosableFileFilter(FileFilter f)           Removes a filter from the list of user choosable file filters.
void	rescanCurrentDirectory()           Tells the UI to rescan its files list from the current directory.
void	resetChoosableFileFilters()           Resets the choosable file filter list to its starting state.
void	setAcceptAllFileFilterUsed(boolean b)           Determines whether the AcceptAll FileFilter is used as an available choice in the choosable filter list.
void	setAccessory(JComponent newAccessory)           Sets the accessory component.
void	setApproveButtonMnemonic(char mnemonic)           Sets the approve button's mnemonic using a character.
void	setApproveButtonMnemonic(int mnemonic)           Sets the approve button's mnemonic using a numeric keycode.
void	setApproveButtonText(String approveButtonText)           Sets the text used in the ApproveButton in the FileChooserUI.
void	setApproveButtonToolTipText(String toolTipText)           Sets the tooltip text used in the ApproveButton.
void	setControlButtonsAreShown(boolean b)           Sets the property that indicates whether the approve and cancel buttons are shown in the file chooser.
void	setCurrentDirectory(File dir)           Sets the current directory.
void	setDialogTitle(String dialogTitle)           Sets the string that goes in the JFileChooser window's title bar.
void	setDialogType(int dialogType)           Sets the type of this dialog.
void	setDragEnabled(boolean b)           Sets the dragEnabled property, which must be true to enable automatic drag handling (the first part of drag and drop) on this component.
void	setFileFilter(FileFilter filter)           Sets the current file filter.
void	setFileHidingEnabled(boolean b)           Sets file hiding on or off.
void	setFileSelectionMode(int mode)           Sets the JFileChooser to allow the user to just select files, just select directories, or select both files and directories.
void	setFileSystemView(FileSystemView fsv)           Sets the file system view that the JFileChooser uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.
void	setFileView(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	setSelectedFile(File file)           Sets the selected file.
void	setSelectedFiles(File[] selectedFiles)           Sets the list of selected files if the file chooser is set to allow multiple selection.
protected  void	setup(FileSystemView view)           Performs common constructor initialization and setup.
int	showDialog(Component parent, String approveButtonText)           Pops a custom file chooser dialog with a custom approve button.
int	showOpenDialog(Component parent)           Pops up an "Open File" file chooser dialog.
int	showSaveDialog(Component parent)           Pops up a "Save File" file chooser dialog.
void	updateUI()           Resets the UI property to a value from the current look and feel.

 

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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, 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, 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, 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

Type value indicating that the JFileChooser supports an "Open" file operation.

See Also:

Constant Field Values

SAVE_DIALOG

public static final int SAVE_DIALOG

Type value indicating that the JFileChooser supports a "Save" file operation.

See Also:

Constant Field Values

CUSTOM_DIALOG

public static final int CUSTOM_DIALOG

Type value indicating that the JFileChooser supports a developer-specified file operation.

See Also:

Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION

Return value if cancel is chosen.

See Also:

Constant Field Values

APPROVE_OPTION

public static final int APPROVE_OPTION

Return value if approve (yes, ok) is chosen.

See Also:

Constant Field Values

ERROR_OPTION

public static final int ERROR_OPTION

Return value if an error occured.

See Also:

Constant Field Values

FILES_ONLY

public static final int FILES_ONLY

Instruction to display only files.

See Also:

Constant Field Values

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY

Instruction to display only directories.

See Also:

Constant Field Values

FILES_AND_DIRECTORIES

public static final int