/*
 * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.swing.plaf.basic;

import javax.swing.*;
import javax.swing.filechooser.*;
import javax.swing.filechooser.FileFilter;
import javax.swing.event.*;
import javax.swing.plaf.*;
import java.awt.*;
import java.awt.event.*;
import java.awt.datatransfer.*;
import java.beans.*;
import java.io.*;
import java.util.*;
import java.util.List;
import java.util.regex.*;
import sun.awt.shell.ShellFolder;
import sun.swing.*;
import sun.swing.SwingUtilities2;

Basic L&F implementation of a FileChooser.
Author:Jeff Dinkins
/** * Basic L&F implementation of a FileChooser. * * @author Jeff Dinkins */
public class BasicFileChooserUI extends FileChooserUI { /* FileView icons */
Directory icon
/** Directory icon */
protected Icon directoryIcon = null;
File icon
/** File icon */
protected Icon fileIcon = null;
Computer icon
/** Computer icon */
protected Icon computerIcon = null;
Hard drive icon
/** Hard drive icon */
protected Icon hardDriveIcon = null;
Floppy drive icon
/** Floppy drive icon */
protected Icon floppyDriveIcon = null;
New folder icon
/** New folder icon */
protected Icon newFolderIcon = null;
Up folder icon
/** Up folder icon */
protected Icon upFolderIcon = null;
Home folder icon
/** Home folder icon */
protected Icon homeFolderIcon = null;
List view icon
/** List view icon */
protected Icon listViewIcon = null;
Details view icon
/** Details view icon */
protected Icon detailsViewIcon = null;
View menu icon
/** View menu icon */
protected Icon viewMenuIcon = null;
Save button mnemonic
/** Save button mnemonic */
protected int saveButtonMnemonic = 0;
Open button mnemonic
/** Open button mnemonic */
protected int openButtonMnemonic = 0;
Cancel button mnemonic
/** Cancel button mnemonic */
protected int cancelButtonMnemonic = 0;
Update button mnemonic
/** Update button mnemonic */
protected int updateButtonMnemonic = 0;
Help button mnemonic
/** Help button mnemonic */
protected int helpButtonMnemonic = 0;
The mnemonic keycode used for the approve button when a directory is selected and the current selection mode is FILES_ONLY.
Since:1.4
/** * The mnemonic keycode used for the approve button when a directory * is selected and the current selection mode is FILES_ONLY. * * @since 1.4 */
protected int directoryOpenButtonMnemonic = 0;
Save button text
/** Save button text */
protected String saveButtonText = null;
Open button text
/** Open button text */
protected String openButtonText = null;
Cancel button text
/** Cancel button text */
protected String cancelButtonText = null;
Update button text
/** Update button text */
protected String updateButtonText = null;
Help button text
/** Help button text */
protected String helpButtonText = null;
The label text displayed on the approve button when a directory is selected and the current selection mode is FILES_ONLY.
Since:1.4
/** * The label text displayed on the approve button when a directory * is selected and the current selection mode is FILES_ONLY. * * @since 1.4 */
protected String directoryOpenButtonText = null;
Open dialog title text
/** Open dialog title text */
private String openDialogTitleText = null;
Save dialog title text
/** Save dialog title text */
private String saveDialogTitleText = null;
Save button tool tip text
/** Save button tool tip text */
protected String saveButtonToolTipText = null;
Open button tool tip text
/** Open button tool tip text */
protected String openButtonToolTipText = null;
Cancel button tool tip text
/** Cancel button tool tip text */
protected String cancelButtonToolTipText = null;
Update button tool tip text
/** Update button tool tip text */
protected String updateButtonToolTipText = null;
Help button tool tip text
/** Help button tool tip text */
protected String helpButtonToolTipText = null;
The tooltip text displayed on the approve button when a directory is selected and the current selection mode is FILES_ONLY.
Since:1.4
/** * The tooltip text displayed on the approve button when a directory * is selected and the current selection mode is FILES_ONLY. * * @since 1.4 */
protected String directoryOpenButtonToolTipText = null; // Some generic FileChooser functions private Action approveSelectionAction = new ApproveSelectionAction(); private Action cancelSelectionAction = new CancelSelectionAction(); private Action updateAction = new UpdateAction(); private Action newFolderAction; private Action goHomeAction = new GoHomeAction(); private Action changeToParentDirectoryAction = new ChangeToParentDirectoryAction(); private String newFolderErrorSeparator = null; private String newFolderErrorText = null; private String newFolderParentDoesntExistTitleText = null; private String newFolderParentDoesntExistText = null; private String fileDescriptionText = null; private String directoryDescriptionText = null; private JFileChooser filechooser = null; private boolean directorySelected = false; private File directory = null; private PropertyChangeListener propertyChangeListener = null; private AcceptAllFileFilter acceptAllFileFilter = new AcceptAllFileFilter(); private FileFilter actualFileFilter = null; private GlobFilter globFilter = null; private BasicDirectoryModel model = null; private BasicFileView fileView = new BasicFileView(); private boolean usesSingleFilePane; private boolean readOnly; // The accessoryPanel is a container to place the JFileChooser accessory component private JPanel accessoryPanel = null; private Handler handler;
Creates a BasicFileChooserUI implementation for the specified component. By default the BasicLookAndFeel class uses createUI methods of all basic UIs classes to instantiate UIs.
Params:
  • c – the JFileChooser which needs a UI
See Also:
Returns:the BasicFileChooserUI object
Since:1.7
/** * Creates a {@code BasicFileChooserUI} implementation * for the specified component. By default * the {@code BasicLookAndFeel} class uses * {@code createUI} methods of all basic UIs classes * to instantiate UIs. * * @param c the {@code JFileChooser} which needs a UI * @return the {@code BasicFileChooserUI} object * * @see UIDefaults#getUI(JComponent) * @since 1.7 */
public static ComponentUI createUI(JComponent c) { return new BasicFileChooserUI((JFileChooser) c); }
Constructs a BasicFileChooserUI.
Params:
  • b – file chooser
/** * Constructs a {@code BasicFileChooserUI}. * @param b file chooser */
public BasicFileChooserUI(JFileChooser b) { }
Installs the UI.
Params:
  • c – the component
/** * Installs the UI. * @param c the component */
public void installUI(JComponent c) { accessoryPanel = new JPanel(new BorderLayout()); filechooser = (JFileChooser) c; createModel(); clearIconCache(); installDefaults(filechooser); installComponents(filechooser); installListeners(filechooser); filechooser.applyComponentOrientation(filechooser.getComponentOrientation()); }
Uninstalls the UI.
Params:
  • c – the component
/** * Uninstalls the UI. * @param c the component */
public void uninstallUI(JComponent c) { uninstallListeners(filechooser); uninstallComponents(filechooser); uninstallDefaults(filechooser); if(accessoryPanel != null) { accessoryPanel.removeAll(); } accessoryPanel = null; getFileChooser().removeAll(); handler = null; }
Installs the components.
Params:
  • fc – the file chooser
/** * Installs the components. * @param fc the file chooser */
public void installComponents(JFileChooser fc) { }
Uninstalls the components.
Params:
  • fc – the file chooser
/** * Uninstalls the components. * @param fc the file chooser */
public void uninstallComponents(JFileChooser fc) { }
Installs the listeners.
Params:
  • fc – the file chooser
/** * Installs the listeners. * @param fc the file chooser */
protected void installListeners(JFileChooser fc) { propertyChangeListener = createPropertyChangeListener(fc); if(propertyChangeListener != null) { fc.addPropertyChangeListener(propertyChangeListener); } fc.addPropertyChangeListener(getModel()); InputMap inputMap = getInputMap(JComponent. WHEN_ANCESTOR_OF_FOCUSED_COMPONENT); SwingUtilities.replaceUIInputMap(fc, JComponent. WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, inputMap); ActionMap actionMap = getActionMap(); SwingUtilities.replaceUIActionMap(fc, actionMap); } InputMap getInputMap(int condition) { if (condition == JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT) { return (InputMap)DefaultLookup.get(getFileChooser(), this, "FileChooser.ancestorInputMap"); } return null; } ActionMap getActionMap() { return createActionMap(); } ActionMap createActionMap() { ActionMap map = new ActionMapUIResource(); Action refreshAction = new UIAction(FilePane.ACTION_REFRESH) { public void actionPerformed(ActionEvent evt) { getFileChooser().rescanCurrentDirectory(); } }; map.put(FilePane.ACTION_APPROVE_SELECTION, getApproveSelectionAction()); map.put(FilePane.ACTION_CANCEL, getCancelSelectionAction()); map.put(FilePane.ACTION_REFRESH, refreshAction); map.put(FilePane.ACTION_CHANGE_TO_PARENT_DIRECTORY, getChangeToParentDirectoryAction()); return map; }
Uninstalls the listeners.
Params:
  • fc – the file chooser
/** * Uninstalls the listeners. * @param fc the file chooser */
protected void uninstallListeners(JFileChooser fc) { if(propertyChangeListener != null) { fc.removePropertyChangeListener(propertyChangeListener); } fc.removePropertyChangeListener(getModel()); SwingUtilities.replaceUIInputMap(fc, JComponent. WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, null); SwingUtilities.replaceUIActionMap(fc, null); }
Installs the defaults.
Params:
  • fc – the file chooser
/** * Installs the defaults. * @param fc the file chooser */
protected void installDefaults(JFileChooser fc) { installIcons(fc); installStrings(fc); usesSingleFilePane = UIManager.getBoolean("FileChooser.usesSingleFilePane"); readOnly = UIManager.getBoolean("FileChooser.readOnly"); TransferHandler th = fc.getTransferHandler(); if (th == null || th instanceof UIResource) { fc.setTransferHandler(defaultTransferHandler); } LookAndFeel.installProperty(fc, "opaque", Boolean.FALSE); }
Installs the icons.
Params:
  • fc – the file chooser
/** * Installs the icons. * @param fc the file chooser */
protected void installIcons(JFileChooser fc) { directoryIcon = UIManager.getIcon("FileView.directoryIcon"); fileIcon = UIManager.getIcon("FileView.fileIcon"); computerIcon = UIManager.getIcon("FileView.computerIcon"); hardDriveIcon = UIManager.getIcon("FileView.hardDriveIcon"); floppyDriveIcon = UIManager.getIcon("FileView.floppyDriveIcon"); newFolderIcon = UIManager.getIcon("FileChooser.newFolderIcon"); upFolderIcon = UIManager.getIcon("FileChooser.upFolderIcon"); homeFolderIcon = UIManager.getIcon("FileChooser.homeFolderIcon"); detailsViewIcon = UIManager.getIcon("FileChooser.detailsViewIcon"); listViewIcon = UIManager.getIcon("FileChooser.listViewIcon"); viewMenuIcon = UIManager.getIcon("FileChooser.viewMenuIcon"); }
Installs the strings.
Params:
  • fc – the file chooser
/** * Installs the strings. * @param fc the file chooser */
protected void installStrings(JFileChooser fc) { Locale l = fc.getLocale(); newFolderErrorText = UIManager.getString("FileChooser.newFolderErrorText",l); newFolderErrorSeparator = UIManager.getString("FileChooser.newFolderErrorSeparator",l); newFolderParentDoesntExistTitleText = UIManager.getString("FileChooser.newFolderParentDoesntExistTitleText", l); newFolderParentDoesntExistText = UIManager.getString("FileChooser.newFolderParentDoesntExistText", l); fileDescriptionText = UIManager.getString("FileChooser.fileDescriptionText",l); directoryDescriptionText = UIManager.getString("FileChooser.directoryDescriptionText",l); saveButtonText = UIManager.getString("FileChooser.saveButtonText",l); openButtonText = UIManager.getString("FileChooser.openButtonText",l); saveDialogTitleText = UIManager.getString("FileChooser.saveDialogTitleText",l); openDialogTitleText = UIManager.getString("FileChooser.openDialogTitleText",l); cancelButtonText = UIManager.getString("FileChooser.cancelButtonText",l); updateButtonText = UIManager.getString("FileChooser.updateButtonText",l); helpButtonText = UIManager.getString("FileChooser.helpButtonText",l); directoryOpenButtonText = UIManager.getString("FileChooser.directoryOpenButtonText",l); saveButtonMnemonic = getMnemonic("FileChooser.saveButtonMnemonic", l); openButtonMnemonic = getMnemonic("FileChooser.openButtonMnemonic", l); cancelButtonMnemonic = getMnemonic("FileChooser.cancelButtonMnemonic", l); updateButtonMnemonic = getMnemonic("FileChooser.updateButtonMnemonic", l); helpButtonMnemonic = getMnemonic("FileChooser.helpButtonMnemonic", l); directoryOpenButtonMnemonic = getMnemonic("FileChooser.directoryOpenButtonMnemonic", l); saveButtonToolTipText = UIManager.getString("FileChooser.saveButtonToolTipText",l); openButtonToolTipText = UIManager.getString("FileChooser.openButtonToolTipText",l); cancelButtonToolTipText = UIManager.getString("FileChooser.cancelButtonToolTipText",l); updateButtonToolTipText = UIManager.getString("FileChooser.updateButtonToolTipText",l); helpButtonToolTipText = UIManager.getString("FileChooser.helpButtonToolTipText",l); directoryOpenButtonToolTipText = UIManager.getString("FileChooser.directoryOpenButtonToolTipText",l); }
Uninstalls the defaults.
Params:
  • fc – the file chooser
/** * Uninstalls the defaults. * @param fc the file chooser */
protected void uninstallDefaults(JFileChooser fc) { uninstallIcons(fc); uninstallStrings(fc); if (fc.getTransferHandler() instanceof UIResource) { fc.setTransferHandler(null); } }
Uninstalls the icons.
Params:
  • fc – the file chooser
/** * Uninstalls the icons. * @param fc the file chooser */
protected void uninstallIcons(JFileChooser fc) { directoryIcon = null; fileIcon = null; computerIcon = null; hardDriveIcon = null; floppyDriveIcon = null; newFolderIcon = null; upFolderIcon = null; homeFolderIcon = null; detailsViewIcon = null; listViewIcon = null; viewMenuIcon = null; }
Uninstalls the strings.
Params:
  • fc – the file chooser
/** * Uninstalls the strings. * @param fc the file chooser */
protected void uninstallStrings(JFileChooser fc) { saveButtonText = null; openButtonText = null; cancelButtonText = null; updateButtonText = null; helpButtonText = null; directoryOpenButtonText = null; saveButtonToolTipText = null; openButtonToolTipText = null; cancelButtonToolTipText = null; updateButtonToolTipText = null; helpButtonToolTipText = null; directoryOpenButtonToolTipText = null; }
Creates the model.
/** * Creates the model. */
protected void createModel() { if (model != null) { model.invalidateFileCache(); } model = new BasicDirectoryModel(getFileChooser()); }
Returns the model.
Returns:the model
/** * Returns the model. * @return the model */
public BasicDirectoryModel getModel() { return model; }
Creates the property change listener.
Params:
  • fc – the file chooser
Returns:the property change listener
/** * Creates the property change listener. * @param fc the file chooser * @return the property change listener */
public PropertyChangeListener createPropertyChangeListener(JFileChooser fc) { return null; }
Returns the file name.
Returns:the file name
/** * Returns the file name. * @return the file name */
public String getFileName() { return null; }
Returns the directory name.
Returns:the directory name
/** * Returns the directory name. * @return the directory name */
public String getDirectoryName() { return null; }
Sets the file name.
Params:
  • filename – the file name
/** * Sets the file name. * @param filename the file name */
public void setFileName(String filename) { }
Sets the directory name.
Params:
  • dirname – the file name
/** * Sets the directory name. * @param dirname the file name */
public void setDirectoryName(String dirname) { }
{@inheritDoc}
/** * {@inheritDoc} */
public void rescanCurrentDirectory(JFileChooser fc) { }
{@inheritDoc}
/** * {@inheritDoc} */
public void ensureFileIsVisible(JFileChooser fc, File f) { }
Returns the file chooser.
Returns:the file chooser
/** * Returns the file chooser. * @return the file chooser */
public JFileChooser getFileChooser() { return filechooser; }
Returns the accessory panel.
Returns:the accessory panel
/** * Returns the accessory panel. * @return the accessory panel */
public JPanel getAccessoryPanel() { return accessoryPanel; }
Returns the approve button.
Params:
  • fc – the file chooser
Returns:the approve button
/** * Returns the approve button. * @param fc the file chooser * @return the approve button */
protected JButton getApproveButton(JFileChooser fc) { return null; }
{@inheritDoc}
/** * {@inheritDoc} */
public JButton getDefaultButton(JFileChooser fc) { return getApproveButton(fc); }
Returns the approve button tool tip.
Params:
  • fc – the file chooser
Returns:the approve button tool tip
/** * Returns the approve button tool tip. * @param fc the file chooser * @return the approve button tool tip */
public String getApproveButtonToolTipText(JFileChooser fc) { String tooltipText = fc.getApproveButtonToolTipText(); if(tooltipText != null) { return tooltipText; } if(fc.getDialogType() == JFileChooser.OPEN_DIALOG) { return openButtonToolTipText; } else if(fc.getDialogType() == JFileChooser.SAVE_DIALOG) { return saveButtonToolTipText; } return null; }
Clears the icon cache.
/** * Clears the icon cache. */
public void clearIconCache() { fileView.clearIconCache(); } // ******************************************** // ************ Create Listeners ************** // ******************************************** private Handler getHandler() { if (handler == null) { handler = new Handler(); } return handler; }
Creates a double click listener.
Params:
  • fc – the file chooser
  • list – the list
Returns:a double click listener
/** * Creates a double click listener. * @param fc the file chooser * @param list the list * @return a double click listener */
protected MouseListener createDoubleClickListener(JFileChooser fc, JList<?> list) { return new Handler(list); }
Creates a list selection listener.
Params:
  • fc – the file chooser
Returns:a list selection listener
/** * Creates a list selection listener. * @param fc the file chooser * @return a list selection listener */
public ListSelectionListener createListSelectionListener(JFileChooser fc) { return getHandler(); } private class Handler implements MouseListener, ListSelectionListener { JList<?> list; Handler() { } Handler(JList<?> list) { this.list = list; } public void mouseClicked(MouseEvent evt) { // Note: we can't depend on evt.getSource() because of backward // compatibility if (list != null && SwingUtilities.isLeftMouseButton(evt) && (evt.getClickCount()%2 == 0)) { int index = SwingUtilities2.loc2IndexFileList(list, evt.getPoint()); if (index >= 0) { File f = (File)list.getModel().getElementAt(index); try { // Strip trailing ".." f = ShellFolder.getNormalizedFile(f); } catch (IOException ex) { // That's ok, we'll use f as is } if(getFileChooser().isTraversable(f)) { list.clearSelection(); changeDirectory(f); } else { getFileChooser().approveSelection(); } } } } public void mouseEntered(MouseEvent evt) { if (list != null) { TransferHandler th1 = getFileChooser().getTransferHandler(); TransferHandler th2 = list.getTransferHandler(); if (th1 != th2) { list.setTransferHandler(th1); } if (getFileChooser().getDragEnabled() != list.getDragEnabled()) { list.setDragEnabled(getFileChooser().getDragEnabled()); } } } public void mouseExited(MouseEvent evt) { } public void mousePressed(MouseEvent evt) { } public void mouseReleased(MouseEvent evt) { } @SuppressWarnings("deprecation") public void valueChanged(ListSelectionEvent evt) { if(!evt.getValueIsAdjusting()) { JFileChooser chooser = getFileChooser(); FileSystemView fsv = chooser.getFileSystemView(); @SuppressWarnings("unchecked") JList<?> list = (JList)evt.getSource(); int fsm = chooser.getFileSelectionMode(); boolean useSetDirectory = usesSingleFilePane && (fsm == JFileChooser.FILES_ONLY); if (chooser.isMultiSelectionEnabled()) { File[] files = null; Object[] objects = list.getSelectedValues(); if (objects != null) { if (objects.length == 1 && ((File)objects[0]).isDirectory() && chooser.isTraversable(((File)objects[0])) && (useSetDirectory || !fsv.isFileSystem(((File)objects[0])))) { setDirectorySelected(true); setDirectory(((File)objects[0])); } else { ArrayList<File> fList = new ArrayList<File>(objects.length); for (Object object : objects) { File f = (File) object; boolean isDir = f.isDirectory(); if ((chooser.isFileSelectionEnabled() && !isDir) || (chooser.isDirectorySelectionEnabled() && fsv.isFileSystem(f) && isDir)) { fList.add(f); } } if (fList.size() > 0) { files = fList.toArray(new File[fList.size()]); } setDirectorySelected(false); } } chooser.setSelectedFiles(files); } else { File file = (File)list.getSelectedValue(); if (file != null && file.isDirectory() && chooser.isTraversable(file) && (useSetDirectory || !fsv.isFileSystem(file))) { setDirectorySelected(true); setDirectory(file); if (usesSingleFilePane) { chooser.setSelectedFile(null); } } else { setDirectorySelected(false); if (file != null) { chooser.setSelectedFile(file); } } } } } }
A double click listener.
/** * A double click listener. */
protected class DoubleClickListener extends MouseAdapter { // NOTE: This class exists only for backward compatibility. All // its functionality has been moved into Handler. If you need to add // new functionality add it to the Handler, but make sure this // class calls into the Handler. Handler handler;
Constucts a DoubleClickListener.
Params:
  • list – the lsit
/** * Constucts a {@code DoubleClickListener}. * @param list the lsit */
public DoubleClickListener(JList<?> list) { handler = new Handler(list); }
The JList used for representing the files is created by subclasses, but the selection is monitored in this class. The TransferHandler installed in the JFileChooser is also installed in the file list as it is used as the actual transfer source. The list is updated on a mouse enter to reflect the current data transfer state of the file chooser.
/** * The JList used for representing the files is created by subclasses, but the * selection is monitored in this class. The TransferHandler installed in the * JFileChooser is also installed in the file list as it is used as the actual * transfer source. The list is updated on a mouse enter to reflect the current * data transfer state of the file chooser. */
public void mouseEntered(MouseEvent e) { handler.mouseEntered(e); }
{@inheritDoc}
/** {@inheritDoc} */
public void mouseClicked(MouseEvent e) { handler.mouseClicked(e); } }
A selection listener.
/** * A selection listener. */
protected class SelectionListener implements ListSelectionListener { // NOTE: This class exists only for backward compatibility. All // its functionality has been moved into Handler. If you need to add // new functionality add it to the Handler, but make sure this // class calls into the Handler.
{@inheritDoc}
/** {@inheritDoc} */
public void valueChanged(ListSelectionEvent e) { getHandler().valueChanged(e); } }
Property to remember whether a directory is currently selected in the UI.
Returns:true iff a directory is currently selected.
Since:1.4
/** * Property to remember whether a directory is currently selected in the UI. * * @return <code>true</code> iff a directory is currently selected. * @since 1.4 */
protected boolean isDirectorySelected() { return directorySelected; }
Property to remember whether a directory is currently selected in the UI. This is normally called by the UI on a selection event.
Params:
  • b – iff a directory is currently selected.
Since:1.4
/** * Property to remember whether a directory is currently selected in the UI. * This is normally called by the UI on a selection event. * * @param b iff a directory is currently selected. * @since 1.4 */
protected void setDirectorySelected(boolean b) { directorySelected = b; }
Property to remember the directory that is currently selected in the UI.
See Also:
Returns:the value of the directory property
Since:1.4
/** * Property to remember the directory that is currently selected in the UI. * * @return the value of the <code>directory</code> property * @see #setDirectory * @since 1.4 */
protected File getDirectory() { return directory; }
Property to remember the directory that is currently selected in the UI. This is normally called by the UI on a selection event.
Params:
  • f – the File object representing the directory that is currently selected
Since:1.4
/** * Property to remember the directory that is currently selected in the UI. * This is normally called by the UI on a selection event. * * @param f the <code>File</code> object representing the directory that is * currently selected * @since 1.4 */
protected void setDirectory(File f) { directory = f; }
Returns the mnemonic for the given key.
/** * Returns the mnemonic for the given key. */
private int getMnemonic(String key, Locale l) { return SwingUtilities2.getUIDefaultsInt(key, l); } // ******************************************************* // ************ FileChooser UI PLAF methods ************** // *******************************************************
Returns the default accept all file filter
/** * Returns the default accept all file filter */
public FileFilter getAcceptAllFileFilter(JFileChooser fc) { return acceptAllFileFilter; } public FileView getFileView(JFileChooser fc) { return fileView; }
Returns the title of this dialog
Params:
  • fc – the file chooser
Returns:the title of this dialog
/** * Returns the title of this dialog * @param fc the file chooser * @return the title of this dialog */
public String getDialogTitle(JFileChooser fc) { String dialogTitle = fc.getDialogTitle(); if (dialogTitle != null) { return dialogTitle; } else if (fc.getDialogType() == JFileChooser.OPEN_DIALOG) { return openDialogTitleText; } else if (fc.getDialogType() == JFileChooser.SAVE_DIALOG) { return saveDialogTitleText; } else { return getApproveButtonText(fc); } }
Returns the approve button mnemonic.
Params:
  • fc – the file chooser
Returns:the approve button mnemonic
/** * Returns the approve button mnemonic. * @param fc the file chooser * @return the approve button mnemonic */
public int getApproveButtonMnemonic(JFileChooser fc) { int mnemonic = fc.getApproveButtonMnemonic(); if (mnemonic > 0) { return mnemonic; } else if (fc.getDialogType() == JFileChooser.OPEN_DIALOG) { return openButtonMnemonic; } else if (fc.getDialogType() == JFileChooser.SAVE_DIALOG) { return saveButtonMnemonic; } else { return mnemonic; } }
{@inheritDoc}
/** {@inheritDoc} */
public String getApproveButtonText(JFileChooser fc) { String buttonText = fc.getApproveButtonText(); if (buttonText != null) { return buttonText; } else if (fc.getDialogType() == JFileChooser.OPEN_DIALOG) { return openButtonText; } else if (fc.getDialogType() == JFileChooser.SAVE_DIALOG) { return saveButtonText; } else { return null; } } // ***************************** // ***** Directory Actions ***** // *****************************
Returns a new folder action.
Returns:a new folder action
/** * Returns a new folder action. * @return a new folder action */
public Action getNewFolderAction() { if (newFolderAction == null) { newFolderAction = new NewFolderAction(); // Note: Don't return null for readOnly, it might // break older apps. if (readOnly) { newFolderAction.setEnabled(false); } } return newFolderAction; }
Returns a go home action.
Returns:a go home action
/** * Returns a go home action. * @return a go home action */
public Action getGoHomeAction() { return goHomeAction; }
Returns a change to parent directory action.
Returns:a change to parent directory action
/** * Returns a change to parent directory action. * @return a change to parent directory action */
public Action getChangeToParentDirectoryAction() { return changeToParentDirectoryAction; }
Returns an approve selection action.
Returns:an approve selection action
/** * Returns an approve selection action. * @return an approve selection action */
public Action getApproveSelectionAction() { return approveSelectionAction; }
Returns a cancel selection action.
Returns:a cancel selection action
/** * Returns a cancel selection action. * @return a cancel selection action */
public Action getCancelSelectionAction() { return cancelSelectionAction; }
Returns an update action.
Returns:an update action
/** * Returns an update action. * @return an update action */
public Action getUpdateAction() { return updateAction; }
Creates a new folder.
/** * Creates a new folder. */
@SuppressWarnings("serial") // Superclass is not serializable across versions protected class NewFolderAction extends AbstractAction {
Constructs a NewFolderAction.
/** Constructs a {@code NewFolderAction}. */
protected NewFolderAction() { super(FilePane.ACTION_NEW_FOLDER); }
{@inheritDoc}
/** {@inheritDoc} */
public void actionPerformed(ActionEvent e) { if (readOnly) { return; } JFileChooser fc = getFileChooser(); File currentDirectory = fc.getCurrentDirectory(); if (!currentDirectory.exists()) { JOptionPane.showMessageDialog( fc, newFolderParentDoesntExistText, newFolderParentDoesntExistTitleText, JOptionPane.WARNING_MESSAGE); return; } File newFolder; try { newFolder = fc.getFileSystemView().createNewFolder(currentDirectory); if (fc.isMultiSelectionEnabled()) { fc.setSelectedFiles(new File[] { newFolder }); } else { fc.setSelectedFile(newFolder); } } catch (IOException exc) { JOptionPane.showMessageDialog( fc, newFolderErrorText + newFolderErrorSeparator + exc, newFolderErrorText, JOptionPane.ERROR_MESSAGE); return; } fc.rescanCurrentDirectory(); } }
Acts on the "home" key event or equivalent event.
/** * Acts on the "home" key event or equivalent event. */
@SuppressWarnings("serial") // Superclass is not serializable across versions protected class GoHomeAction extends AbstractAction {
Constructs a GoHomeAction.
/** Constructs a {@code GoHomeAction}. */
protected GoHomeAction() { super("Go Home"); } public void actionPerformed(ActionEvent e) { JFileChooser fc = getFileChooser(); changeDirectory(fc.getFileSystemView().getHomeDirectory()); } }
Change to parent directory action.
/** * Change to parent directory action. */
@SuppressWarnings("serial") // Superclass is not serializable across versions protected class ChangeToParentDirectoryAction extends AbstractAction {
Constructs a ChangeToParentDirectoryAction.
/** Constructs a {@code ChangeToParentDirectoryAction}. */
protected ChangeToParentDirectoryAction() { super("Go Up"); putValue(Action.ACTION_COMMAND_KEY, FilePane.ACTION_CHANGE_TO_PARENT_DIRECTORY); }
{@inheritDoc}
/** {@inheritDoc} */
public void actionPerformed(ActionEvent e) { getFileChooser().changeToParentDirectory(); } }
Responds to an Open or Save request
/** * Responds to an Open or Save request */
@SuppressWarnings("serial") // Superclass is not serializable across versions protected class ApproveSelectionAction extends AbstractAction {
Constructs an ApproveSelectionAction.
/** Constructs an {@code ApproveSelectionAction}. */
protected ApproveSelectionAction() { super(FilePane.ACTION_APPROVE_SELECTION); }
{@inheritDoc}
/** {@inheritDoc} */
public void actionPerformed(ActionEvent e) { if (isDirectorySelected()) { File dir = getDirectory(); if (dir != null) { try { // Strip trailing ".." dir = ShellFolder.getNormalizedFile(dir); } catch (IOException ex) { // Ok, use f as is } changeDirectory(dir); return; } } JFileChooser chooser = getFileChooser(); String filename = getFileName(); FileSystemView fs = chooser.getFileSystemView(); File dir = chooser.getCurrentDirectory(); if (filename == null || filename.length() == 0) { // no file selected, multiple selection off, therefore cancel the approve action resetGlobFilter(); return; } File selectedFile = null; File[] selectedFiles = null; // Unix: Resolve '~' to user's home directory if (File.separatorChar == '/') { if (filename.startsWith("~/")) { filename = System.getProperty("user.home") + filename.substring(1); } else if (filename.equals("~")) { filename = System.getProperty("user.home"); } } if (chooser.isMultiSelectionEnabled() && filename.length() > 1 && filename.charAt(0) == '"' && filename.charAt(filename.length() - 1) == '"') { List<File> fList = new ArrayList<File>(); String[] files = filename.substring(1, filename.length() - 1).split("\" \""); // Optimize searching files by names in "children" array Arrays.sort(files); File[] children = null; int childIndex = 0; for (String str : files) { File file = fs.createFileObject(str); if (!file.isAbsolute()) { if (children == null) { children = fs.getFiles(dir, false); Arrays.sort(children); } for (int k = 0; k < children.length; k++) { int l = (childIndex + k) % children.length; if (children[l].getName().equals(str)) { file = children[l]; childIndex = l + 1; break; } } } fList.add(file); } if (!fList.isEmpty()) { selectedFiles = fList.toArray(new File[fList.size()]); } resetGlobFilter(); } else { selectedFile = fs.createFileObject(filename); if (!selectedFile.isAbsolute()) { selectedFile = fs.getChild(dir, filename); } // check for wildcard pattern FileFilter currentFilter = chooser.getFileFilter(); if (!selectedFile.exists() && isGlobPattern(filename)) { changeDirectory(selectedFile.getParentFile()); if (globFilter == null) { globFilter = new GlobFilter(); } try { globFilter.setPattern(selectedFile.getName()); if (!(currentFilter instanceof GlobFilter)) { actualFileFilter = currentFilter; } chooser.setFileFilter(null); chooser.setFileFilter(globFilter); return; } catch (PatternSyntaxException pse) { // Not a valid glob pattern. Abandon filter. } } resetGlobFilter(); // Check for directory change action boolean isDir = (selectedFile != null && selectedFile.isDirectory()); boolean isTrav = (selectedFile != null && chooser.isTraversable(selectedFile)); boolean isDirSelEnabled = chooser.isDirectorySelectionEnabled(); boolean isFileSelEnabled = chooser.isFileSelectionEnabled(); @SuppressWarnings("deprecation") boolean isCtrl = (e != null && (e.getModifiers() & Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()) != 0); if (isDir && isTrav && (isCtrl || !isDirSelEnabled)) { changeDirectory(selectedFile); return; } else if ((isDir || !isFileSelEnabled) && (!isDir || !isDirSelEnabled) && (!isDirSelEnabled || selectedFile.exists())) { selectedFile = null; } } if (selectedFiles != null || selectedFile != null) { if (selectedFiles != null || chooser.isMultiSelectionEnabled()) { if (selectedFiles == null) { selectedFiles = new File[] { selectedFile }; } chooser.setSelectedFiles(selectedFiles); // Do it again. This is a fix for bug 4949273 to force the // selected value in case the ListSelectionModel clears it // for non-existing file names. chooser.setSelectedFiles(selectedFiles); } else { chooser.setSelectedFile(selectedFile); } chooser.approveSelection(); } else { if (chooser.isMultiSelectionEnabled()) { chooser.setSelectedFiles(null); } else { chooser.setSelectedFile(null); } chooser.cancelSelection(); } } } private void resetGlobFilter() { if (actualFileFilter != null) { JFileChooser chooser = getFileChooser(); FileFilter currentFilter = chooser.getFileFilter(); if (currentFilter != null && currentFilter.equals(globFilter)) { chooser.setFileFilter(actualFileFilter); chooser.removeChoosableFileFilter(globFilter); } actualFileFilter = null; } } private static boolean isGlobPattern(String filename) { return ((File.separatorChar == '\\' && (filename.indexOf('*') >= 0 || filename.indexOf('?') >= 0)) || (File.separatorChar == '/' && (filename.indexOf('*') >= 0 || filename.indexOf('?') >= 0 || filename.indexOf('[') >= 0))); } /* A file filter which accepts file patterns containing * the special wildcards *? on Windows and *?[] on Unix. */ class GlobFilter extends FileFilter { Pattern pattern; String globPattern; public void setPattern(String globPattern) { char[] gPat = globPattern.toCharArray(); char[] rPat = new char[gPat.length * 2]; boolean isWin32 = (File.separatorChar == '\\'); boolean inBrackets = false; int j = 0; this.globPattern = globPattern; if (isWin32) { // On windows, a pattern ending with *.* is equal to ending with * int len = gPat.length; if (globPattern.endsWith("*.*")) { len -= 2; } for (int i = 0; i < len; i++) { switch(gPat[i]) { case '*': rPat[j++] = '.'; rPat[j++] = '*'; break; case '?': rPat[j++] = '.'; break; case '\\': rPat[j++] = '\\'; rPat[j++] = '\\'; break; default: if ("+()^$.{}[]".indexOf(gPat[i]) >= 0) { rPat[j++] = '\\'; } rPat[j++] = gPat[i]; break; } } } else { for (int i = 0; i < gPat.length; i++) { switch(gPat[i]) { case '*': if (!inBrackets) { rPat[j++] = '.'; } rPat[j++] = '*'; break; case '?': rPat[j++] = inBrackets ? '?' : '.'; break; case '[': inBrackets = true; rPat[j++] = gPat[i]; if (i < gPat.length - 1) { switch (gPat[i+1]) { case '!': case '^': rPat[j++] = '^'; i++; break; case ']': rPat[j++] = gPat[++i]; break; } } break; case ']': rPat[j++] = gPat[i]; inBrackets = false; break; case '\\': if (i == 0 && gPat.length > 1 && gPat[1] == '~') { rPat[j++] = gPat[++i]; } else { rPat[j++] = '\\'; if (i < gPat.length - 1 && "*?[]".indexOf(gPat[i+1]) >= 0) { rPat[j++] = gPat[++i]; } else { rPat[j++] = '\\'; } } break; default: //if ("+()|^$.{}<>".indexOf(gPat[i]) >= 0) { if (!Character.isLetterOrDigit(gPat[i])) { rPat[j++] = '\\'; } rPat[j++] = gPat[i]; break; } } } this.pattern = Pattern.compile(new String(rPat, 0, j), Pattern.CASE_INSENSITIVE); } public boolean accept(File f) { if (f == null) { return false; } if (f.isDirectory()) { return true; } return pattern.matcher(f.getName()).matches(); } public String getDescription() { return globPattern; } }
Responds to a cancel request.
/** * Responds to a cancel request. */
@SuppressWarnings("serial") // Superclass is not serializable across versions protected class CancelSelectionAction extends AbstractAction {
{@inheritDoc}
/** {@inheritDoc} */
public void actionPerformed(ActionEvent e) { getFileChooser().cancelSelection(); } }
Rescans the files in the current directory
/** * Rescans the files in the current directory */
@SuppressWarnings("serial") // Superclass is not serializable across versions protected class UpdateAction extends AbstractAction {
{@inheritDoc}
/** {@inheritDoc} */
public void actionPerformed(ActionEvent e) { JFileChooser fc = getFileChooser(); fc.setCurrentDirectory(fc.getFileSystemView().createFileObject(getDirectoryName())); fc.rescanCurrentDirectory(); } } private void changeDirectory(File dir) { JFileChooser fc = getFileChooser(); // Traverse shortcuts on Windows if (dir != null && FilePane.usesShellFolder(fc)) { try { ShellFolder shellFolder = ShellFolder.getShellFolder(dir); if (shellFolder.isLink()) { File linkedTo = shellFolder.getLinkLocation(); // If linkedTo is null we try to use dir if (linkedTo != null) { if (fc.isTraversable(linkedTo)) { dir = linkedTo; } else { return; } } else { dir = shellFolder; } } } catch (FileNotFoundException ex) { return; } } fc.setCurrentDirectory(dir); if (fc.getFileSelectionMode() == JFileChooser.FILES_AND_DIRECTORIES && fc.getFileSystemView().isFileSystem(dir)) { setFileName(dir.getAbsolutePath()); } } // ***************************************** // ***** default AcceptAll file filter ***** // *****************************************
Accept all file filter.
/** * Accept all file filter. */
protected class AcceptAllFileFilter extends FileFilter {
Constructs an AcceptAllFileFilter.
/** Constructs an {@code AcceptAllFileFilter}. */
public AcceptAllFileFilter() { }
Returns true.
Params:
  • f – the file
Returns:true
/** * Returns true. * @param f the file * @return true */
public boolean accept(File f) { return true; }
{@inheritDoc}
/** * {@inheritDoc} */
public String getDescription() { return UIManager.getString("FileChooser.acceptAllFileFilterText"); } } // *********************** // * FileView operations * // ***********************
A basic file view.
/** * A basic file view. */
protected class BasicFileView extends FileView { /* FileView type descriptions */
The icon cache
/** The icon cache */
protected Hashtable<File,Icon> iconCache = new Hashtable<File,Icon>();
Constructs a BasicFileView.
/** Constructs a {@code BasicFileView}. */
public BasicFileView() { }
Clears the icon cache.
/** * Clears the icon cache. */
public void clearIconCache() { iconCache = new Hashtable<File,Icon>(); }
{@inheritDoc}
/** {@inheritDoc} */
public String getName(File f) { // Note: Returns display name rather than file name String fileName = null; if(f != null) { fileName = getFileChooser().getFileSystemView().getSystemDisplayName(f); } return fileName; }
{@inheritDoc}
/** {@inheritDoc} */
public String getDescription(File f) { return f.getName(); }
{@inheritDoc}
/** {@inheritDoc} */
public String getTypeDescription(File f) { String type = getFileChooser().getFileSystemView().getSystemTypeDescription(f); if (type == null) { if (f.isDirectory()) { type = directoryDescriptionText; } else { type = fileDescriptionText; } } return type; }
Returns the cached icon for the file.
Params:
  • f – the file
Returns:the cached icon for the file
/** * Returns the cached icon for the file. * @param f the file * @return the cached icon for the file */
public Icon getCachedIcon(File f) { return iconCache.get(f); }
Caches an icon for a file.
Params:
  • f – the file
  • i – the icon
/** * Caches an icon for a file. * @param f the file * @param i the icon */
public void cacheIcon(File f, Icon i) { if(f == null || i == null) { return; } iconCache.put(f, i); }
{@inheritDoc}
/** {@inheritDoc} */
public Icon getIcon(File f) { Icon icon = getCachedIcon(f); if(icon != null) { return icon; } icon = fileIcon; if (f != null) { FileSystemView fsv = getFileChooser().getFileSystemView(); if (fsv.isFloppyDrive(f)) { icon = floppyDriveIcon; } else if (fsv.isDrive(f)) { icon = hardDriveIcon; } else if (fsv.isComputerNode(f)) { icon = computerIcon; } else if (f.isDirectory()) { icon = directoryIcon; } } cacheIcon(f, icon); return icon; }
Returns whether or not a file is hidden.
Params:
  • f – the file
Returns:whether or not a file is hidden
/** * Returns whether or not a file is hidden. * @param f the file * @return whether or not a file is hidden */
public Boolean isHidden(File f) { String name = f.getName(); if(name != null && name.charAt(0) == '.') { return Boolean.TRUE; } else { return Boolean.FALSE; } } } private static final TransferHandler defaultTransferHandler = new FileTransferHandler();
Data transfer support for the file chooser. Since files are currently presented as a list, the list support is reused with the added flavor of DataFlavor.javaFileListFlavor
/** * Data transfer support for the file chooser. Since files are currently presented * as a list, the list support is reused with the added flavor of DataFlavor.javaFileListFlavor */
@SuppressWarnings("serial") // JDK-implementation class static class FileTransferHandler extends TransferHandler implements UIResource {
Create a Transferable to use as the source for a data transfer.
Params:
  • c – The component holding the data to be transfered. This argument is provided to enable sharing of TransferHandlers by multiple components.
Returns: The representation of the data to be transfered.
/** * Create a Transferable to use as the source for a data transfer. * * @param c The component holding the data to be transfered. This * argument is provided to enable sharing of TransferHandlers by * multiple components. * @return The representation of the data to be transfered. * */
@SuppressWarnings("deprecation") protected Transferable createTransferable(JComponent c) { Object[] values = null; if (c instanceof JList) { values = ((JList)c).getSelectedValues(); } else if (c instanceof JTable) { JTable table = (JTable)c; int[] rows = table.getSelectedRows(); if (rows != null) { values = new Object[rows.length]; for (int i=0; i<rows.length; i++) { values[i] = table.getValueAt(rows[i], 0); } } } if (values == null || values.length == 0) { return null; } StringBuilder plainBuf = new StringBuilder(); StringBuilder htmlBuf = new StringBuilder(); htmlBuf.append("<html>\n<body>\n<ul>\n"); for (Object obj : values) { String val = ((obj == null) ? "" : obj.toString()); plainBuf.append(val).append('\n'); htmlBuf.append(" <li>").append(val).append('\n'); } // remove the last newline plainBuf.deleteCharAt(plainBuf.length() - 1); htmlBuf.append("</ul>\n</body>\n</html>"); return new FileTransferable(plainBuf.toString(), htmlBuf.toString(), values); } public int getSourceActions(JComponent c) { return COPY; } static class FileTransferable extends BasicTransferable { Object[] fileData; FileTransferable(String plainData, String htmlData, Object[] fileData) { super(plainData, htmlData); this.fileData = fileData; }
Best format of the file chooser is DataFlavor.javaFileListFlavor.
/** * Best format of the file chooser is DataFlavor.javaFileListFlavor. */
protected DataFlavor[] getRicherFlavors() { DataFlavor[] flavors = new DataFlavor[1]; flavors[0] = DataFlavor.javaFileListFlavor; return flavors; }
The only richer format supported is the file list flavor
/** * The only richer format supported is the file list flavor */
protected Object getRicherData(DataFlavor flavor) { if (DataFlavor.javaFileListFlavor.equals(flavor)) { ArrayList<Object> files = new ArrayList<Object>(); for (Object file : this.fileData) { files.add(file); } return files; } return null; } } } }