java.lang.Object | ||||
↳ | java.awt.Component | |||
↳ | java.awt.Container | |||
↳ | javax.swing.JComponent | |||
↳ | javax.swing.JFileChooser |
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 Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
JFileChooser.AccessibleJFileChooser | This class implements accessibility support for the
JFileChooser class. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY | Identifies whether a the AcceptAllFileFilter is used or not. | |||||||||
String | ACCESSORY_CHANGED_PROPERTY | Says that a different accessory component is in use (for example, to preview files). | |||||||||
String | APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY | Identifies change in the mnemonic for the approve (yes, ok) button. | |||||||||
String | APPROVE_BUTTON_TEXT_CHANGED_PROPERTY | Identifies change in the text on the approve (yes, ok) button. | |||||||||
String | APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY | Identifies change in the tooltip text for the approve (yes, ok) button. | |||||||||
int | APPROVE_OPTION | Return value if approve (yes, ok) is chosen. | |||||||||
String | APPROVE_SELECTION | Instruction to approve the current selection (same as pressing yes or ok). | |||||||||
int | CANCEL_OPTION | Return value if cancel is chosen. | |||||||||
String | CANCEL_SELECTION | Instruction to cancel the current selection. | |||||||||
String | CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY | Identifies a change in the list of predefined file filters the user can choose from. | |||||||||
String | CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY | Instruction to display the control buttons. | |||||||||
int | CUSTOM_DIALOG | Type value indicating that the JFileChooser supports a
developer-specified file operation. |
|||||||||
String | DIALOG_TITLE_CHANGED_PROPERTY | Identifies a change in the dialog title. | |||||||||
String | DIALOG_TYPE_CHANGED_PROPERTY | Identifies a change in the type of files displayed (files only, directories only, or both files and directories). | |||||||||
int | DIRECTORIES_ONLY | Instruction to display only directories. | |||||||||
String | DIRECTORY_CHANGED_PROPERTY | Identifies user's directory change. | |||||||||
int | ERROR_OPTION | Return value if an error occured. | |||||||||
int | FILES_AND_DIRECTORIES | Instruction to display both files and directories. | |||||||||
int | FILES_ONLY | Instruction to display only files. | |||||||||
String | FILE_FILTER_CHANGED_PROPERTY | User changed the kind of files to display. | |||||||||
String | FILE_HIDING_CHANGED_PROPERTY | Identifies a change in the display-hidden-files property. | |||||||||
String | FILE_SELECTION_MODE_CHANGED_PROPERTY | Identifies a change in the kind of selection (single, multiple, etc.). | |||||||||
String | FILE_SYSTEM_VIEW_CHANGED_PROPERTY | Says that a different object is being used to find available drives on the system. | |||||||||
String | FILE_VIEW_CHANGED_PROPERTY | Says that a different object is being used to retrieve file information. | |||||||||
String | MULTI_SELECTION_ENABLED_CHANGED_PROPERTY | Enables multiple-file selections. | |||||||||
int | OPEN_DIALOG | Type value indicating that the JFileChooser supports an
"Open" file operation. |
|||||||||
int | SAVE_DIALOG | Type value indicating that the JFileChooser supports a
"Save" file operation. |
|||||||||
String | SELECTED_FILES_CHANGED_PROPERTY | Identifies change in user's multiple-file selection. | |||||||||
String | SELECTED_FILE_CHANGED_PROPERTY | Identifies change in user's single-file selection. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
accessibleContext |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a
JFileChooser pointing to the user's
default directory. | |||||||||||
Constructs a
JFileChooser using the given path. | |||||||||||
Constructs a
JFileChooser using the given File
as the path. | |||||||||||
Constructs a
JFileChooser using the given
FileSystemView . | |||||||||||
Constructs a
JFileChooser using the given current directory
and FileSystemView . | |||||||||||
Constructs a
JFileChooser using the given current directory
path and FileSystemView . |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns true if the file should be displayed.
| |||||||||||
Adds an
ActionListener to the file chooser. | |||||||||||
Adds a filter to the list of user choosable file filters.
| |||||||||||
Called by the UI when the user hits the Approve button
(labeled "Open" or "Save", by default).
| |||||||||||
Called by the UI when the user chooses the Cancel button.
| |||||||||||
Changes the directory to be set to the parent of the
current directory.
| |||||||||||
Makes sure that the specified file is viewable, and
not hidden.
| |||||||||||
Returns the
AcceptAll file filter. | |||||||||||
Gets the AccessibleContext associated with this JFileChooser.
| |||||||||||
Returns the accessory component.
| |||||||||||
Returns an array of all the action listeners
registered on this file chooser.
| |||||||||||
Returns the approve button's mnemonic.
| |||||||||||
Returns the text used in the
ApproveButton in the
FileChooserUI . | |||||||||||
Returns the tooltip text used in the
ApproveButton . | |||||||||||
Gets the list of user choosable file filters.
| |||||||||||
Returns the value of the
controlButtonsAreShown
property. | |||||||||||
Returns the current directory.
| |||||||||||
Returns the file description.
| |||||||||||
Gets the string that goes in the
JFileChooser 's titlebar. | |||||||||||
Returns the type of this dialog.
| |||||||||||
Gets the value of the
dragEnabled property. | |||||||||||
Returns the currently selected file filter.
| |||||||||||
Returns the current file-selection mode.
| |||||||||||
Returns the file system view.
| |||||||||||
Returns the current file view.
| |||||||||||
Returns the icon for this file or type of file, depending
on the system.
| |||||||||||
Returns the filename.
| |||||||||||
Returns the selected file.
| |||||||||||
Returns a list of selected files if the file chooser is
set to allow multiple selection.
| |||||||||||
Returns the file type.
| |||||||||||
Gets the UI object which implements the L&F for this component.
| |||||||||||
Returns a string that specifies the name of the L&F class
that renders this component.
| |||||||||||
Returns whether the
AcceptAll FileFilter is used. | |||||||||||
Convenience call that determines if directories are selectable based
on the current file selection mode.
| |||||||||||
Returns true if hidden files are not shown in the file chooser;
otherwise, returns false.
| |||||||||||
Convenience call that determines if files are selectable based on the
current file selection mode.
| |||||||||||
Returns true if multiple files can be selected.
| |||||||||||
Returns true if the file (directory) can be visited.
| |||||||||||
Removes an
ActionListener from the file chooser. | |||||||||||
Removes a filter from the list of user choosable file filters.
| |||||||||||
Tells the UI to rescan its files list from the current directory.
| |||||||||||
Resets the choosable file filter list to its starting state.
| |||||||||||
Determines whether the
AcceptAll FileFilter is used
as an available choice in the choosable filter list. | |||||||||||
Sets the accessory component.
| |||||||||||
Sets the approve button's mnemonic using a numeric keycode.
| |||||||||||
Sets the approve button's mnemonic using a character.
| |||||||||||
Sets the text used in the
ApproveButton in the
FileChooserUI . | |||||||||||
Sets the tooltip text used in the
ApproveButton . | |||||||||||
Sets the property
that indicates whether the approve and cancel
buttons are shown in the file chooser.
| |||||||||||
Sets the current directory.
| |||||||||||
Sets the string that goes in the
JFileChooser window's
title bar. | |||||||||||
Sets the type of this dialog.
| |||||||||||
Sets the
dragEnabled property,
which must be true to enable
automatic drag handling (the first part of drag and drop)
on this component. | |||||||||||
Sets the current file filter.
| |||||||||||
Sets file hiding on or off.
| |||||||||||
Sets the
JFileChooser to allow the user to just
select files, just select
directories, or select both files and directories. | |||||||||||
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. | |||||||||||
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.
| |||||||||||
Sets the file chooser to allow multiple file selections.
| |||||||||||
Sets the selected file.
| |||||||||||
Sets the list of selected files if the file chooser is
set to allow multiple selection.
| |||||||||||
Pops a custom file chooser dialog with a custom approve button.
| |||||||||||
Pops up an "Open File" file chooser dialog.
| |||||||||||
Pops up a "Save File" file chooser dialog.
| |||||||||||
Resets the UI property to a value from the current look and feel.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates and returns a new
JDialog wrapping
this centered on the parent
in the parent 's frame. | |||||||||||
Notifies all listeners that have registered interest for
notification on this event type.
| |||||||||||
Returns a string representation of this
JFileChooser . | |||||||||||
Performs common constructor initialization and setup.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Identifies whether a the AcceptAllFileFilter is used or not.
Says that a different accessory component is in use (for example, to preview files).
Identifies change in the mnemonic for the approve (yes, ok) button.
Identifies change in the text on the approve (yes, ok) button.
Identifies change in the tooltip text for the approve (yes, ok) button.
Return value if approve (yes, ok) is chosen.
Instruction to approve the current selection (same as pressing yes or ok).
Return value if cancel is chosen.
Instruction to cancel the current selection.
Identifies a change in the list of predefined file filters the user can choose from.
Instruction to display the control buttons.
Type value indicating that the JFileChooser
supports a
developer-specified file operation.
Identifies a change in the dialog title.
Identifies a change in the type of files displayed (files only, directories only, or both files and directories).
Instruction to display only directories.
Identifies user's directory change.
Return value if an error occured.
Instruction to display both files and directories.
Instruction to display only files.
User changed the kind of files to display.
Identifies a change in the display-hidden-files property.
Identifies a change in the kind of selection (single, multiple, etc.).
Says that a different object is being used to find available drives on the system.
Says that a different object is being used to retrieve file information.
Enables multiple-file selections.
Type value indicating that the JFileChooser
supports an
"Open" file operation.
Type value indicating that the JFileChooser
supports a
"Save" file operation.
Identifies change in user's multiple-file selection.
Identifies change in user's single-file selection.
Constructs a JFileChooser
pointing to the user's
default directory. This default depends on the operating system.
It is typically the "My Documents" folder on Windows, and the
user's home directory on Unix.
Constructs a JFileChooser
using the given path.
Passing in a null
string causes the file chooser to point to the user's default directory.
This default depends on the operating system. It is
typically the "My Documents" folder on Windows, and the user's
home directory on Unix.
currentDirectoryPath | a String giving the path
to a file or directory
|
---|
Constructs a JFileChooser
using the given File
as the path. Passing in a null
file
causes the file chooser to point to the user's default directory.
This default depends on the operating system. It is
typically the "My Documents" folder on Windows, and the user's
home directory on Unix.
currentDirectory | a File object specifying
the path to a file or directory
|
---|
Constructs a JFileChooser
using the given current directory
and FileSystemView
.
Constructs a JFileChooser
using the given current directory
path and FileSystemView
.
Returns true if the file should be displayed.
f | the File |
---|
Adds an ActionListener
to the file chooser.
l | the listener to be added |
---|
Adds a filter to the list of user choosable file filters.
For information on setting the file selection mode, see
setFileSelectionMode
.
filter | the FileFilter to add to the choosable file
filter list |
---|
Called by the UI when the user hits the Approve button
(labeled "Open" or "Save", by default). This can also be
called by the programmer.
This method causes an action event to fire
with the command string equal to
APPROVE_SELECTION
.
Called by the UI when the user chooses the Cancel button.
This can also be called by the programmer.
This method causes an action event to fire
with the command string equal to
CANCEL_SELECTION
.
Changes the directory to be set to the parent of the current directory.
Makes sure that the specified file is viewable, and not hidden.
f | a File object |
---|
Returns the AcceptAll
file filter.
For example, on Microsoft Windows this would be All Files (*.*).
Gets the AccessibleContext associated with this JFileChooser. For file choosers, the AccessibleContext takes the form of an AccessibleJFileChooser. A new AccessibleJFileChooser instance is created if necessary.
Returns the accessory component.
Returns an array of all the action listeners registered on this file chooser.
ActionListener
s
or an empty
array if no action listeners are currently registeredReturns the approve button's mnemonic.
Returns the text used in the ApproveButton
in the
FileChooserUI
.
If null
, the UI object will determine the button's text.
Typically, this would be "Open" or "Save".
ApproveButton
Returns the tooltip text used in the ApproveButton
.
If null
, the UI object will determine the button's text.
Gets the list of user choosable file filters.
FileFilter
array containing all the choosable
file filtersReturns the value of the controlButtonsAreShown
property.
controlButtonsAreShown
propertyReturns the file description.
f | the File |
---|
String
containing the file description for
f
Returns the type of this dialog. The default is
JFileChooser.OPEN_DIALOG
.
Gets the value of the dragEnabled
property.
dragEnabled
propertyReturns the currently selected file filter.
Returns the current file-selection mode. The default is
JFilesChooser.FILES_ONLY
.
Returns the file system view.
FileSystemView
objectReturns the icon for this file or type of file, depending on the system.
f | the File |
---|
Icon
for this file, or type of fileReturns the filename.
f | the File |
---|
String
containing the filename for
f
Returns the selected file. This can be set either by the
programmer via setSelectedFile
or by a user action, such as
either typing the filename into the UI or selecting the
file from a list in the UI.
Returns a list of selected files if the file chooser is set to allow multiple selection.
Returns the file type.
f | the File |
---|
String
containing the file type description for
f
Gets the UI object which implements the L&F for this component.
Returns a string that specifies the name of the L&F class that renders this component.
Returns whether the AcceptAll FileFilter
is used.
AcceptAll FileFilter
is usedConvenience call that determines if directories are selectable based on the current file selection mode.
Returns true if hidden files are not shown in the file chooser; otherwise, returns false.
Convenience call that determines if files are selectable based on the current file selection mode.
Returns true if multiple files can be selected.
Returns true if the file (directory) can be visited. Returns false if the directory cannot be traversed.
f | the File |
---|
Removes an ActionListener
from the file chooser.
l | the listener to be removed |
---|
Removes a filter from the list of user choosable file filters. Returns true if the file filter was removed.
Tells the UI to rescan its files list from the current directory.
Resets the choosable file filter list to its starting state. Normally,
this removes all added file filters while leaving the
AcceptAll
file filter.
Determines whether the AcceptAll FileFilter
is used
as an available choice in the choosable filter list.
If false, the AcceptAll
file filter is removed from
the list of available file filters.
If true, the AcceptAll
file filter will become the
the actively used file filter.
Sets the accessory component. An accessory is often used to show a preview image of the selected file; however, it can be used for anything that the programmer wishes, such as extra custom file chooser controls.
Note: if there was a previous accessory, you should unregister any listeners that the accessory might have registered with the file chooser.
Sets the approve button's mnemonic using a numeric keycode.
mnemonic | an integer value for the mnemonic key |
---|
Sets the approve button's mnemonic using a character.
mnemonic | a character value for the mnemonic key |
---|
Sets the text used in the ApproveButton
in the
FileChooserUI
.
approveButtonText | the text used in the ApproveButton |
---|
Sets the tooltip text used in the ApproveButton
.
If null
, the UI object will determine the button's text.
toolTipText | the tooltip text for the approve button |
---|
Sets the property
that indicates whether the approve and cancel
buttons are shown in the file chooser. This property
is true
by default. Look and feels
that always show these buttons will ignore the value
of this property.
This method fires a property-changed event,
using the string value of
CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY
as the name of the property.
b | false if control buttons should not be
shown; otherwise, true |
---|
Sets the current directory. Passing in null
sets the
file chooser to point to the user's default directory.
This default depends on the operating system. It is
typically the "My Documents" folder on Windows, and the user's
home directory on Unix.
If the file passed in as currentDirectory
is not a
directory, the parent of the file will be used as the currentDirectory.
If the parent is not traversable, then it will walk up the parent tree
until it finds a traversable directory, or hits the root of the
file system.
dir | the current directory to point to |
---|
Sets the string that goes in the JFileChooser
window's
title bar.
dialogTitle | the new String for the title bar |
---|
Sets the type of this dialog. Use OPEN_DIALOG
when you
want to bring up a file chooser that the user can use to open a file.
Likewise, use SAVE_DIALOG
for letting the user choose
a file for saving.
Use CUSTOM_DIALOG
when you want to use the file
chooser in a context other than "Open" or "Save".
For instance, you might want to bring up a file chooser that allows
the user to choose a file to execute. Note that you normally would not
need to set the JFileChooser
to use
CUSTOM_DIALOG
since a call to setApproveButtonText
does this for you.
The default dialog type is JFileChooser.OPEN_DIALOG
.
dialogType | the type of dialog to be displayed:
|
---|
IllegalArgumentException | if dialogType is
not legal |
---|
Sets the dragEnabled
property,
which must be true
to enable
automatic drag handling (the first part of drag and drop)
on this component.
The transferHandler
property needs to be set
to a non-null
value for the drag to do
anything. The default value of the dragEnabled
property
is false
.
When automatic drag handling is enabled,
most look and feels begin a drag-and-drop operation
whenever the user presses the mouse button over an item
and then moves the mouse a few pixels.
Setting this property to true
can therefore have a subtle effect on
how selections behave.
Some look and feels might not support automatic drag and drop;
they will ignore this property. You can work around such
look and feels by modifying the component
to directly call the exportAsDrag
method of a
TransferHandler
.
b | the value to set the dragEnabled property to |
---|
HeadlessException | if
b is true and
GraphicsEnvironment.isHeadless()
returns true |
---|
Sets the current file filter. The file filter is used by the file chooser to filter out files from the user's view.
filter | the new current file filter to use |
---|
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
.
b | the boolean value that determines whether file hiding is turned on |
---|
Sets the JFileChooser
to allow the user to just
select files, just select
directories, or select both files and directories. The default is
JFilesChooser.FILES_ONLY
.
mode | the type of files to be displayed:
|
---|
IllegalArgumentException | if mode is an
illegal file selection mode |
---|
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.
fsv | the new FileSystemView |
---|
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.
Sets the file chooser to allow multiple file selections.
b | true if multiple files may be selected |
---|
Sets the selected file. If the file's parent directory is not the current directory, changes the current directory to be the file's parent directory.
file | the selected file |
---|
Sets the list of selected files if the file chooser is set to allow multiple selection.
Pops a custom file chooser dialog with a custom approve button. For example, the following code pops up a file chooser with a "Run Application" button (instead of the normal "Save" or "Open" button):
filechooser.showDialog(parentFrame, "Run Application");Alternatively, the following code does the same thing:
JFileChooser chooser = new JFileChooser(null); chooser.setApproveButtonText("Run Application"); chooser.showDialog(parentFrame, null);
The parent
argument determines two things:
the frame on which the open dialog depends and
the component whose position the look and feel
should consider when placing the dialog. If the parent
is a Frame
object (such as a JFrame
)
then the dialog depends on the frame and
the look and feel positions the dialog
relative to the frame (for example, centered over the frame).
If the parent is a component, then the dialog
depends on the frame containing the component,
and is positioned relative to the component
(for example, centered over the component).
If the parent is null
, then the dialog depends on
no visible window, and it's placed in a
look-and-feel-dependent position
such as the center of the screen.
parent | the parent component of the dialog;
can be null |
---|---|
approveButtonText | the text of the ApproveButton |
HeadlessException | if GraphicsEnvironment.isHeadless() returns true. |
---|
Pops up an "Open File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.
parent | the parent component of the dialog,
can be null ;
see showDialog for details |
---|
HeadlessException | if GraphicsEnvironment.isHeadless() returns true. |
---|
Pops up a "Save File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.
parent | the parent component of the dialog,
can be null ;
see showDialog for details |
---|
HeadlessException | if GraphicsEnvironment.isHeadless() returns true. |
---|
Resets the UI property to a value from the current look and feel.
Creates and returns a new JDialog
wrapping
this
centered on the parent
in the parent
's frame.
This method can be overriden to further manipulate the dialog,
to disable resizing, set the location, etc. Example:
class MyFileChooser extends JFileChooser { protected JDialog createDialog(Component parent) throws HeadlessException { JDialog dialog = super.createDialog(parent); dialog.setLocation(300, 200); dialog.setResizable(false); return dialog; } }
parent | the parent component of the dialog;
can be null |
---|
JDialog
containing this instanceHeadlessException | if GraphicsEnvironment.isHeadless() returns true. |
---|
Notifies all listeners that have registered interest for
notification on this event type. The event instance
is lazily created using the command
parameter.
Returns a string representation of this JFileChooser
.
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
.
JFileChooser