javax.swing.filechooser

Class FileSystemView

java.lang.Object

javax.swing.filechooser.FileSystemView

public abstract class FileSystemView
extends java.lang.Object

The base class providing a view of the file system for use by the JFileChooser component.

Constructor Summary

Constructors

Constructor and Description
FileSystemView()

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	createFileObject(java.io.File dir, java.lang.String filename) Creates a new file object with the given name in the specified directory.
java.io.File	createFileObject(java.lang.String path) Creates a new file object from the specified path.
protected java.io.File	createFileSystemRoot(java.io.File f) DOCUMENT ME!
abstract java.io.File	createNewFolder(java.io.File containingDir) Creates a new folder with a unique name in the specified directory and returns a File object representing the new directory.
java.io.File	getChild(java.io.File parent, java.lang.String fileName) DOCUMENT ME!
java.io.File	getDefaultDirectory() Returns the default directory.
java.io.File[]	getFiles(java.io.File dir, boolean useFileHiding) Returns an array containing the files in the given directory.
static FileSystemView	getFileSystemView() Returns a default FileSystemView appropriate for the platform.
java.io.File	getHomeDirectory() Returns the home directory for the current user.
java.io.File	getParentDirectory(java.io.File f) Returns the parent directory for the given file/directory.
java.io.File[]	getRoots() Returns an array containing the file system roots.
java.lang.String	getSystemDisplayName(java.io.File f) Returns the name of a file as it would be displayed by the underlying system.
javax.swing.Icon	getSystemIcon(java.io.File f) Returns the icon that would be displayed for the given file by the underlying system.
java.lang.String	getSystemTypeDescription(java.io.File f) Returns the type description of a file that would be displayed by the underlying system.
boolean	isComputerNode(java.io.File dir) DOCUMENT ME!
boolean	isDrive(java.io.File dir) Returns true if the given directory represents a disk drive, and false otherwise.
boolean	isFileSystem(java.io.File f) Returns true if f is a file or directory, and false otherwise.
boolean	isFileSystemRoot(java.io.File dir) Returns true if the given directory is a file system root, and false otherwise.
boolean	isFloppyDrive(java.io.File dir) Returns true if the given directory represents a floppy drive, and false otherwise.
boolean	isHiddenFile(java.io.File f) Returns true if the given file is hidden, and false otherwise.
boolean	isParent(java.io.File folder, java.io.File file) Returns true if folder is the parent of file, and false otherwise.
boolean	isRoot(java.io.File f) DOCUMENT ME!
java.lang.Boolean	isTraversable(java.io.File f) Returns true if the file is traversable, and false otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemView

public FileSystemView()

Method Detail

createFileObject

public java.io.File createFileObject(java.io.File dir,
                            java.lang.String filename)

Creates a new file object with the given name in the specified directory.

Parameters:

dir - the directory (null permitted).

filename - the file name.

Returns:

A new file object.

createFileObject

public java.io.File createFileObject(java.lang.String path)

Creates a new file object from the specified path.

Parameters:

path - the path.

Returns:

A new file object.

createFileSystemRoot

protected java.io.File createFileSystemRoot(java.io.File f)

DOCUMENT ME!

Parameters:

f - DOCUMENT ME!

Returns:

DOCUMENT ME!

createNewFolder

public abstract java.io.File createNewFolder(java.io.File containingDir)
                                      throws java.io.IOException

Creates a new folder with a unique name in the specified directory and returns a File object representing the new directory.

Parameters:

containingDir - the directory to contain the new folder (null not permitted).

Returns:

A File object representing the new directory.

Throws:

java.io.IOException - if an exception occurs while creating the new directory.

getChild

public java.io.File getChild(java.io.File parent,
                    java.lang.String fileName)

DOCUMENT ME!

Parameters:

parent - DOCUMENT ME!

fileName - DOCUMENT ME!

Returns:

DOCUMENT ME!

getDefaultDirectory

public java.io.File getDefaultDirectory()

Returns the default directory.

Returns:

The default directory.

getFiles

public java.io.File[] getFiles(java.io.File dir,
                      boolean useFileHiding)

Returns an array containing the files in the given directory. The useFileHiding controls whether or not hidden files are included in the result.

Parameters:

dir - the directory (if null

useFileHiding - a flag that controls whether or not hidden files are included in the result (pass in true to exclude hidden files).

Returns:

The files in the given directory (possibly null).

getFileSystemView

public static FileSystemView getFileSystemView()

Returns a default FileSystemView appropriate for the platform.

Returns:

A default FileSystemView appropriate for the platform.

getHomeDirectory

public java.io.File getHomeDirectory()

Returns the home directory for the current user.

Returns:

The home directory for the current user.

getParentDirectory

public java.io.File getParentDirectory(java.io.File f)

Returns the parent directory for the given file/directory.

Parameters:

f - the file/directory.

Returns:

The parent directory (or null if there is no parent directory).

getRoots

public java.io.File[] getRoots()

Returns an array containing the file system roots. On Unix-like platforms, this array will contain just a single item ("/"), while other platforms may return multiple roots.

This method is implemented to return null, subclasses must override this method.

Returns:

An array containing the file system roots.

getSystemDisplayName

public java.lang.String getSystemDisplayName(java.io.File f)

Returns the name of a file as it would be displayed by the underlying system.

Parameters:

f - the file.

Returns:

the name of a file as it would be displayed by the underlying system

getSystemIcon

public javax.swing.Icon getSystemIcon(java.io.File f)

Returns the icon that would be displayed for the given file by the underlying system. This implementation returns null, subclasses must override.

Parameters:

f - the file.

Returns:

null.

getSystemTypeDescription

public java.lang.String getSystemTypeDescription(java.io.File f)

Returns the type description of a file that would be displayed by the underlying system. This implementation returns null, subclasses must override.

Parameters:

f - the file.

Returns:

null.

isComputerNode

public boolean isComputerNode(java.io.File dir)

DOCUMENT ME!

Parameters:

dir - DOCUMENT ME!

Returns:

DOCUMENT ME!

isDrive

public boolean isDrive(java.io.File dir)

Returns true if the given directory represents a disk drive, and false otherwise. This default implementation always returns false.

Parameters:

dir - the directory.

Returns:

false.

isFileSystem

public boolean isFileSystem(java.io.File f)

Returns true if f is a file or directory, and false otherwise.

Parameters:

f - the file/directory.

Returns:

true if f is a file or directory, and false otherwise.

isFileSystemRoot

public boolean isFileSystemRoot(java.io.File dir)

Returns true if the given directory is a file system root, and false otherwise.

Parameters:

dir - the directory.

Returns:

true if the given directory is a file system root, and false otherwise.

isFloppyDrive

public boolean isFloppyDrive(java.io.File dir)

Returns true if the given directory represents a floppy drive, and false otherwise. This default implementation always returns false.

Parameters:

dir - the directory.

Returns:

false.

isHiddenFile

public boolean isHiddenFile(java.io.File f)

Returns true if the given file is hidden, and false otherwise.

Parameters:

f - the file.

Returns:

true if the given file is hidden, and false otherwise.

isParent

public boolean isParent(java.io.File folder,
               java.io.File file)

Returns true if folder is the parent of file, and false otherwise.

Parameters:

folder - the folder (null not permitted).

file - the file (null not permitted).

Returns:

true if folder is the parent of file, and false otherwise.

isRoot

public boolean isRoot(java.io.File f)

DOCUMENT ME!

Parameters:

f - DOCUMENT ME!

Returns:

DOCUMENT ME!

isTraversable

public java.lang.Boolean isTraversable(java.io.File f)

Returns true if the file is traversable, and false otherwise. Here, all directories are considered traversable, and files are considered non-traversable.

Parameters:

f - the file or directory (null not permitted).

Returns:

true if the file is traversable, and false otherwise.