de.cismet.tools.gui

Class RestrictedFileSystemView

java.lang.Object

javax.swing.filechooser.FileSystemView

de.cismet.tools.gui.RestrictedFileSystemView

public class RestrictedFileSystemView
extends FileSystemView

Fallback implementation of a FileSystemView.

Intendend usage:
If the standard JFileChooser cannot open due to an exception, as described in http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6544857

Example:

     File currentDir = ...;
     JFrame parentFrame = ...;
     JFileChooser chooser;
     try {
         chooser = new JFileChooser(currentDir);
     } catch (Exception e) {
         chooser = new JFileChooser(currentDir, new RestrictedFileSystemView());
     }
     int returnValue = chooser.showOpenDialog(parentFrame);
 

This FileSystemView only provides basic functionality (and probably a poor look & feel), but it can be a life saver if otherwise no dialog pops up in your application.

The implementation does not use sun.awt.shell.* classes.

Version:

$Revision$, $Date$

Constructor Summary

Constructors

Constructor and Description
RestrictedFileSystemView() Creates a new RestrictedFileSystemView object.
RestrictedFileSystemView(File defaultDirectory) Creates a new RestrictedFileSystemView object.

Method Summary

Modifier and Type	Method and Description
File	createFileObject(File dir, String filename) Returns a File object constructed in dir from the given filename.
File	createFileObject(String path) Returns a File object constructed from the given path string.
protected File	createFileSystemRoot(File f) Creates a new File object for f with correct behavior for a file system root directory.
File	createNewFolder(File containingDir)
File	getChild(File parent, String fileName) DOCUMENT ME!
File	getDefaultDirectory() Return the user's default starting directory for the file chooser.
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) DOCUMENT ME!
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.

Methods inherited from class javax.swing.filechooser.FileSystemView

getFileSystemView

Methods inherited from class java.lang.Object

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

Constructor Detail

RestrictedFileSystemView

public RestrictedFileSystemView()

Creates a new RestrictedFileSystemView object.

RestrictedFileSystemView

public RestrictedFileSystemView(File defaultDirectory)

Creates a new RestrictedFileSystemView object.

Parameters:

defaultDirectory - DOCUMENT ME!

Method Detail

isRoot

public boolean isRoot(File f)

Determines if the given file is a root in the navigatable tree(s).

Overrides:

isRoot in class FileSystemView

Parameters:

f - a File object representing a directory

Returns:

true if f is a root in the navigatable tree.

See Also:

isFileSystemRoot(java.io.File)

isTraversable

public Boolean isTraversable(File f)

Returns true if the file (directory) can be visited. Returns false if the directory cannot be traversed.

Overrides:

isTraversable in class FileSystemView

Parameters:

f - the File

Returns:

true if the file/directory can be traversed, otherwise false

See Also:

JFileChooser#isTraversable, FileView#isTraversable

getSystemDisplayName

public String getSystemDisplayName(File f)

Name of a file, directory, or folder as it would be displayed in a system file browser.

Overrides:

getSystemDisplayName in class FileSystemView

Parameters:

f - a File object

Returns:

the file name as it would be displayed by a native file chooser

See Also:

JFileChooser#getName

getSystemTypeDescription

public String getSystemTypeDescription(File f)

Type description for a file, directory, or folder as it would be displayed in a system file browser.

Overrides:

getSystemTypeDescription in class FileSystemView

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:

JFileChooser#getTypeDescription

getSystemIcon

public Icon getSystemIcon(File f)

Icon for a file, directory, or folder as it would be displayed in a system file browser.

Overrides:

getSystemIcon in class FileSystemView

Parameters:

f - a File object

Returns:

an icon as it would be displayed by a native file chooser, null if not available

See Also:

JFileChooser#getIcon

isParent

public boolean isParent(File folder,
                        File file)

DOCUMENT ME!

Overrides:

isParent in class FileSystemView

Parameters:

folder - a File object repesenting a directory

file - a File object

Returns:

true if folder is a directory and contains file.

getChild

public File getChild(File parent,
                     String fileName)

DOCUMENT ME!

Overrides:

getChild in class FileSystemView

Parameters:

parent - a File object repesenting a directory

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).

isFileSystem

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.

Overrides:

isFileSystem in class FileSystemView

Parameters:

f - a File object

Returns:

true if f is a real file or directory.

isHiddenFile

public boolean isHiddenFile(File f)

Returns whether a file is hidden or not.

Overrides:

isHiddenFile in class FileSystemView

Parameters:

f - DOCUMENT ME!

Returns:

DOCUMENT ME!

isFileSystemRoot

public boolean isFileSystemRoot(File dir)

Is dir the root of a tree in the file system, such as a drive or partition.

Overrides:

isFileSystemRoot in class FileSystemView

Parameters:

dir - f a File object representing a directory

Returns:

true if f is a root of a filesystem

See Also:

isRoot(java.io.File)

isDrive

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.

Overrides:

isDrive in class FileSystemView

Parameters:

dir - a directory

Returns:

false always

isFloppyDrive

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.

Overrides:

isFloppyDrive in class FileSystemView

Parameters:

dir - a directory

Returns:

false always

isComputerNode

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.

Overrides:

isComputerNode in class FileSystemView

Parameters:

dir - a directory

Returns:

false always

getRoots

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.

Overrides:

getRoots in class FileSystemView

Returns:

DOCUMENT ME!

getHomeDirectory

public File getHomeDirectory()

Overrides:

getHomeDirectory in class FileSystemView

getDefaultDirectory

public File getDefaultDirectory()

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

Overrides:

getDefaultDirectory in class FileSystemView

Returns:

a File object representing the default starting folder

createFileObject

public File createFileObject(File dir,
                             String filename)

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

Overrides:

createFileObject in class FileSystemView

Parameters:

dir - DOCUMENT ME!

filename - DOCUMENT ME!

Returns:

DOCUMENT ME!

createFileObject

public File createFileObject(String path)

Returns a File object constructed from the given path string.

Overrides:

createFileObject in class FileSystemView

Parameters:

path - DOCUMENT ME!

Returns:

DOCUMENT ME!

getFiles

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

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

Overrides:

getFiles in class FileSystemView

Parameters:

dir - DOCUMENT ME!

useFileHiding - DOCUMENT ME!

Returns:

DOCUMENT ME!

getParentDirectory

public File getParentDirectory(File dir)

Returns the parent directory of dir.

Overrides:

getParentDirectory in class FileSystemView

Parameters:

dir - the File being queried

Returns:

the parent directory of dir, or null if dir is null

createFileSystemRoot

protected File createFileSystemRoot(File f)

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

Overrides:

createFileSystemRoot in class FileSystemView

Parameters:

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

Returns:

a new File object

createNewFolder

public File createNewFolder(File containingDir)
                     throws IOException

Specified by:

createNewFolder in class FileSystemView

Throws:

IOException