Source for javax.swing.filechooser.FileView

   1: /* FileView.java --
   2:    Copyright (C) 2002, 2004, 2005, 2006,  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   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)
   9: any later version.
  10: 
  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.
  15: 
  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
  19: 02110-1301 USA.
  20: 
  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
  24: combination.
  25: 
  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. */
  37: 
  38: 
  39: package javax.swing.filechooser;
  40: 
  41: import java.io.File;
  42: 
  43: import javax.swing.Icon;
  44: 
  45: /**
  46:  * An abstract class that provides presentation information about files and 
  47:  * directories.  .
  48:  * 
  49:  * @author  Andrew Selkirk
  50:  */
  51: public abstract class FileView 
  52: {
  53: 
  54:   /**
  55:    * Creates a new <code>FileView</code> instance.
  56:    */
  57:   public FileView() 
  58:   {
  59:     // Nothing to do here.
  60:   } 
  61: 
  62:   /**
  63:    * Returns the name for the specified file.  This method always returns
  64:    * <code>null</code> and should be overridden by subclasses.
  65:    * 
  66:    * @param file  the file.
  67:    * 
  68:    * @return Always <code>null</code>.
  69:    */
  70:   public String getName(File file) 
  71:   {
  72:     return null;
  73:   } 
  74: 
  75:   /**
  76:    * Returns a description for the specified file.  This method always returns
  77:    * <code>null</code> and should be overridden by subclasses.
  78:    * 
  79:    * @param file  the file.
  80:    * 
  81:    * @return Always <code>null</code>.
  82:    */
  83:   public String getDescription(File file) 
  84:   {
  85:     return null;
  86:   } 
  87: 
  88:   /**
  89:    * Returns a description for the type of the specified file.  This method 
  90:    * always returns <code>null</code> and should be overridden by subclasses.
  91:    * 
  92:    * @param file  the file.
  93:    * 
  94:    * @return Always <code>null</code>.
  95:    */
  96:   public String getTypeDescription(File file) 
  97:   {
  98:     return null;
  99:   } 
 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: }