libjava/javax/swing/plaf/FileChooserUI.java

   1 /* FileChooserUI.java --
   2    Copyright (C) 2002, 2003, 2004  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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.plaf;
  40
  41 import java.io.File;
  42
  43 import javax.swing.JFileChooser;
  44 import javax.swing.filechooser.FileFilter;
  45 import javax.swing.filechooser.FileView;
  46
  47 /**
  48  * An abstract base class for delegates that implement the pluggable
  49  * look and feel for a <code>JFileChooser</code>.
  50  *
  51  * @see javax.swing.JFileChooser
  52  *
  53  * @author Andrew Selkirk (aselkirk@sympatico.ca)
  54  * @author Sascha Brawer (brawer@dandelis.ch)
  55  */
  56 public abstract class FileChooserUI
  57   extends ComponentUI
  58 {
  59   /**
  60    * Constructs a new <code>FileChooserUI</code>.
  61    */
  62   public FileChooserUI()
  63   {
  64   }
  65
  66
  67   /**
  68    * Returns a <code>FileFilter</code> that accepts every file.  While
  69    * the filtering itself is not specific to any look and feel, the
  70    * text returned by <code>FileFilter.getDescription()</code> need
  71    * not be the same across all look and feels.
  72    *
  73    * @param chooser the <code>JFileChooser</code> for which
  74    *        a <code>FileFilter</code> is requested.
  75    *
  76    * @see javax.swing.JFileChooser#getAcceptAllFileFilter
  77    * @see javax.swing.filechooser.FileFilter#getDescription
  78    */
  79   public abstract FileFilter getAcceptAllFileFilter(JFileChooser chooser);
  80
  81
  82   /**
  83    * Returns a view to a file, which is able to retrieve its name,
  84    * icon, and other properties that are relevant for presenting
  85    * the file to the user.
  86    *
  87    * @param chooser the <code>JFileChooser</code> for which
  88    *        a <code>FileFilter</code> is requested.
  89    */
  90   public abstract FileView getFileView(JFileChooser chooser);
  91
  92
  93   /**
  94    * Determines which text is appropriate for the approve button
  95    * according to the design guidelines of the implemented
  96    * look and feel.
  97    *
  98    * @param chooser the <code>JFileChooser</code> whose
  99    *        button text is requested.
 100    *
 101    * @see javax.swing.JFileChoose#getApproveButtonText
 102    */
 103   public abstract String getApproveButtonText(JFileChooser chooser);
 104
 105
 106   /**
 107    * Determines which text is appropriate for the title bar of a
 108    * <code>JFileChooser</code> according to the design guidelines of
 109    * the implemented look and feel.
 110    *
 111    * @param chooser the <code>JFileChooser</code> whose
 112    *        dialog title is requested.
 113    *
 114    * @see javax.swing.JFileChoose#getDialogtitle
 115    */
 116   public abstract String getDialogTitle(JFileChooser chooser);
 117
 118
 119   /**
 120    * Refreshes the currently displayed directory.
 121    *
 122    * @param chooser the <code>JFileChooser</code> whose
 123    *        dialog title needs re-scanning.
 124    */
 125   public abstract void rescanCurrentDirectory(JFileChooser chooser);
 126
 127
 128   /**
 129    * Ensures that a specified file is visible in the
 130    * <code>JFileChooser</code>
 131    *
 132    * @param chooser the <code>JFileChooser</code> that
 133    *        should display the file <code>file</code>.
 134    *
 135    * @param file the file that needs to be made visible.
 136    */
 137   public abstract void ensureFileIsVisible(JFileChooser chooser, File file);
 138 }