- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
@JavaBean(defaultProperty="UI", description="A component which allows for the interactive selection of a file.") 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.
- Since:
- 1.2
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
JFileChooser.AccessibleJFileChooser
This class implements accessibility support for theJFileChooser
class.Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields Modifier and Type Field Description static String
ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY
Identifies whether a the AcceptAllFileFilter is used or not.protected AccessibleContext
accessibleContext
AccessibleContext
associated with thisJFileChooser
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 theJFileChooser
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 occurred.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 theJFileChooser
supports an "Open" file operation.static int
SAVE_DIALOG
Type value indicating that theJFileChooser
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 declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields declared in class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Constructor Summary
Constructors Constructor Description JFileChooser()
Constructs aJFileChooser
pointing to the user's default directory.JFileChooser(File currentDirectory)
Constructs aJFileChooser
using the givenFile
as the path.JFileChooser(File currentDirectory, FileSystemView fsv)
Constructs aJFileChooser
using the given current directory andFileSystemView
.JFileChooser(String currentDirectoryPath)
Constructs aJFileChooser
using the given path.JFileChooser(String currentDirectoryPath, FileSystemView fsv)
Constructs aJFileChooser
using the given current directory path andFileSystemView
.JFileChooser(FileSystemView fsv)
Constructs aJFileChooser
using the givenFileSystemView
. -
Method Summary
Modifier and Type Method Description boolean
accept(File f)
Returns true if the file should be displayed.void
addActionListener(ActionListener l)
Adds anActionListener
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 newJDialog
wrappingthis
centered on theparent
in theparent
'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 theAcceptAll
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 theApproveButton
in theFileChooserUI
.String
getApproveButtonToolTipText()
Returns the tooltip text used in theApproveButton
.FileFilter[]
getChoosableFileFilters()
Gets the list of user choosable file filters.boolean
getControlButtonsAreShown()
Returns the value of thecontrolButtonsAreShown
property.File
getCurrentDirectory()
Returns the current directory.String
getDescription(File f)
Returns the file description.String
getDialogTitle()
Gets the string that goes in theJFileChooser
's titlebar.int
getDialogType()
Returns the type of this dialog.boolean
getDragEnabled()
Gets the value of thedragEnabled
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 theAcceptAll 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 thisJFileChooser
.void
removeActionListener(ActionListener l)
Removes anActionListener
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 theAcceptAll 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 theApproveButton
in theFileChooserUI
.void
setApproveButtonToolTipText(String toolTipText)
Sets the tooltip text used in theApproveButton
.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 theJFileChooser
window's title bar.void
setDialogType(int dialogType)
Sets the type of this dialog.void
setDragEnabled(boolean b)
Sets thedragEnabled
property, which must betrue
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 theJFileChooser
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 theJFileChooser
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 be 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 declared in class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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 declared in 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, transferFocusDownCycle, validate, validateTree
Methods declared in 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, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
OPEN_DIALOG
public static final int OPEN_DIALOGType value indicating that theJFileChooser
supports an "Open" file operation.- See Also:
- Constant Field Values
-
SAVE_DIALOG
public static final int SAVE_DIALOGType value indicating that theJFileChooser
supports a "Save" file operation.- See Also:
- Constant Field Values
-
CUSTOM_DIALOG
public static final int CUSTOM_DIALOGType value indicating that theJFileChooser
supports a developer-specified file operation.- See Also:
- Constant Field Values
-
CANCEL_OPTION
public static final int CANCEL_OPTIONReturn value if cancel is chosen.- See Also:
- Constant Field Values
-
APPROVE_OPTION
public static final int APPROVE_OPTIONReturn value if approve (yes, ok) is chosen.- See Also:
- Constant Field Values
-
ERROR_OPTION
public static final int ERROR_OPTIONReturn value if an error occurred.- See Also:
- Constant Field Values
-
FILES_ONLY
public static final int FILES_ONLYInstruction to display only files.- See Also:
- Constant Field Values
-
DIRECTORIES_ONLY
public static final int DIRECTORIES_ONLYInstruction to display only directories.- See Also:
- Constant Field Values
-
FILES_AND_DIRECTORIES
public static final int FILES_AND_DIRECTORIESInstruction to display both files and directories.- See Also:
- Constant Field Values
-
CANCEL_SELECTION
Instruction to cancel the current selection.- See Also:
- Constant Field Values
-
APPROVE_SELECTION
Instruction to approve the current selection (same as pressing yes or ok).- See Also:
- Constant Field Values
-
APPROVE_BUTTON_TEXT_CHANGED_PROPERTY
Identifies change in the text on the approve (yes, ok) button.- See Also:
- Constant Field Values
-
APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY
Identifies change in the tooltip text for the approve (yes, ok) button.- See Also:
- Constant Field Values
-
APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY
Identifies change in the mnemonic for the approve (yes, ok) button.- See Also:
- Constant Field Values
-
CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY
Instruction to display the control buttons.- See Also:
- Constant Field Values
-
DIRECTORY_CHANGED_PROPERTY
Identifies user's directory change.- See Also:
- Constant Field Values
-
SELECTED_FILE_CHANGED_PROPERTY
Identifies change in user's single-file selection.- See Also:
- Constant Field Values
-
SELECTED_FILES_CHANGED_PROPERTY
Identifies change in user's multiple-file selection.- See Also:
- Constant Field Values
-
MULTI_SELECTION_ENABLED_CHANGED_PROPERTY
Enables multiple-file selections.- See Also:
- Constant Field Values
-
FILE_SYSTEM_VIEW_CHANGED_PROPERTY
Says that a different object is being used to find available drives on the system.- See Also:
- Constant Field Values
-
FILE_VIEW_CHANGED_PROPERTY
Says that a different object is being used to retrieve file information.- See Also:
- Constant Field Values
-
FILE_HIDING_CHANGED_PROPERTY
Identifies a change in the display-hidden-files property.- See Also:
- Constant Field Values
-
FILE_FILTER_CHANGED_PROPERTY
User changed the kind of files to display.- See Also:
- Constant Field Values
-
FILE_SELECTION_MODE_CHANGED_PROPERTY
Identifies a change in the kind of selection (single, multiple, etc.).- See Also:
- Constant Field Values
-
ACCESSORY_CHANGED_PROPERTY
Says that a different accessory component is in use (for example, to preview files).- See Also:
- Constant Field Values
-
ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY
Identifies whether a the AcceptAllFileFilter is used or not.- See Also:
- Constant Field Values
-
DIALOG_TITLE_CHANGED_PROPERTY
Identifies a change in the dialog title.- See Also:
- Constant Field Values
-
DIALOG_TYPE_CHANGED_PROPERTY
Identifies a change in the type of files displayed (files only, directories only, or both files and directories).- See Also:
- Constant Field Values
-
CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY
Identifies a change in the list of predefined file filters the user can choose from.- See Also:
- Constant Field Values
-
accessibleContext
AccessibleContext
associated with thisJFileChooser
-
-
Constructor Details
-
JFileChooser
public JFileChooser()Constructs aJFileChooser
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. -
JFileChooser
Constructs aJFileChooser
using the given path. Passing in anull
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.- Parameters:
currentDirectoryPath
- aString
giving the path to a file or directory
-
JFileChooser
Constructs aJFileChooser
using the givenFile
as the path. Passing in anull
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.- Parameters:
currentDirectory
- aFile
object specifying the path to a file or directory
-
JFileChooser
Constructs aJFileChooser
using the givenFileSystemView
.- Parameters:
fsv
- aFileSystemView
-
JFileChooser
Constructs aJFileChooser
using the given current directory andFileSystemView
.- Parameters:
currentDirectory
- aFile
object specifying the path to a file or directoryfsv
- aFileSystemView
-
JFileChooser
Constructs aJFileChooser
using the given current directory path andFileSystemView
.- Parameters:
currentDirectoryPath
- aString
specifying the path to a file or directoryfsv
- aFileSystemView
-
-
Method Details
-
setup
Performs common constructor initialization and setup.- Parameters:
view
- theFileSystemView
used for setup
-
setDragEnabled
@BeanProperty(bound=false, description="determines whether automatic drag handling is enabled") public void setDragEnabled(boolean b)Sets thedragEnabled
property, which must betrue
to enable automatic drag handling (the first part of drag and drop) on this component. ThetransferHandler
property needs to be set to a non-null
value for the drag to do anything. The default value of thedragEnabled
property isfalse
.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 aTransferHandler
.- Parameters:
b
- the value to set thedragEnabled
property to- Throws:
HeadlessException
- ifb
istrue
andGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.4
- See Also:
GraphicsEnvironment.isHeadless()
,getDragEnabled()
,JComponent.setTransferHandler(javax.swing.TransferHandler)
,TransferHandler
-
getDragEnabled
public boolean getDragEnabled()Gets the value of thedragEnabled
property.- Returns:
- the value of the
dragEnabled
property - Since:
- 1.4
- See Also:
setDragEnabled(boolean)
-
getSelectedFile
Returns the selected file. This can be set either by the programmer viasetSelectedFile
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:
- the selected file
- See Also:
setSelectedFile(java.io.File)
-
setSelectedFile
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.- Parameters:
file
- the selected file- See Also:
getSelectedFile()
-
getSelectedFiles
Returns a list of selected files if the file chooser is set to allow multiple selection.- Returns:
- an array of selected
File
s
-
setSelectedFiles
@BeanProperty(description="The list of selected files if the chooser is in multiple selection mode.") public void setSelectedFiles(File[] selectedFiles)Sets the list of selected files if the file chooser is set to allow multiple selection.- Parameters:
selectedFiles
- an arrayFile
s to be selected
-
getCurrentDirectory
Returns the current directory.- Returns:
- the current directory
- See Also:
setCurrentDirectory(java.io.File)
-
setCurrentDirectory
@BeanProperty(preferred=true, description="The directory that the JFileChooser is showing files of.") public void setCurrentDirectory(File dir)Sets the current directory. Passing innull
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 ascurrentDirectory
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.- Parameters:
dir
- the current directory to point to- See Also:
getCurrentDirectory()
-
changeToParentDirectory
public void changeToParentDirectory()Changes the directory to be set to the parent of the current directory.- See Also:
getCurrentDirectory()
-
rescanCurrentDirectory
public void rescanCurrentDirectory()Tells the UI to rescan its files list from the current directory. -
ensureFileIsVisible
Makes sure that the specified file is viewable, and not hidden.- Parameters:
f
- a File object
-
showOpenDialog
Pops up an "Open File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.- Parameters:
parent
- the parent component of the dialog, can benull
; seeshowDialog
for details- Returns:
- the return state of the file chooser on popdown:
- JFileChooser.CANCEL_OPTION
- JFileChooser.APPROVE_OPTION
- JFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- See Also:
GraphicsEnvironment.isHeadless()
,showDialog(java.awt.Component, java.lang.String)
-
showSaveDialog
Pops up a "Save File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.- Parameters:
parent
- the parent component of the dialog, can benull
; seeshowDialog
for details- Returns:
- the return state of the file chooser on popdown:
- JFileChooser.CANCEL_OPTION
- JFileChooser.APPROVE_OPTION
- JFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- See Also:
GraphicsEnvironment.isHeadless()
,showDialog(java.awt.Component, java.lang.String)
-
showDialog
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 aFrame
object (such as aJFrame
) 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 isnull
, 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.- Parameters:
parent
- the parent component of the dialog; can benull
approveButtonText
- the text of theApproveButton
- Returns:
- the return state of the file chooser on popdown:
- JFileChooser.CANCEL_OPTION
- JFileChooser.APPROVE_OPTION
- JFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- See Also:
GraphicsEnvironment.isHeadless()
-
createDialog
Creates and returns a newJDialog
wrappingthis
centered on theparent
in theparent
'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; } }
- Parameters:
parent
- the parent component of the dialog; can benull
- Returns:
- a new
JDialog
containing this instance - Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.- Since:
- 1.4
- See Also:
GraphicsEnvironment.isHeadless()
-
getControlButtonsAreShown
public boolean getControlButtonsAreShown()Returns the value of thecontrolButtonsAreShown
property.- Returns:
- the value of the
controlButtonsAreShown
property - Since:
- 1.3
- See Also:
setControlButtonsAreShown(boolean)
-
setControlButtonsAreShown
@BeanProperty(preferred=true, description="Sets whether the approve & cancel buttons are shown.") public void setControlButtonsAreShown(boolean b)Sets the property that indicates whether the approve and cancel buttons are shown in the file chooser. This property istrue
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 ofCONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY
as the name of the property.- Parameters:
b
-false
if control buttons should not be shown; otherwise,true
- Since:
- 1.3
- See Also:
getControlButtonsAreShown()
,CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY
-
getDialogType
public int getDialogType()Returns the type of this dialog. The default isJFileChooser.OPEN_DIALOG
.- Returns:
- the type of dialog to be displayed:
- JFileChooser.OPEN_DIALOG
- JFileChooser.SAVE_DIALOG
- JFileChooser.CUSTOM_DIALOG
- See Also:
setDialogType(int)
-
setDialogType
@BeanProperty(preferred=true, enumerationValues={"JFileChooser.OPEN_DIALOG","JFileChooser.SAVE_DIALOG","JFileChooser.CUSTOM_DIALOG"}, description="The type (open, save, custom) of the JFileChooser.") public void setDialogType(int dialogType)Sets the type of this dialog. UseOPEN_DIALOG
when you want to bring up a file chooser that the user can use to open a file. Likewise, useSAVE_DIALOG
for letting the user choose a file for saving. UseCUSTOM_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 theJFileChooser
to useCUSTOM_DIALOG
since a call tosetApproveButtonText
does this for you. The default dialog type isJFileChooser.OPEN_DIALOG
.- Parameters:
dialogType
- the type of dialog to be displayed:- JFileChooser.OPEN_DIALOG
- JFileChooser.SAVE_DIALOG
- JFileChooser.CUSTOM_DIALOG
- Throws:
IllegalArgumentException
- ifdialogType
is not legal- See Also:
getDialogType()
,setApproveButtonText(java.lang.String)
-
setDialogTitle
@BeanProperty(preferred=true, description="The title of the JFileChooser dialog window.") public void setDialogTitle(String dialogTitle)Sets the string that goes in theJFileChooser
window's title bar.- Parameters:
dialogTitle
- the newString
for the title bar- See Also:
getDialogTitle()
-
getDialogTitle
Gets the string that goes in theJFileChooser
's titlebar.- Returns:
- the string from the
JFileChooser
window's title bar - See Also:
setDialogTitle(java.lang.String)
-
setApproveButtonToolTipText
@BeanProperty(preferred=true, description="The tooltip text for the ApproveButton.") public void setApproveButtonToolTipText(String toolTipText)Sets the tooltip text used in theApproveButton
. Ifnull
, the UI object will determine the button's text.- Parameters:
toolTipText
- the tooltip text for the approve button- See Also:
setApproveButtonText(java.lang.String)
,setDialogType(int)
,showDialog(java.awt.Component, java.lang.String)
-
getApproveButtonToolTipText
Returns the tooltip text used in theApproveButton
. Ifnull
, the UI object will determine the button's text.- Returns:
- the tooltip text used for the approve button
- See Also:
setApproveButtonText(java.lang.String)
,setDialogType(int)
,showDialog(java.awt.Component, java.lang.String)
-
getApproveButtonMnemonic
public int getApproveButtonMnemonic()Returns the approve button's mnemonic.- Returns:
- an integer value for the mnemonic key
- See Also:
setApproveButtonMnemonic(int)
-
setApproveButtonMnemonic
@BeanProperty(preferred=true, description="The mnemonic key accelerator for the ApproveButton.") public void setApproveButtonMnemonic(int mnemonic)Sets the approve button's mnemonic using a numeric keycode.- Parameters:
mnemonic
- an integer value for the mnemonic key- See Also:
getApproveButtonMnemonic()
-
setApproveButtonMnemonic
public void setApproveButtonMnemonic(char mnemonic)Sets the approve button's mnemonic using a character.- Parameters:
mnemonic
- a character value for the mnemonic key- See Also:
getApproveButtonMnemonic()
-
setApproveButtonText
@BeanProperty(preferred=true, description="The text that goes in the ApproveButton.") public void setApproveButtonText(String approveButtonText)Sets the text used in theApproveButton
in theFileChooserUI
.- Parameters:
approveButtonText
- the text used in theApproveButton
- See Also:
getApproveButtonText()
,setDialogType(int)
,showDialog(java.awt.Component, java.lang.String)
-
getApproveButtonText
Returns the text used in theApproveButton
in theFileChooserUI
. Ifnull
, the UI object will determine the button's text. Typically, this would be "Open" or "Save".- Returns:
- the text used in the
ApproveButton
- See Also:
setApproveButtonText(java.lang.String)
,setDialogType(int)
,showDialog(java.awt.Component, java.lang.String)
-
getChoosableFileFilters
Gets the list of user choosable file filters.- Returns:
- a
FileFilter
array containing all the choosable file filters - See Also:
addChoosableFileFilter(javax.swing.filechooser.FileFilter)
,removeChoosableFileFilter(javax.swing.filechooser.FileFilter)
,resetChoosableFileFilters()
-
addChoosableFileFilter
@BeanProperty(preferred=true, description="Adds a filter to the list of user choosable file filters.") public void addChoosableFileFilter(FileFilter filter)Adds a filter to the list of user choosable file filters. For information on setting the file selection mode, seesetFileSelectionMode
.- Parameters:
filter
- theFileFilter
to add to the choosable file filter list- See Also:
getChoosableFileFilters()
,removeChoosableFileFilter(javax.swing.filechooser.FileFilter)
,resetChoosableFileFilters()
,setFileSelectionMode(int)
-
removeChoosableFileFilter
Removes a filter from the list of user choosable file filters. Returns true if the file filter was removed.- Parameters:
f
- the file filter to be removed- Returns:
- true if the file filter was removed, false otherwise
- See Also:
addChoosableFileFilter(javax.swing.filechooser.FileFilter)
,getChoosableFileFilters()
,resetChoosableFileFilters()
-
resetChoosableFileFilters
public void resetChoosableFileFilters()Resets the choosable file filter list to its starting state. Normally, this removes all added file filters while leaving theAcceptAll
file filter. -
getAcceptAllFileFilter
Returns theAcceptAll
file filter. For example, on Microsoft Windows this would be All Files (*.*).- Returns:
- the
AcceptAll
file filter
-
isAcceptAllFileFilterUsed
public boolean isAcceptAllFileFilterUsed()Returns whether theAcceptAll FileFilter
is used.- Returns:
- true if the
AcceptAll FileFilter
is used - Since:
- 1.3
- See Also:
setAcceptAllFileFilterUsed(boolean)
-
setAcceptAllFileFilterUsed
@BeanProperty(preferred=true, description="Sets whether the AcceptAll FileFilter is used as an available choice in the choosable filter list.") public void setAcceptAllFileFilterUsed(boolean b)Determines whether theAcceptAll FileFilter
is used as an available choice in the choosable filter list. If false, theAcceptAll
file filter is removed from the list of available file filters. If true, theAcceptAll
file filter will become the actively used file filter.- Parameters:
b
- aboolean
which determines whether theAcceptAll
file filter is an available choice in the choosable filter list- Since:
- 1.3
- See Also:
isAcceptAllFileFilterUsed()
,getAcceptAllFileFilter()
,setFileFilter(javax.swing.filechooser.FileFilter)
-
getAccessory
Returns the accessory component.- Returns:
- this JFileChooser's accessory component, or null
- See Also:
setAccessory(javax.swing.JComponent)
-
setAccessory
@BeanProperty(preferred=true, description="Sets the accessory component on the JFileChooser.") public void setAccessory(JComponent newAccessory)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.
- Parameters:
newAccessory
- the accessory component to be set
-
setFileSelectionMode
@BeanProperty(preferred=true, enumerationValues={"JFileChooser.FILES_ONLY","JFileChooser.DIRECTORIES_ONLY","JFileChooser.FILES_AND_DIRECTORIES"}, description="Sets the types of files that the JFileChooser can choose.") public void setFileSelectionMode(int mode)Sets theJFileChooser
to allow the user to just select files, just select directories, or select both files and directories. The default isJFilesChooser.FILES_ONLY
.- Parameters:
mode
- the type of files to be displayed:- JFileChooser.FILES_ONLY
- JFileChooser.DIRECTORIES_ONLY
- JFileChooser.FILES_AND_DIRECTORIES
- Throws:
IllegalArgumentException
- ifmode
is an illegal file selection mode- See Also:
getFileSelectionMode()
-
getFileSelectionMode
public int getFileSelectionMode()Returns the current file-selection mode. The default isJFilesChooser.FILES_ONLY
.- Returns:
- the type of files to be displayed, one of the following:
- JFileChooser.FILES_ONLY
- JFileChooser.DIRECTORIES_ONLY
- JFileChooser.FILES_AND_DIRECTORIES
- See Also:
setFileSelectionMode(int)
-
isFileSelectionEnabled
Convenience call that determines if files are selectable based on the current file selection mode.- Returns:
- true if files are selectable, false otherwise
- See Also:
setFileSelectionMode(int)
,getFileSelectionMode()
-
isDirectorySelectionEnabled
Convenience call that determines if directories are selectable based on the current file selection mode.- Returns:
- true if directories are selectable, false otherwise
- See Also:
setFileSelectionMode(int)
,getFileSelectionMode()
-
setMultiSelectionEnabled
@BeanProperty(description="Sets multiple file selection mode.") public void setMultiSelectionEnabled(boolean b)Sets the file chooser to allow multiple file selections.- Parameters:
b
- true if multiple files may be selected- See Also:
isMultiSelectionEnabled()
-
isMultiSelectionEnabled
public boolean isMultiSelectionEnabled()Returns true if multiple files can be selected.- Returns:
- true if multiple files can be selected
- See Also:
setMultiSelectionEnabled(boolean)
-
isFileHidingEnabled
public boolean isFileHidingEnabled()Returns true if hidden files are not shown in the file chooser; otherwise, returns false.- Returns:
- the status of the file hiding property
- See Also:
setFileHidingEnabled(boolean)
-
setFileHidingEnabled
@BeanProperty(preferred=true, description="Sets file hiding on or off.") public void setFileHidingEnabled(boolean b)Sets file hiding on or off. If true, hidden files are not shown in the file chooser. The job of determining which files are shown is done by theFileView
.- Parameters:
b
- the boolean value that determines whether file hiding is turned on- See Also:
isFileHidingEnabled()
-
setFileFilter
@BeanProperty(preferred=true, description="Sets the File Filter used to filter out files of type.") public void setFileFilter(FileFilter filter)Sets the current file filter. The file filter is used by the file chooser to filter out files from the user's view.- Parameters:
filter
- the new current file filter to use- See Also:
getFileFilter()
-
getFileFilter
Returns the currently selected file filter.- Returns:
- the current file filter
- See Also:
setFileFilter(javax.swing.filechooser.FileFilter)
,addChoosableFileFilter(javax.swing.filechooser.FileFilter)
-
setFileView
@BeanProperty(preferred=true, description="Sets the File View used to get file type information.") public void setFileView(FileView fileView)Sets the file view to be used to retrieve UI information, such as the icon that represents a file or the type description of a file.- Parameters:
fileView
- aFileView
to be used to retrieve UI information- See Also:
getFileView()
-
getFileView
Returns the current file view.- Returns:
- the current file view
- See Also:
setFileView(javax.swing.filechooser.FileView)
-
getName
Returns the filename.- Parameters:
f
- theFile
- Returns:
- the
String
containing the filename forf
- See Also:
FileView.getName(java.io.File)
-
getDescription
Returns the file description.- Parameters:
f
- theFile
- Returns:
- the
String
containing the file description forf
- See Also:
FileView.getDescription(java.io.File)
-
getTypeDescription
Returns the file type.- Parameters:
f
- theFile
- Returns:
- the
String
containing the file type description forf
- See Also:
FileView.getTypeDescription(java.io.File)
-
getIcon
Returns the icon for this file or type of file, depending on the system.- Parameters:
f
- theFile
- Returns:
- the
Icon
for this file, or type of file - See Also:
FileView.getIcon(java.io.File)
-
isTraversable
Returns true if the file (directory) can be visited. Returns false if the directory cannot be traversed.- Parameters:
f
- theFile
- Returns:
- true if the file/directory can be traversed, otherwise false
- See Also:
FileView.isTraversable(java.io.File)
-
accept
Returns true if the file should be displayed.- Parameters:
f
- theFile
- Returns:
- true if the file should be displayed, otherwise false
- See Also:
FileFilter.accept(java.io.File)
-
setFileSystemView
@BeanProperty(expert=true, description="Sets the FileSytemView used to get filesystem information.") public void setFileSystemView(FileSystemView fsv)Sets the file system view that theJFileChooser
uses for accessing and creating file system resources, such as finding the floppy drive and getting a list of root drives.- Parameters:
fsv
- the newFileSystemView
- See Also:
FileSystemView
-
getFileSystemView
Returns the file system view.- Returns:
- the
FileSystemView
object - See Also:
setFileSystemView(javax.swing.filechooser.FileSystemView)
-
approveSelection
public void approveSelection()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 toAPPROVE_SELECTION
.- See Also:
APPROVE_SELECTION
-
cancelSelection
public void cancelSelection()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 toCANCEL_SELECTION
.- See Also:
CANCEL_SELECTION
-
addActionListener
Adds anActionListener
to the file chooser.- Parameters:
l
- the listener to be added- See Also:
approveSelection()
,cancelSelection()
-
removeActionListener
Removes anActionListener
from the file chooser.- Parameters:
l
- the listener to be removed- See Also:
addActionListener(java.awt.event.ActionListener)
-
getActionListeners
Returns an array of all the action listeners registered on this file chooser.- Returns:
- all of this file chooser's
ActionListener
s or an empty array if no action listeners are currently registered - Since:
- 1.4
- See Also:
addActionListener(java.awt.event.ActionListener)
,removeActionListener(java.awt.event.ActionListener)
-
fireActionPerformed
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using thecommand
parameter.- Parameters:
command
- a string that may specify a command associated with the event- See Also:
EventListenerList
-
updateUI
public void updateUI()Resets the UI property to a value from the current look and feel.- Overrides:
updateUI
in classJComponent
- See Also:
JComponent.updateUI()
-
getUIClassID
@BeanProperty(bound=false, expert=true, description="A string that specifies the name of the L&F class.") public String getUIClassID()Returns a string that specifies the name of the L&F class that renders this component.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "FileChooserUI"
- See Also:
JComponent.getUIClassID()
,UIDefaults.getUI(javax.swing.JComponent)
-
getUI
Gets the UI object which implements the L&F for this component.- Overrides:
getUI
in classJComponent
- Returns:
- the FileChooserUI object that implements the FileChooserUI L&F
-
paramString
Returns a string representation of thisJFileChooser
. 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 benull
.- Overrides:
paramString
in classJComponent
- Returns:
- a string representation of this
JFileChooser
-
getAccessibleContext
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.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classComponent
- Returns:
- an AccessibleJFileChooser that serves as the AccessibleContext of this JFileChooser
-