001/* FileChooserUI.java -- 002 Copyright (C) 2002, 2003, 2004 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.plaf; 040 041import java.io.File; 042 043import javax.swing.JFileChooser; 044import javax.swing.filechooser.FileFilter; 045import javax.swing.filechooser.FileView; 046 047/** 048 * An abstract base class for delegates that implement the pluggable 049 * look and feel for a <code>JFileChooser</code>. 050 * 051 * @see javax.swing.JFileChooser 052 * 053 * @author Andrew Selkirk (aselkirk@sympatico.ca) 054 * @author Sascha Brawer (brawer@dandelis.ch) 055 */ 056public abstract class FileChooserUI extends ComponentUI 057{ 058 /** 059 * Constructs a new <code>FileChooserUI</code>. 060 */ 061 public FileChooserUI() 062 { 063 // Nothing to do here. 064 } 065 066 067 /** 068 * Returns a <code>FileFilter</code> that accepts every file. While 069 * the filtering itself is not specific to any look and feel, the 070 * text returned by <code>FileFilter.getDescription()</code> need 071 * not be the same across all look and feels. 072 * 073 * @param chooser the <code>JFileChooser</code> for which 074 * a <code>FileFilter</code> is requested. 075 * 076 * @see javax.swing.JFileChooser#getAcceptAllFileFilter 077 * @see javax.swing.filechooser.FileFilter#getDescription 078 */ 079 public abstract FileFilter getAcceptAllFileFilter(JFileChooser chooser); 080 081 082 /** 083 * Returns a view to a file, which is able to retrieve its name, 084 * icon, and other properties that are relevant for presenting 085 * the file to the user. 086 * 087 * @param chooser the <code>JFileChooser</code> for which 088 * a <code>FileFilter</code> is requested. 089 */ 090 public abstract FileView getFileView(JFileChooser chooser); 091 092 093 /** 094 * Determines which text is appropriate for the approve button 095 * according to the design guidelines of the implemented 096 * look and feel. 097 * 098 * @param chooser the <code>JFileChooser</code> whose 099 * button text is requested. 100 * 101 * @see javax.swing.JFileChooser#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.JFileChooser#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}