001/* FileView.java --
002   Copyright (C) 2002, 2004, 2005, 2006,  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.filechooser;
040
041import java.io.File;
042
043import javax.swing.Icon;
044
045/**
046 * An abstract class that provides presentation information about files and 
047 * directories.  .
048 * 
049 * @author  Andrew Selkirk
050 */
051public abstract class FileView 
052{
053
054  /**
055   * Creates a new <code>FileView</code> instance.
056   */
057  public FileView() 
058  {
059    // Nothing to do here.
060  } 
061
062  /**
063   * Returns the name for the specified file.  This method always returns
064   * <code>null</code> and should be overridden by subclasses.
065   * 
066   * @param file  the file.
067   * 
068   * @return Always <code>null</code>.
069   */
070  public String getName(File file) 
071  {
072    return null;
073  } 
074
075  /**
076   * Returns a description for the specified file.  This method always returns
077   * <code>null</code> and should be overridden by subclasses.
078   * 
079   * @param file  the file.
080   * 
081   * @return Always <code>null</code>.
082   */
083  public String getDescription(File file) 
084  {
085    return null;
086  } 
087
088  /**
089   * Returns a description for the type of the specified file.  This method 
090   * always returns <code>null</code> and should be overridden by subclasses.
091   * 
092   * @param file  the file.
093   * 
094   * @return Always <code>null</code>.
095   */
096  public String getTypeDescription(File file) 
097  {
098    return null;
099  } 
100
101  /**
102   * Returns an {@link Icon} to represent the specified file.  This method 
103   * always returns <code>null</code> and should be overridden by subclasses.
104   * 
105   * @param file  the file.
106   * 
107   * @return Always <code>null</code>.
108   */
109  public Icon getIcon(File file) 
110  {
111    return null;
112  } 
113
114  /**
115   * Returns {@link Boolean#TRUE} if the given directory is traversable, and
116   * {@link Boolean#FALSE} if it is not.  This method always returns 
117   * <code>null</code> and should be overridden by subclasses.
118   * 
119   * @param directory  the directory.
120   * 
121   * @return Always <code>null</code>.
122   */
123  public Boolean isTraversable(File directory) 
124  {
125    return null;
126  } 
127
128}