Home » openjdk-7 » javax » swing » filechooser » [javadoc | source]

    1   /*
    2    * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Oracle designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Oracle in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22    * or visit www.oracle.com if you need additional information or have any
   23    * questions.
   24    */
   25   
   26   package javax.swing.filechooser;
   27   
   28   import java.io.File;
   29   
   30   /**
   31    * <code>FileFilter</code> is an abstract class used by {@code JFileChooser}
   32    * for filtering the set of files shown to the user. See
   33    * {@code FileNameExtensionFilter} for an implementation that filters using
   34    * the file name extension.
   35    * <p>
   36    * A <code>FileFilter</code>
   37    * can be set on a <code>JFileChooser</code> to
   38    * keep unwanted files from appearing in the directory listing.
   39    * For an example implementation of a simple file filter, see
   40    * <code><i>yourJDK</i>/demo/jfc/FileChooserDemo/ExampleFileFilter.java</code>.
   41    * For more information and examples see
   42    * <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/filechooser.html">How to Use File Choosers</a>,
   43    * a section in <em>The Java Tutorial</em>.
   44    *
   45    * @see FileNameExtensionFilter
   46    * @see javax.swing.JFileChooser#setFileFilter
   47    * @see javax.swing.JFileChooser#addChoosableFileFilter
   48    *
   49    * @author Jeff Dinkins
   50    */
   51   public abstract class FileFilter {
   52       /**
   53        * Whether the given file is accepted by this filter.
   54        */
   55       public abstract boolean accept(File f);
   56   
   57       /**
   58        * The description of this filter. For example: "JPG and GIF Images"
   59        * @see FileView#getName
   60        */
   61       public abstract String getDescription();
   62   }

Home » openjdk-7 » javax » swing » filechooser » [javadoc | source]