001 /*
002 * Copyright 1998-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.swing.filechooser;
027
028 import java.io.File;
029 import javax.swing.*;
030
031 /**
032 * <code>FileView</code> defines an abstract class that can be implemented
033 * to provide the filechooser with UI information for a <code>File</code>.
034 * Each L&F <code>JFileChooserUI</code> object implements this
035 * class to pass back the correct icons and type descriptions specific to
036 * that L&F. For example, the Microsoft Windows L&F returns the
037 * generic Windows icons for directories and generic files.
038 * Additionally, you may want to provide your own <code>FileView</code> to
039 * <code>JFileChooser</code> to return different icons or additional
040 * information using {@link javax.swing.JFileChooser#setFileView}.
041 *
042 * <p>
043 *
044 * <code>JFileChooser</code> first looks to see if there is a user defined
045 * <code>FileView</code>, if there is, it gets type information from
046 * there first. If <code>FileView</code> returns <code>null</code> for
047 * any method, <code>JFileChooser</code> then uses the L&F specific
048 * view to get the information.
049 * So, for example, if you provide a <code>FileView</code> class that
050 * returns an <code>Icon</code> for JPG files, and returns <code>null</code>
051 * icons for all other files, the UI's <code>FileView</code> will provide
052 * default icons for all other files.
053 *
054 * <p>
055 *
056 * For an example implementation of a simple file view, see
057 * <code><i>yourJDK</i>/demo/jfc/FileChooserDemo/ExampleFileView.java</code>.
058 * For more information and examples see
059 * <a
060 href="http://java.sun.com/docs/books/tutorial/uiswing/components/filechooser.html">How to Use File Choosers</a>,
061 * a section in <em>The Java Tutorial</em>.
062 *
063 * @see javax.swing.JFileChooser
064 *
065 * @version 1.26 05/05/07
066 * @author Jeff Dinkins
067 *
068 */
069 public abstract class FileView {
070 /**
071 * The name of the file. Normally this would be simply
072 * <code>f.getName()</code>.
073 */
074 public String getName(File f) {
075 return null;
076 };
077
078 /**
079 * A human readable description of the file. For example,
080 * a file named <i>jag.jpg</i> might have a description that read:
081 * "A JPEG image file of James Gosling's face".
082 */
083 public String getDescription(File f) {
084 return null;
085 }
086
087 /**
088 * A human readable description of the type of the file. For
089 * example, a <code>jpg</code> file might have a type description of:
090 * "A JPEG Compressed Image File"
091 */
092 public String getTypeDescription(File f) {
093 return null;
094 }
095
096 /**
097 * The icon that represents this file in the <code>JFileChooser</code>.
098 */
099 public Icon getIcon(File f) {
100 return null;
101 }
102
103 /**
104 * Whether the directory is traversable or not. This might be
105 * useful, for example, if you want a directory to represent
106 * a compound document and don't want the user to descend into it.
107 */
108 public Boolean isTraversable(File f) {
109 return null;
110 }
111
112 }
|