com.googlecode.vfsjfilechooser2.filechooser

Class AbstractVFSFileSystemView

java.lang.Object

com.googlecode.vfsjfilechooser2.filechooser.AbstractVFSFileSystemView

public abstract class AbstractVFSFileSystemView
extends Object

The implementation using commons-vfs based on Swing FileSystemView

Version:

0.0.1

Author:

Yves Zoundi

Constructor Summary

Constructors

Constructor and Description
AbstractVFSFileSystemView()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractVFSFileSystemView

public AbstractVFSFileSystemView()

Method Detail

getFileSystemView

public static AbstractVFSFileSystemView getFileSystemView()

isRoot

public boolean isRoot(org.apache.commons.vfs2.FileObject 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:

isFileSystemRoot(org.apache.commons.vfs2.FileObject)

isTraversable

public Boolean isTraversable(org.apache.commons.vfs2.FileObject 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

Since:

1.4

See Also:

JFileChooser.isTraversable(java.io.File), FileView.isTraversable(java.io.File)

getSystemDisplayName

public String getSystemDisplayName(org.apache.commons.vfs2.FileObject 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

Since:

1.4

See Also:

JFileChooser.getName(java.io.File)

getSystemTypeDescription

public String getSystemTypeDescription(org.apache.commons.vfs2.FileObject 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.

Since:

1.4

See Also:

JFileChooser.getTypeDescription(java.io.File)

getSystemIcon

public Icon getSystemIcon(org.apache.commons.vfs2.FileObject 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

Since:

1.4

See Also:

JFileChooser.getIcon(java.io.File)

isParent

public boolean isParent(org.apache.commons.vfs2.FileObject folder,
                        org.apache.commons.vfs2.FileObject 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.

Since:

1.4

getChild

public org.apache.commons.vfs2.FileObject getChild(org.apache.commons.vfs2.FileObject 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.

Since:

1.4

isFileSystem

public boolean isFileSystem(org.apache.commons.vfs2.FileObject 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.

Since:

1.4

createNewFolder

public abstract org.apache.commons.vfs2.FileObject createNewFolder(org.apache.commons.vfs2.FileObject containingDir)
                                                            throws org.apache.commons.vfs2.FileSystemException

Creates a new folder with a default folder name.

Parameters:

containingDir -

Returns:

Throws:

org.apache.commons.vfs.FileSystemException

org.apache.commons.vfs2.FileSystemException

isHiddenFile

public boolean isHiddenFile(org.apache.commons.vfs2.FileObject f)

Returns whether a file is hidden or not.

Parameters:

f -

Returns:

isFileSystemRoot

public boolean isFileSystemRoot(org.apache.commons.vfs2.FileObject 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

Since:

1.4

See Also:

isRoot(org.apache.commons.vfs2.FileObject)

isDrive

public boolean isDrive(org.apache.commons.vfs2.FileObject 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

Since:

1.4

isFloppyDrive

public boolean isFloppyDrive(org.apache.commons.vfs2.FileObject 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

Since:

1.4

isComputerNode

public boolean isComputerNode(org.apache.commons.vfs2.FileObject 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

Since:

1.4

getRoots

public org.apache.commons.vfs2.FileObject[] getRoots(org.apache.commons.vfs2.FileObject fo)

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.

Parameters:

fo -

Returns:

getHomeDirectory

public org.apache.commons.vfs2.FileObject getHomeDirectory()

Returns:

getDefaultDirectory

public org.apache.commons.vfs2.FileObject getDefaultDirectory()

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

Returns:

a File object representing the default starting folder

Since:

1.4

createFileObject

public org.apache.commons.vfs2.FileObject createFileObject(org.apache.commons.vfs2.FileObject dir,
                                                           String filename)

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

Parameters:

dir -

filename -

Returns:

createFileObject

public org.apache.commons.vfs2.FileObject createFileObject(String path)

Returns a File object constructed from the given path string.

Parameters:

path -

Returns:

getFiles

public org.apache.commons.vfs2.FileObject[] getFiles(org.apache.commons.vfs2.FileObject dir,
                                                     boolean useFileHiding)

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

Parameters:

dir -

useFileHiding -

Returns:

getParentDirectory

public org.apache.commons.vfs2.FileObject getParentDirectory(org.apache.commons.vfs2.FileObject 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

createFileSystemRoot

protected org.apache.commons.vfs2.FileObject createFileSystemRoot(org.apache.commons.vfs2.FileObject 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

Since:

1.4