public abstract class

FileSystemView

extends Object
java.lang.Object
   ↳ javax.swing.filechooser.FileSystemView

Class Overview

FileSystemView is JFileChooser's gateway to the file system. Since the JDK1.1 File API doesn't allow access to such information as root partitions, file type information, or hidden file bits, this class is designed to intuit as much OS-specific file system information as possible.

Java Licensees may want to provide a different implementation of FileSystemView to better handle a given operating system.

Summary

Public Constructors
FileSystemView()
Public Methods
File createFileObject(String path)
Returns a File object constructed from the given path string.
File createFileObject(File dir, String filename)
Returns a File object constructed in dir from the given filename.
abstract File createNewFolder(File containingDir)
Creates a new folder with a default folder name.
File getChild(File parent, String fileName)
File getDefaultDirectory()
Return the user's default starting directory for the file chooser.
static FileSystemView getFileSystemView()
File[] getFiles(File dir, boolean useFileHiding)
Gets the list of shown (i.e.
File getHomeDirectory()
File getParentDirectory(File dir)
Returns the parent directory of dir.
File[] getRoots()
Returns all root partitions on this system.
String getSystemDisplayName(File f)
Name of a file, directory, or folder as it would be displayed in a system file browser.
Icon getSystemIcon(File f)
Icon for a file, directory, or folder as it would be displayed in a system file browser.
String getSystemTypeDescription(File f)
Type description for a file, directory, or folder as it would be displayed in a system file browser.
boolean isComputerNode(File dir)
Used by UI classes to decide whether to display a special icon for a computer node, e.g.
boolean isDrive(File dir)
Used by UI classes to decide whether to display a special icon for drives or partitions, e.g.
boolean isFileSystem(File f)
Checks if f represents a real directory or file as opposed to a special folder such as "Desktop".
boolean isFileSystemRoot(File dir)
Is dir the root of a tree in the file system, such as a drive or partition.
boolean isFloppyDrive(File dir)
Used by UI classes to decide whether to display a special icon for a floppy disk.
boolean isHiddenFile(File f)
Returns whether a file is hidden or not.
boolean isParent(File folder, File file)
On Windows, a file can appear in multiple folders, other than its parent directory in the filesystem.
boolean isRoot(File f)
Determines if the given file is a root in the navigatable tree(s).
Boolean isTraversable(File f)
Returns true if the file (directory) can be visited.
Protected Methods
File createFileSystemRoot(File f)
Creates a new File object for f with correct behavior for a file system root directory.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FileSystemView ()

Public Methods

public File createFileObject (String path)

Returns a File object constructed from the given path string.

public File createFileObject (File dir, String filename)

Returns a File object constructed in dir from the given filename.

public abstract File createNewFolder (File containingDir)

Creates a new folder with a default folder name.

Throws
IOException

public File getChild (File parent, String fileName)

Parameters
parent a File object repesenting a directory or special folder
fileName a name of a file or folder which exists in parent
Returns
  • a File object. This is normally constructed with new File(parent, fileName) except when parent and child are both special folders, in which case the File is a wrapper containing a ShellFolder object.

public File getDefaultDirectory ()

Return the user's default starting directory for the file chooser.

Returns
  • a File object representing the default starting folder

public static FileSystemView getFileSystemView ()

public File[] getFiles (File dir, boolean useFileHiding)

Gets the list of shown (i.e. not hidden) files.

public File getHomeDirectory ()

public File getParentDirectory (File dir)

Returns the parent directory of dir.

Parameters
dir the File being queried
Returns
  • the parent directory of dir, or null if dir is null

public File[] getRoots ()

Returns all root partitions on this system. For example, on Windows, this would be the "Desktop" folder, while on DOS this would be the A: through Z: drives.

public String getSystemDisplayName (File f)

Name of a file, directory, or folder as it would be displayed in a system file browser. Example from Windows: the "M:\" directory displays as "CD-ROM (M:)" The default implementation gets information from the ShellFolder class.

Parameters
f a File object
Returns
  • the file name as it would be displayed by a native file chooser
See Also

public Icon getSystemIcon (File f)

Icon for a file, directory, or folder as it would be displayed in a system file browser. Example from Windows: the "M:\" directory displays a CD-ROM icon. The default implementation gets information from the ShellFolder class.

Parameters
f a File object
Returns
  • an icon as it would be displayed by a native file chooser
See Also

public String getSystemTypeDescription (File f)

Type description for a file, directory, or folder as it would be displayed in a system file browser. Example from Windows: the "Desktop" folder is desribed as "Desktop". Override for platforms with native ShellFolder implementations.

Parameters
f a File object
Returns
  • the file type description as it would be displayed by a native file chooser or null if no native information is available.
See Also

public boolean isComputerNode (File dir)

Used by UI classes to decide whether to display a special icon for a computer node, e.g. "My Computer" or a network server. The default implementation has no way of knowing, so always returns false.

Parameters
dir a directory
Returns
  • false always

public boolean isDrive (File dir)

Used by UI classes to decide whether to display a special icon for drives or partitions, e.g. a "hard disk" icon. The default implementation has no way of knowing, so always returns false.

Parameters
dir a directory
Returns
  • false always

public boolean isFileSystem (File f)

Checks if f represents a real directory or file as opposed to a special folder such as "Desktop". Used by UI classes to decide if a folder is selectable when doing directory choosing.

Parameters
f a File object
Returns
  • true if f is a real file or directory.

public boolean isFileSystemRoot (File dir)

Is dir the root of a tree in the file system, such as a drive or partition. Example: Returns true for "C:\" on Windows 98.

Parameters
dir a File object representing a directory
Returns
  • true if f is a root of a filesystem
See Also

public boolean isFloppyDrive (File dir)

Used by UI classes to decide whether to display a special icon for a floppy disk. Implies isDrive(dir). The default implementation has no way of knowing, so always returns false.

Parameters
dir a directory
Returns
  • false always

public boolean isHiddenFile (File f)

Returns whether a file is hidden or not.

public boolean isParent (File folder, File file)

On Windows, a file can appear in multiple folders, other than its parent directory in the filesystem. Folder could for example be the "Desktop" folder which is not the same as file.getParentFile().

Parameters
folder a File object repesenting a directory or special folder
file a File object
Returns
  • true if folder is a directory or special folder and contains file.

public boolean isRoot (File f)

Determines if the given file is a root in the navigatable tree(s). Examples: Windows 98 has one root, the Desktop folder. DOS has one root per drive letter, C:\, D:\, etc. Unix has one root, the "/" directory. The default implementation gets information from the ShellFolder class.

Parameters
f a File object representing a directory
Returns
  • true if f is a root in the navigatable tree.
See Also

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

Protected Methods

protected File createFileSystemRoot (File f)

Creates a new File object for f with correct behavior for a file system root directory.

Parameters
f a File object representing a file system root directory, for example "/" on Unix or "C:\" on Windows.
Returns
  • a new File object