JFileChooser.java revision 625
0N/A * Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 0N/A * published by the Free Software Foundation. Sun designates this 0N/A * particular file as subject to the "Classpath" exception as provided 0N/A * by Sun in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 0N/A * CA 95054 USA or visit www.sun.com if you need additional information or 0N/A * have any questions. 0N/A * <code>JFileChooser</code> provides a simple mechanism for the user to 0N/A * For information about using <code>JFileChooser</code>, see 0N/A * a section in <em>The Java Tutorial</em>. 0N/A * The following code pops up a file chooser for the user's home directory that 0N/A * sees only .jpg and .gif images: 0N/A * JFileChooser chooser = new JFileChooser(); 0N/A * FileNameExtensionFilter filter = new FileNameExtensionFilter( 0N/A * "JPG & GIF Images", "jpg", "gif"); 0N/A * chooser.setFileFilter(filter); 0N/A * int returnVal = chooser.showOpenDialog(parent); 0N/A * if(returnVal == JFileChooser.APPROVE_OPTION) { 0N/A * System.out.println("You chose to open this file: " + 0N/A * chooser.getSelectedFile().getName()); 0N/A * <strong>Warning:</strong> Swing is not thread safe. For more 0N/A * information see <a 0N/A * attribute: isContainer false 0N/A * description: A component which allows for the interactive selection of a file. 0N/A * @author Jeff Dinkins 0N/A * @see #getUIClassID 0N/A // ************************ 0N/A // ***** Dialog Types ***** 0N/A // ************************ 0N/A * Type value indicating that the <code>JFileChooser</code> supports an 0N/A * "Open" file operation. 0N/A * Type value indicating that the <code>JFileChooser</code> supports a 0N/A * "Save" file operation. 0N/A * Type value indicating that the <code>JFileChooser</code> supports a 0N/A * developer-specified file operation. 0N/A // ******************************** 0N/A // ***** Dialog Return Values ***** 0N/A // ******************************** 0N/A * Return value if cancel is chosen. 0N/A * Return value if approve (yes, ok) is chosen. 0N/A * Return value if an error occured. 0N/A // ********************************** 0N/A // ***** JFileChooser properties ***** 0N/A // ********************************** 0N/A /** Instruction to display only files. */ 0N/A /** Instruction to display only directories. */ 0N/A /** Instruction to display both files and directories. */ 0N/A /** Instruction to cancel the current selection. */ 0N/A * Instruction to approve the current selection 0N/A * (same as pressing yes or ok). 0N/A /** Identifies change in the text on the approve (yes, ok) button. */ 0N/A * Identifies change in the tooltip text for the approve (yes, ok) 0N/A /** Identifies change in the mnemonic for the approve (yes, ok) button. */ 0N/A /** Instruction to display the control buttons. */ 0N/A /** Identifies user's directory change. */ 0N/A /** Identifies change in user's single-file selection. */ 0N/A /** Identifies change in user's multiple-file selection. */ 0N/A /** Enables multiple-file selections. */ 0N/A * Says that a different object is being used to find available drives 0N/A * Says that a different object is being used to retrieve file 0N/A /** Identifies a change in the display-hidden-files property. */ 0N/A /** User changed the kind of files to display. */ 0N/A * Identifies a change in the kind of selection (single, 0N/A * Says that a different accessory component is in use 0N/A * (for example, to preview files). 0N/A * Identifies whether a the AcceptAllFileFilter is used or not. 0N/A /** Identifies a change in the dialog title. */ 0N/A * Identifies a change in the type of files displayed (files only, 0N/A * directories only, or both files and directories). 0N/A * Identifies a change in the list of predefined file filters 0N/A * the user can choose from. // ****************************** // ***** instance variables ***** // ****************************** // uiFileView is not serialized, as it is initialized // by updateUI() after deserialization // Listens to changes in the native setting for showing hidden files. // The Listener is removed and the native setting is ignored if // setFileHidingEnabled() is ever called. // ************************************* // ***** JFileChooser Constructors ***** // ************************************* * Constructs a <code>JFileChooser</code> 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 <code>JFileChooser</code> using the given path. * Passing in a <code>null</code> * 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. * @param currentDirectoryPath a <code>String</code> giving the path * Constructs a <code>JFileChooser</code> using the given <code>File</code> * as the path. Passing in a <code>null</code> 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. * @param currentDirectory a <code>File</code> object specifying * the path to a file or directory * Constructs a <code>JFileChooser</code> using the given * <code>FileSystemView</code>. * Constructs a <code>JFileChooser</code> using the given current directory * and <code>FileSystemView</code>. * Constructs a <code>JFileChooser</code> using the given current directory * path and <code>FileSystemView</code>. * Performs common constructor initialization and setup. // Track native setting for showing hidden files * Sets the <code>dragEnabled</code> property, * which must be <code>true</code> to enable * automatic drag handling (the first part of drag and drop) * The <code>transferHandler</code> property needs to be set * to a non-<code>null</code> value for the drag to do * anything. The default value of the <code>dragEnabled</code> * 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 <code>true</code> * can therefore have a subtle effect on * 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 <code>exportAsDrag</code> method of a * <code>TransferHandler</code>. * @param b the value to set the <code>dragEnabled</code> property to * @exception HeadlessException if * <code>b</code> is <code>true</code> and * <code>GraphicsEnvironment.isHeadless()</code> * returns <code>true</code> * @see java.awt.GraphicsEnvironment#isHeadless * @see #setTransferHandler * description: determines whether automatic drag handling is enabled * Gets the value of the <code>dragEnabled</code> property. * @return the value of the <code>dragEnabled</code> property // ***************************** // ****** File Operations ****** // ***************************** * Returns the selected file. This can be set either by the * programmer via <code>setSelectedFile</code> or by a user action, such as * either typing the filename into the UI or selecting the * file from a list in the UI. * @return the selected 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. * @param file the selected file * Returns a list of selected files if the file chooser is * set to allow multiple selection. * Sets the list of selected files if the file chooser is * set to allow multiple selection. * description: The list of selected files if the chooser is in multiple selection mode. * Returns the current directory. * @return the current directory * @see #setCurrentDirectory * Sets the current directory. Passing in <code>null</code> 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 <code>currentDirectory</code> 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 * description: The directory that the JFileChooser is showing files of. * @param dir the current directory to point to * @see #getCurrentDirectory /* Verify the toString of object */ * Changes the directory to be set to the parent of the * @see #getCurrentDirectory * Tells the UI to rescan its files list from the current directory. * Makes sure that the specified file is viewable, and // ************************************** // ***** JFileChooser Dialog methods ***** // ************************************** * Pops up an "Open File" file chooser dialog. Note that the * text that appears in the approve button is determined by * @param parent the parent component of the dialog, * can be <code>null</code>; * see <code>showDialog</code> for details * @return the return state of the file chooser on popdown: * <li>JFileChooser.CANCEL_OPTION * <li>JFileChooser.APPROVE_OPTION * <li>JFileChooser.ERROR_OPTION if an error occurs or the * @exception HeadlessException if GraphicsEnvironment.isHeadless() * @see java.awt.GraphicsEnvironment#isHeadless * Pops up a "Save File" file chooser dialog. Note that the * text that appears in the approve button is determined by * @param parent the parent component of the dialog, * can be <code>null</code>; * see <code>showDialog</code> for details * @return the return state of the file chooser on popdown: * <li>JFileChooser.CANCEL_OPTION * <li>JFileChooser.APPROVE_OPTION * <li>JFileChooser.ERROR_OPTION if an error occurs or the * @exception HeadlessException if GraphicsEnvironment.isHeadless() * @see java.awt.GraphicsEnvironment#isHeadless * 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); * <!--PENDING(jeff) - the following method should be added to the api: * showDialog(Component parent);--> * <!--PENDING(kwalrath) - should specify modality and what * The <code>parent</code> 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 <code>Frame</code> object (such as a <code>JFrame</code>) * 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 <code>null</code>, 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. * @param parent the parent component of the dialog; * can be <code>null</code> * @param approveButtonText the text of the <code>ApproveButton</code> * @return the return state of the file chooser on popdown: * <li>JFileChooser.CANCEL_OPTION * <li>JFileChooser.APPROVE_OPTION * <li>JFileCHooser.ERROR_OPTION if an error occurs or the * @exception HeadlessException if GraphicsEnvironment.isHeadless() * @see java.awt.GraphicsEnvironment#isHeadless * Creates and returns a new <code>JDialog</code> wrapping * <code>this</code> centered on the <code>parent</code> * in the <code>parent</code>'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); * @param parent the parent component of the dialog; * can be <code>null</code> * @return a new <code>JDialog</code> containing this instance * @exception HeadlessException if GraphicsEnvironment.isHeadless() * @see java.awt.GraphicsEnvironment#isHeadless // ************************** // ***** Dialog Options ***** // ************************** * Returns the value of the <code>controlButtonsAreShown</code> * @return the value of the <code>controlButtonsAreShown</code> * @see #setControlButtonsAreShown * that indicates whether the <i>approve</i> and <i>cancel</i> * buttons are shown in the file chooser. This property * is <code>true</code> by default. Look and feels * that always show these buttons will ignore the value * This method fires a property-changed event, * using the string value of * <code>CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY</code> * as the name of the property. * @param b <code>false</code> if control buttons should not be * shown; otherwise, <code>true</code> * description: Sets whether the approve & cancel buttons are shown. * @see #getControlButtonsAreShown * @see #CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY * Returns the type of this dialog. The default is * <code>JFileChooser.OPEN_DIALOG</code>. * @return the type of dialog to be displayed: * <li>JFileChooser.OPEN_DIALOG * <li>JFileChooser.SAVE_DIALOG * <li>JFileChooser.CUSTOM_DIALOG * Sets the type of this dialog. Use <code>OPEN_DIALOG</code> when you * want to bring up a file chooser that the user can use to open a file. * Likewise, use <code>SAVE_DIALOG</code> for letting the user choose * Use <code>CUSTOM_DIALOG</code> 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 <code>JFileChooser</code> to use * <code>CUSTOM_DIALOG</code> * since a call to <code>setApproveButtonText</code> does this for you. * The default dialog type is <code>JFileChooser.OPEN_DIALOG</code>. * @param dialogType the type of dialog to be displayed: * <li>JFileChooser.OPEN_DIALOG * <li>JFileChooser.SAVE_DIALOG * <li>JFileChooser.CUSTOM_DIALOG * @exception IllegalArgumentException if <code>dialogType</code> is * description: The type (open, save, custom) of the JFileChooser. * OPEN_DIALOG JFileChooser.OPEN_DIALOG * SAVE_DIALOG JFileChooser.SAVE_DIALOG * CUSTOM_DIALOG JFileChooser.CUSTOM_DIALOG * @see #setApproveButtonText // PENDING(jeff) - fire button text change property * Sets the string that goes in the <code>JFileChooser</code> window's * @param dialogTitle the new <code>String</code> for the title bar * description: The title of the JFileChooser dialog window. * Gets the string that goes in the <code>JFileChooser</code>'s titlebar. // ************************************ // ***** JFileChooser View Options ***** // ************************************ * Sets the tooltip text used in the <code>ApproveButton</code>. * If <code>null</code>, the UI object will determine the button's text. * description: The tooltip text for the ApproveButton. * @param toolTipText the tooltip text for the approve button * @see #setApproveButtonText * Returns the tooltip text used in the <code>ApproveButton</code>. * If <code>null</code>, the UI object will determine the button's text. * @return the tooltip text used for the approve button * @see #setApproveButtonText * Returns the approve button's mnemonic. * @return an integer value for the mnemonic key * @see #setApproveButtonMnemonic * Sets the approve button's mnemonic using a numeric keycode. * @param mnemonic an integer value for the mnemonic key * description: The mnemonic key accelerator for the ApproveButton. * @see #getApproveButtonMnemonic * Sets the approve button's mnemonic using a character. * @param mnemonic a character value for the mnemonic key * @see #getApproveButtonMnemonic if(
vk >=
'a' &&
vk <=
'z') {
* Sets the text used in the <code>ApproveButton</code> in the * <code>FileChooserUI</code>. * description: The text that goes in the ApproveButton. * @param approveButtonText the text used in the <code>ApproveButton</code> * @see #getApproveButtonText // PENDING(jeff) - have ui set this on dialog type change * Returns the text used in the <code>ApproveButton</code> in the * <code>FileChooserUI</code>. * If <code>null</code>, the UI object will determine the button's text. * Typically, this would be "Open" or "Save". * @return the text used in the <code>ApproveButton</code> * @see #setApproveButtonText * Gets the list of user choosable file filters. * @return a <code>FileFilter</code> array containing all the choosable * @see #addChoosableFileFilter * @see #removeChoosableFileFilter * @see #resetChoosableFileFilters * Adds a filter to the list of user choosable file filters. * For information on setting the file selection mode, see * {@link #setFileSelectionMode setFileSelectionMode}. * @param filter the <code>FileFilter</code> to add to the choosable file * description: Adds a filter to the list of user choosable file filters. * @see #getChoosableFileFilters * @see #removeChoosableFileFilter * @see #resetChoosableFileFilters * @see #setFileSelectionMode * Removes a filter from the list of user choosable file filters. Returns * true if the file filter was removed. * @see #addChoosableFileFilter * @see #getChoosableFileFilters * @see #resetChoosableFileFilters * Resets the choosable file filter list to its starting state. Normally, * this removes all added file filters while leaving the * <code>AcceptAll</code> file filter. * @see #addChoosableFileFilter * @see #getChoosableFileFilters * @see #removeChoosableFileFilter * Returns the <code>AcceptAll</code> file filter. * For example, on Microsoft Windows this would be All Files (*.*). * Returns whether the <code>AcceptAll FileFilter</code> is used. * @return true if the <code>AcceptAll FileFilter</code> is used * @see #setAcceptAllFileFilterUsed * Determines whether the <code>AcceptAll FileFilter</code> is used * as an available choice in the choosable filter list. * If false, the <code>AcceptAll</code> file filter is removed from * the list of available file filters. * If true, the <code>AcceptAll</code> file filter will become the * the actively used file filter. * description: Sets whether the AcceptAll FileFilter is used as an available choice in the choosable filter list. * @see #isAcceptAllFileFilterUsed * @see #getAcceptAllFileFilter * Returns the accessory component. * @return this JFileChooser's accessory component, or null * 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 * description: Sets the accessory component on the JFileChooser. * Sets the <code>JFileChooser</code> to allow the user to just * select files, just select * directories, or select both files and directories. The default is * <code>JFilesChooser.FILES_ONLY</code>. * @param mode the type of files to be displayed: * <li>JFileChooser.FILES_ONLY * <li>JFileChooser.DIRECTORIES_ONLY * <li>JFileChooser.FILES_AND_DIRECTORIES * @exception IllegalArgumentException if <code>mode</code> is an * illegal file selection mode * description: Sets the types of files that the JFileChooser can choose. * enum: FILES_ONLY JFileChooser.FILES_ONLY * DIRECTORIES_ONLY JFileChooser.DIRECTORIES_ONLY * FILES_AND_DIRECTORIES JFileChooser.FILES_AND_DIRECTORIES * @see #getFileSelectionMode * Returns the current file-selection mode. The default is * <code>JFilesChooser.FILES_ONLY</code>. * @return the type of files to be displayed, one of the following: * <li>JFileChooser.FILES_ONLY * <li>JFileChooser.DIRECTORIES_ONLY * <li>JFileChooser.FILES_AND_DIRECTORIES * @see #setFileSelectionMode * Convenience call that determines if files are selectable based on the * current file selection mode. * @see #setFileSelectionMode * @see #getFileSelectionMode * Convenience call that determines if directories are selectable based * on the current file selection mode. * @see #setFileSelectionMode * @see #getFileSelectionMode * Sets the file chooser to allow multiple file selections. * @param b true if multiple files may be selected * description: Sets multiple file selection mode. * @see #isMultiSelectionEnabled * Returns true if multiple files can be selected. * @return true if multiple files can be selected * @see #setMultiSelectionEnabled * Returns true if hidden files are not shown in the file chooser; * otherwise, returns false. * @return the status of the file hiding property * @see #setFileHidingEnabled * 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 <code>FileView</code>. * description: Sets file hiding on or off. * @param b the boolean value that determines whether file hiding is * @see #isFileHidingEnabled // Dump showFilesListener since we'll ignore it from now on * Sets the current file filter. The file filter is used by the * file chooser to filter out files from the user's view. * description: Sets the File Filter used to filter out files of type. * @param filter the new current file filter to use * Returns the currently selected file filter. * @return the current file filter * @see #addChoosableFileFilter * 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. * description: Sets the File View used to get file type information. * Returns the current file view. // ****************************** // *****FileView delegation ***** // ****************************** // NOTE: all of the following methods attempt to delegate // first to the client set fileView, and if <code>null</code> is returned // (or there is now client defined fileView) then calls the // UI's default fileView. * @param f the <code>File</code> * @return the <code>String</code> containing the filename for * Returns the file description. * @param f the <code>File</code> * @return the <code>String</code> containing the file description for * @see FileView#getDescription * @param f the <code>File</code> * @return the <code>String</code> containing the file type description for * @see FileView#getTypeDescription * Returns the icon for this file or type of file, depending * @param f the <code>File</code> * @return the <code>Icon</code> for this file, or type of file * Returns true if the file (directory) can be visited. * Returns false if the directory cannot be traversed. * @param f the <code>File</code> * @return true if the file/directory can be traversed, otherwise false * @see FileView#isTraversable * Returns true if the file should be displayed. * @param f the <code>File</code> * @return true if the file should be displayed, otherwise false * Sets the file system view that the <code>JFileChooser</code> uses for * accessing and creating file system resources, such as finding * the floppy drive and getting a list of root drives. * @param fsv the new <code>FileSystemView</code> * description: Sets the FileSytemView used to get filesystem information. * Returns the file system view. * @return the <code>FileSystemView</code> object * @see #setFileSystemView // ************************** // ***** Event Handling ***** // ************************** * 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 * <code>APPROVE_SELECTION</code>. * @see #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 * <code>CANCEL_SELECTION</code>. * Adds an <code>ActionListener</code> to the file chooser. * @param l the listener to be added * Removes an <code>ActionListener</code> from the file chooser. * @param l the listener to be removed * @see #addActionListener * Returns an array of all the action listeners * registered on this file chooser. * @return all of this file chooser's <code>ActionListener</code>s * array if no action listeners are currently registered * @see #addActionListener * @see #removeActionListener * Notifies all listeners that have registered interest for * notification on this event type. The event instance * is lazily created using the <code>command</code> parameter. // Guaranteed to return a non-null array // Process the listeners last to first, notifying // those that are interested in this event // Lazily create the event: // Our JFileChooser is no longer around, so we no longer need to // listen for PropertyChangeEvents. // ********************************* // ***** Pluggable L&F methods ***** // ********************************* * Resets the UI property to a value from the current look and feel. * @see JComponent#updateUI // We were probably deserialized * Returns a string that specifies the name of the L&F class * that renders this component. * @return the string "FileChooserUI" * @see JComponent#getUIClassID * description: A string that specifies the name of the L&F class. * Gets the UI object which implements the L&F for this component. * @return the FileChooserUI object that implements the FileChooserUI L&F * See <code>readObject</code> and <code>writeObject</code> in * <code>JComponent</code> for more * information about serialization in Swing. * See <code>readObject</code> and <code>writeObject</code> in * <code>JComponent</code> for more * information about serialization in Swing. //The AcceptAllFileFilter is UI specific, it will be reset by //updateUI() after deserialization //The default FileSystemView is platform specific, it will be //reset by updateUI() after deserialization * Returns a string representation of this <code>JFileChooser</code>. * 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 * @return a string representation of this <code>JFileChooser</code> * 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. * @return an AccessibleJFileChooser that serves as the * AccessibleContext of this JFileChooser * This class implements accessibility support for the * <code>JFileChooser</code> class. It provides an implementation of the * Java Accessibility API appropriate to file chooser user-interface * Gets the role of this object. * @return an instance of AccessibleRole describing the role of the }
// inner class AccessibleJFileChooser