JavaTM 2 Platform
Std. Ed. v1.3.1

javax.swing
Class JFileChooser

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JFileChooser
All Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable

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();
    // Note: source for ExampleFileFilter can be found in FileChooserDemo,
    // under the demo/jfc directory in the Java 2 SDK, Standard Edition.
    ExampleFileFilter filter = new ExampleFileFilter();
    filter.addExtension("jpg");
    filter.addExtension("gif");
    filter.setDescription("JPG & GIF Images");
    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());
    }
 

See Also:
Serialized Form

Inner Class Summary
protected  class JFileChooser.AccessibleJFileChooser
          This class implements accessibility support for the JFileChooser class.
 
Inner classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
Component.AccessibleAWTComponent
 
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 home 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 button.
 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.
 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.
 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 a boolean indicating whether the accept and cancel buttons are shown in the file chooser.
 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.
 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 button.
 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 if the AcceptAll FileFilter is used.
 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 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 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()
          Notification from the UIFactory that the L&F has changed.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPEN_DIALOG

public static final int OPEN_DIALOG
Type value indicating that the JFileChooser supports an "Open" file operation.

SAVE_DIALOG

public static final int SAVE_DIALOG
Type value indicating that the JFileChooser supports a "Save" file operation.

CUSTOM_DIALOG

public static final int CUSTOM_DIALOG
Type value indicating that the JFileChooser supports a developer-specified file operation.

CANCEL_OPTION

public static final int CANCEL_OPTION
Return value if cancel is chosen.

APPROVE_OPTION

public static final int APPROVE_OPTION
Return value if approve (yes, ok) is chosen.

ERROR_OPTION

public static final int ERROR_OPTION
Return value if an error occured.

FILES_ONLY

public static final int FILES_ONLY
Instruction to display only files.

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY
Instruction to display only directories.

FILES_AND_DIRECTORIES

public static final int FILES_AND_DIRECTORIES
Instruction to display both files and directories.

CANCEL_SELECTION

public static final String CANCEL_SELECTION
Instruction to cancel the current selection.

APPROVE_SELECTION

public static final String APPROVE_SELECTION
Instruction to approve the current selection (same as pressing yes or ok).

APPROVE_BUTTON_TEXT_CHANGED_PROPERTY

public static final String APPROVE_BUTTON_TEXT_CHANGED_PROPERTY
Identifies change in the text on the approve (yes, ok) button.

APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY

public static final String APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY
Identifies change in the tooltip text for the approve (yes, ok) button.

APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY

public static final String APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY
Identifies change in the mnemonic for the approve (yes, ok) button.

CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY

public static final String CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY
Instruction to display the control buttons.

DIRECTORY_CHANGED_PROPERTY

public static final String DIRECTORY_CHANGED_PROPERTY
Identifies user's directory change.

SELECTED_FILE_CHANGED_PROPERTY

public static final String SELECTED_FILE_CHANGED_PROPERTY
Identifies change in user's single-file selection.

SELECTED_FILES_CHANGED_PROPERTY

public static final String SELECTED_FILES_CHANGED_PROPERTY
Identifies change in user's multiple-file selection.

MULTI_SELECTION_ENABLED_CHANGED_PROPERTY

public static final String MULTI_SELECTION_ENABLED_CHANGED_PROPERTY
Enables multiple-file selections.

FILE_SYSTEM_VIEW_CHANGED_PROPERTY

public static final String FILE_SYSTEM_VIEW_CHANGED_PROPERTY
Says that a different object is being used to find available drives on the system.

FILE_VIEW_CHANGED_PROPERTY

public static final String FILE_VIEW_CHANGED_PROPERTY
Says that a different object is being used to retrieve file information.

FILE_HIDING_CHANGED_PROPERTY

public static final String FILE_HIDING_CHANGED_PROPERTY
Identifies a change in the display-hidden-files property.

FILE_FILTER_CHANGED_PROPERTY

public static final String FILE_FILTER_CHANGED_PROPERTY
User changed the kind of files to display.

FILE_SELECTION_MODE_CHANGED_PROPERTY

public static final String FILE_SELECTION_MODE_CHANGED_PROPERTY
Identifies a change in the kind of selection (single, multiple, etc.).

ACCESSORY_CHANGED_PROPERTY

public static final String ACCESSORY_CHANGED_PROPERTY
Says that a different accessory component is in use (for example, to preview files).

ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY

public static final String ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY
Identifies whether a the AcceptAllFileFilter is used or not.

DIALOG_TITLE_CHANGED_PROPERTY

public static final String DIALOG_TITLE_CHANGED_PROPERTY
Identifies a change in the dialog title.

DIALOG_TYPE_CHANGED_PROPERTY

public static final String DIALOG_TYPE_CHANGED_PROPERTY
Identifies a change in the type of files displayed (files only, directories only, or both files and directories).

CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY

public static final String CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY
Identifies a change in the list of predefined file filters the user can choose from.

accessibleContext

protected AccessibleContext accessibleContext
Constructor Detail

JFileChooser

public JFileChooser()
Constructs a JFileChooser pointing to the user's home directory.

JFileChooser

public JFileChooser(String currentDirectoryPath)
Constructs a JFileChooser using the given path. Passing in a null string causes the file chooser to point to the user's home directory.
Parameters:
currentDirectoryPath - a String giving the path to a file or directory

JFileChooser

public JFileChooser(File currentDirectory)
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 home directory.
Parameters:
currentDirectory - a File object specifying the path to a file or directory

JFileChooser

public JFileChooser(FileSystemView fsv)
Constructs a JFileChooser using the given FileSystemView.

JFileChooser

public JFileChooser(File currentDirectory,
                    FileSystemView fsv)
Constructs a JFileChooser using the given current directory and FileSystemView.

JFileChooser

public JFileChooser(String currentDirectoryPath,
                    FileSystemView fsv)
Constructs a JFileChooser using the given current directory path and FileSystemView.
Method Detail

setup

protected void setup(FileSystemView view)
Performs common constructor initialization and setup.

getSelectedFile

public File getSelectedFile()
Returns the selected file. This can be set either by the programmer via setFile 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

public void setSelectedFile(File file)
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

public File[] getSelectedFiles()
Returns a list of selected files if the file chooser is set to allow multiple selection.

setSelectedFiles

public void setSelectedFiles(File[] selectedFiles)
Sets the list of selected files if the file chooser is set to allow multiple selection.

getCurrentDirectory

public File getCurrentDirectory()
Returns the current directory.
Returns:
the current directory
See Also:
setCurrentDirectory(java.io.File)

setCurrentDirectory

public void setCurrentDirectory(File dir)
Sets the current directory. Passing in null sets the file chooser to point to the user's home directory. 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.
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

public void ensureFileIsVisible(File f)
Makes sure that the specified file is viewable, and not hidden.
Parameters:
f - a File object

showOpenDialog

public int showOpenDialog(Component parent)
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 be null; see showDialog 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
See Also:
showDialog(java.awt.Component, java.lang.String)

showSaveDialog

public int showSaveDialog(Component parent)
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 be null; see showDialog 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
See Also:
showDialog(java.awt.Component, java.lang.String)

showDialog

public int showDialog(Component parent,
                      String approveButtonText)
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.

Parameters:
parent - the parent component of the dialog; can be null
approveButtonText - the text of the ApproveButton
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

getControlButtonsAreShown

public boolean getControlButtonsAreShown()
Returns a boolean indicating whether the accept and cancel buttons are shown in the file chooser.
Returns:
true if the accept & cancel buttons are shown; otherwise, false
Since:
1.3
See Also:
setControlButtonsAreShown(boolean)

setControlButtonsAreShown

public void setControlButtonsAreShown(boolean b)
Sets whether the approve and cancel buttons are shown in the file chooser.
Since:
1.3
See Also:
getControlButtonsAreShown()

getDialogType

public int getDialogType()
Returns the type of this dialog. The default is JFileChooser.OPEN_DIALOG.
Returns:
the type of dialog to be displayed:
  • JFileChooser.OPEN_DIALOG
  • JFileChooser.SAVE_DIALOG
  • JFileChooser.CUSTOM_DIALOG
See Also:
setDialogType(int)

setDialogType

public void setDialogType(int dialogType)
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.
Parameters:
dialogType - the type of dialog to be displayed:
  • JFileChooser.OPEN_DIALOG
  • JFileChooser.SAVE_DIALOG
  • JFileChooser.CUSTOM_DIALOG
Throws:
IllegalArgumentException - if dialogType is not legal
See Also:
getDialogType(), setApproveButtonText(java.lang.String)

setDialogTitle

public void setDialogTitle(String dialogTitle)
Sets the string that goes in the JFileChooser window's title bar.
Parameters:
dialogTitle - the new String for the title bar
See Also:
getDialogTitle()

getDialogTitle

public String getDialogTitle()
Gets the string that goes in the JFileChooser's titlebar.
See Also:
setDialogTitle(java.lang.String)

setApproveButtonToolTipText

public void setApproveButtonToolTipText(String toolTipText)
Sets the tooltip text used in the ApproveButton. If null, the UI object will determine the button's text.
Returns:
the text used in the ApproveButton
See Also:
setApproveButtonText(java.lang.String), setDialogType(int), showDialog(java.awt.Component, java.lang.String)

getApproveButtonToolTipText

public String getApproveButtonToolTipText()
Returns the tooltip text used in the ApproveButton. If null, the UI object will determine the button's text.
Returns:
the text used in the ApproveButton
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

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

public void setApproveButtonText(String approveButtonText)
Sets the text used in the ApproveButton in the FileChooserUI.
Parameters:
approveButtonText - the text used in the ApproveButton
See Also:
getApproveButtonText(), setDialogType(int), showDialog(java.awt.Component, java.lang.String)

getApproveButtonText

public String getApproveButtonText()
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".
Returns:
the text used in the ApproveButton
See Also:
setApproveButtonText(java.lang.String), setDialogType(int), showDialog(java.awt.Component, java.lang.String)

getChoosableFileFilters

public FileFilter[] getChoosableFileFilters()
Gets the list of user choosable file filters.
Returns:
a FileFilter array containing all the choosable file filters

addChoosableFileFilter

public void addChoosableFileFilter(FileFilter filter)
Adds a filter to the list of user choosable file filters.
Parameters:
filter - the FileFilter to add to the choosable file filter list

removeChoosableFileFilter

public boolean removeChoosableFileFilter(FileFilter f)
Removes a filter from the list of user choosable file filters. Returns true if the file filter was removed.

resetChoosableFileFilters

public void resetChoosableFileFilters()
Resets the choosable file filter list to its starting state. Normally, this removes all added file filters while leaving the AcceptAll file filter.
See Also:
addChoosableFileFilter(javax.swing.filechooser.FileFilter), getChoosableFileFilters(), removeChoosableFileFilter(javax.swing.filechooser.FileFilter)

getAcceptAllFileFilter

public FileFilter getAcceptAllFileFilter()
Returns the AcceptAll file filter. For example, on Win32 this would be All Files (*.*).

isAcceptAllFileFilterUsed

public boolean isAcceptAllFileFilterUsed()
Returns whether the AcceptAll FileFilter is used.
Returns:
true if the AcceptAll FileFilter is used
Since:
1.3
See Also:
setAcceptAllFileFilterUsed(boolean)

setAcceptAllFileFilterUsed

public void setAcceptAllFileFilterUsed(boolean b)
Determines if the AcceptAll FileFilter is used.
Since:
1.3
See Also:
isAcceptAllFileFilterUsed()

getAccessory

public JComponent getAccessory()
Returns the accessory component.
Returns:
this JFileChooser's accessory component, or null
See Also:
setAccessory(javax.swing.JComponent)

setAccessory

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.


setFileSelectionMode

public void setFileSelectionMode(int mode)
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.
Parameters:
mode - the type of files to be displayed:
  • JFileChooser.FILES_ONLY
  • JFileChooser.DIRECTORIES_ONLY
  • JFileChooser.FILES_AND_DIRECTORIES
Throws:
IllegalArgumentException - if mode is an illegal Dialog mode
See Also:
getFileSelectionMode()

getFileSelectionMode

public int getFileSelectionMode()
Returns the current file-selection mode. The default is JFilesChooser.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

public boolean isFileSelectionEnabled()
Convenience call that determines if files are selectable based on the current file selection mode.
See Also:
setFileSelectionMode(int), getFileSelectionMode()

isDirectorySelectionEnabled

public boolean isDirectorySelectionEnabled()
Convenience call that determines if directories are selectable based on the current file selection mode.
See Also:
setFileSelectionMode(int), getFileSelectionMode()

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean b)
Sets the file chooser to allow multiple file selections.

NOTE: this functionality is not yet implemented in the current L&Fs.

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

public void setFileHidingEnabled(boolean b)
Sets file hiding on or off. If true, hidden files are not shown in the file chooser. The job of determining which files are shown is done by the FileView.
Parameters:
b - the boolean value that determines whether file hiding is turned on
See Also:
isFileHidingEnabled()

setFileFilter

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

public FileFilter 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

public 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.
See Also:
getFileView()

getFileView

public FileView getFileView()
Returns the current file view.
See Also:
setFileView(javax.swing.filechooser.FileView)

getName

public String getName(File f)
Returns the filename.
Parameters:
f - the File
Returns:
the String containing the filename for f
See Also:
FileView.getName(java.io.File)

getDescription

public String getDescription(File f)
Returns the file description.
Parameters:
f - the File
Returns:
the String containing the file description for f
See Also:
FileView.getDescription(java.io.File)

getTypeDescription

public String getTypeDescription(File f)
Returns the file type.
Parameters:
f - the File
Returns:
the String containing the file type description for f
See Also:
FileView.getTypeDescription(java.io.File)

getIcon

public Icon getIcon(File f)
Returns the icon for this file or type of file, depending on the system.
Parameters:
f - the File
Returns:
the Icon for this file, or type of file
See Also:
FileView.getIcon(java.io.File)

isTraversable

public boolean isTraversable(File f)
Returns true if the file (directory) can be visited. Returns false if the directory cannot be traversed.
Parameters:
f - the File
Returns:
true if the file/directory can be traversed, otherwise false
See Also:
FileView.isTraversable(java.io.File)

accept

public boolean accept(File f)
Returns true if the file should be displayed.
Parameters:
f - the File
Returns:
true if the file should be displayed, otherwise false
See Also:
FileFilter.accept(java.io.File)

setFileSystemView

public 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.
Parameters:
fsv - the new FileSystemView
See Also:
FileSystemView

getFileSystemView

public 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.

cancelSelection

public void cancelSelection()
Called by the UI when the user chooses the Cancel button. This can also be called by the programmer.

addActionListener

public void addActionListener(ActionListener l)
Adds an ActionListener to the button.
Parameters:
l - the listener to be added

removeActionListener

public void removeActionListener(ActionListener l)
Removes an ActionListener from the button.
Parameters:
l - the listener to be removed

fireActionPerformed

protected void fireActionPerformed(String command)
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.
See Also:
EventListenerList

updateUI

public void updateUI()
Notification from the UIFactory that the L&F has changed.
Overrides:
updateUI in class JComponent
See Also:
JComponent.updateUI()

getUIClassID

public String getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component.
Overrides:
getUIClassID in class JComponent
Returns:
the string "FileChooserUI"
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getUI

public FileChooserUI getUI()
Gets the UI object which implements the L&F for this component.
Returns:
the FileChooserUI object that implements the FileChooserUI L&F

paramString

protected String paramString()
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.
Overrides:
paramString in class JComponent
Returns:
a string representation of this JFileChooser

getAccessibleContext

public AccessibleContext 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 interface Accessible
Overrides:
getAccessibleContext in class JComponent
Returns:
an AccessibleJFileChooser that serves as the AccessibleContext of this JFileChooser

JavaTM 2 Platform
Std. Ed. v1.3.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.



Spec-Zone.ru - all specs in one place



free hit counter