1 /* FileSystemView.java --
2 Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
38 package javax
.swing
.filechooser
;
41 import java
.io
.IOException
;
42 import java
.util
.ArrayList
;
44 import javax
.swing
.Icon
;
45 import javax
.swing
.JFileChooser
;
49 * The base class providing a view of the file system for use by the
50 * {@link JFileChooser} component.
52 public abstract class FileSystemView
54 /** The instance returned by {@link #getFileSystemView()}. */
55 private static FileSystemView defaultFileSystemView
;
58 * Creates a new file object with the given name in the specified directory.
60 * @param dir the directory (<code>null</code> permitted).
61 * @param filename the file name.
63 * @return A new file object.
65 public File
createFileObject(File dir
, String filename
)
67 return new File(dir
, filename
);
71 * Creates a new file object from the specified path.
73 * @param path the path.
75 * @return A new file object.
77 public File
createFileObject(String path
)
79 return new File(path
);
85 * @param f DOCUMENT ME!
87 * @return DOCUMENT ME!
89 protected File
createFileSystemRoot(File f
)
91 File
[] roots
= File
.listRoots();
98 * Creates a new folder with a unique name in the specified directory and
99 * returns a {@link File} object representing the new directory.
101 * @param containingDir the directory to contain the new folder
102 * (<code>null</code> not permitted).
104 * @return A {@link File} object representing the new directory.
106 * @throws IOException if an exception occurs while creating the new
109 public abstract File
createNewFolder(File containingDir
)
115 * @param parent DOCUMENT ME!
116 * @param fileName DOCUMENT ME!
118 * @return DOCUMENT ME!
120 public File
getChild(File parent
, String fileName
)
122 // FIXME: Handle the case when parent and child are special folders.
123 return new File(parent
, fileName
);
127 * Returns the default directory.
129 * @return The default directory.
131 public File
getDefaultDirectory()
133 return getHomeDirectory();
137 * Returns an array containing the files in the given directory. The
138 * <code>useFileHiding</code> controls whether or not hidden files are
139 * included in the result.
141 * @param dir the directory (if <code>null</code>
142 * @param useFileHiding a flag that controls whether or not hidden files are
143 * included in the result (pass in <code>true</code> to
144 * exclude hidden files).
146 * @return The files in the given directory (possibly <code>null</code>).
148 public File
[] getFiles(File dir
, boolean useFileHiding
)
150 if (dir
== null || dir
.listFiles() == null)
152 File
[] files
= dir
.listFiles();
155 ArrayList trim
= new ArrayList();
156 for (int i
= 0; i
< files
.length
; i
++)
157 if (! files
[i
].isHidden())
159 File
[] value
= (File
[]) trim
.toArray(new File
[trim
.size()]);
164 * Returns a default {@link FileSystemView} appropriate for the platform.
166 * @return A default {@link FileSystemView} appropriate for the platform.
168 public static FileSystemView
getFileSystemView()
170 if (defaultFileSystemView
== null)
172 if (File
.separator
.equals("/"))
173 defaultFileSystemView
= new UnixFileSystemView();
174 // FIXME: need to implement additional views
175 // else if (File.Separator.equals("\"))
176 // return new Win32FileSystemView();
178 // return new GenericFileSystemView();
180 return defaultFileSystemView
;
184 * Returns the home directory for the current user.
186 * @return The home directory for the current user.
188 public File
getHomeDirectory()
190 return createFileObject(System
.getProperty("user.home"));
194 * Returns the parent directory for the given file/directory.
196 * @param f the file/directory.
198 * @return The parent directory (or <code>null</code> if there is no parent
201 public File
getParentDirectory(File f
)
205 return f
.getParentFile();
209 * Returns an array containing the file system roots. On Unix-like platforms,
210 * this array will contain just a single item ("/"), while other platforms
211 * may return multiple roots.
213 * This method is implemented to return <code>null</code>, subclasses must
214 * override this method.
216 * @return An array containing the file system roots.
218 public File
[] getRoots()
225 * Returns the name of a file as it would be displayed by the underlying
226 * system. This implementation returns <code>null</code>, subclasses must
231 * @return <code>null</code>.
233 public String
getSystemDisplayName(File f
)
239 * Returns the icon that would be displayed for the given file by the
240 * underlying system. This implementation returns <code>null</code>,
241 * subclasses must override.
245 * @return <code>null</code>.
247 public Icon
getSystemIcon(File f
)
253 * Returns the type description of a file that would be displayed by the
254 * underlying system. This implementation returns <code>null</code>,
255 * subclasses must override.
259 * @return <code>null</code>.
261 public String
getSystemTypeDescription(File f
)
269 * @param dir DOCUMENT ME!
271 * @return DOCUMENT ME!
273 public boolean isComputerNode(File dir
)
279 * Returns <code>true</code> if the given directory represents a disk
280 * drive, and <code>false</code> otherwise. This default implementation
281 * always returns <code>false</code>.
283 * @param dir the directory.
285 * @return <code>false</code>.
287 public boolean isDrive(File dir
)
293 * Returns <code>true</code> if <code>f</code> is a file or directory, and
294 * <code>false</code> otherwise.
296 * @param f the file/directory.
298 * @return <code>true</code> if <code>f</code> is a file or directory, and
299 * <code>false</code> otherwise.
301 public boolean isFileSystem(File f
)
303 return (f
.isFile() || f
.isDirectory());
307 * Returns <code>true</code> if the given directory is a file system root,
308 * and <code>false</code> otherwise.
310 * @param dir the directory.
312 * @return <code>true</code> if the given directory is a file system root,
313 * and <code>false</code> otherwise.
315 public boolean isFileSystemRoot(File dir
)
317 File
[] roots
= File
.listRoots();
318 if (roots
== null || dir
== null)
320 String filename
= dir
.getAbsolutePath();
321 for (int i
= 0; i
< roots
.length
; i
++)
322 if (roots
[i
].getAbsolutePath().equals(filename
))
328 * Returns <code>true</code> if the given directory represents a floppy
329 * drive, and <code>false</code> otherwise. This default implementation
330 * always returns <code>false</code>.
332 * @param dir the directory.
334 * @return <code>false</code>.
336 public boolean isFloppyDrive(File dir
)
342 * Returns <code>true</code> if the given file is hidden, and
343 * <code>false</code> otherwise.
347 * @return <code>true</code> if the given file is hidden, and
348 * <code>false</code> otherwise.
350 public boolean isHiddenFile(File f
)
356 * Returns <code>true</code> if <code>folder</code> is the parent of
357 * <code>file</code>, and <code>false</code> otherwise.
359 * @param folder the folder (<code>null</code> not permitted).
360 * @param file the file (<code>null</code> not permitted).
362 * @return <code>true</code> if <code>folder</code> is the parent of
363 * <code>file</code>, and <code>false</code> otherwise.
365 public boolean isParent(File folder
, File file
)
367 File parent
= file
.getParentFile();
370 return folder
.equals(parent
);
376 * @param f DOCUMENT ME!
378 * @return DOCUMENT ME!
380 public boolean isRoot(File f
)
382 // These are not file system roots.
387 * Returns <code>true</code> if the file is traversable, and
388 * <code>false</code> otherwise. Here, all directories are considered
389 * traversable, and files are considered non-traversable.
391 * @param f the file or directory (<code>null</code> not permitted).
393 * @return <code>true</code> if the file is traversable, and
394 * <code>false</code> otherwise.
396 public Boolean
isTraversable(File f
)
398 // Tested. A directory where the user has no permission to rwx is still
399 // traversable. (No files are listed when you traverse the directory)
400 // My best guess is that as long as it's a directory, the file is
402 return Boolean
.valueOf(f
.isDirectory());