Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

jsource.io
Class JSourceFileFilter  view JSourceFileFilter download JSourceFileFilter.java

java.lang.Object
  extended byjavax.swing.filechooser.FileFilter
      extended byjsource.io.JSourceFileFilter

public class JSourceFileFilter
extends javax.swing.filechooser.FileFilter

JSourceFileFilter is a convenience implementation of FileFilter that filters out all files except for those type extensions that it knows about. Extensions are of the type ".foo", which is typically found on Windows and Unix boxes, but not on Macinthosh. Case is ignored. Example - create a new filter that filerts out all files but html and htm web page files:

     JFileChooser chooser = new JFileChooser();
     String extensions[] = new String[2];
     extensions[0] = "html";
     extensions[1] = "htm";
     JSourceFileFilter filter = new JSourceFileFilter(extensions, "Web pages");
     chooser.addChoosableFileFilter(filter);
     chooser.showOpenDialog(this);
 


Field Summary
protected static java.lang.String[] _jth998tkn001
           
private  java.lang.String description
           
private  java.util.Hashtable filters
           
private  java.lang.String fullDescription
           
private static java.lang.String HIDDEN_FILE
           
private static java.lang.String TYPE_UNKNOWN
           
private  boolean useExtensionsInDescription
           
 
Constructor Summary
JSourceFileFilter()
          Creates a file filter.
JSourceFileFilter(java.lang.String extension)
          Creates a file filter that accepts files with the given extension.
JSourceFileFilter(java.lang.String[] filters)
          Creates a file filter from the given string array.
JSourceFileFilter(java.lang.String[] filters, java.lang.String description)
          Creates a file filter from the given string array and description.
JSourceFileFilter(java.lang.String extension, java.lang.String description)
          Creates a file filter that accepts the given file type.
 
Method Summary
 boolean accept(java.io.File f)
          Return true if this file should be shown in the directory pane, false if it shouldn't.
 void addExtension(java.lang.String extension)
          Adds a filetype "dot" extension to filter against.
 java.lang.String getDescription()
          Returns the human readable description of this filter.
 java.lang.String getExtension(java.io.File f)
          Return the extension portion of the file's name .
 boolean isExtensionListInDescription()
          Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
 void setDescription(java.lang.String description)
          Sets the human readable description of this filter.
 void setExtensionListInDescription(boolean b)
          Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_UNKNOWN

private static java.lang.String TYPE_UNKNOWN

HIDDEN_FILE

private static java.lang.String HIDDEN_FILE

filters

private java.util.Hashtable filters

description

private java.lang.String description

fullDescription

private java.lang.String fullDescription

useExtensionsInDescription

private boolean useExtensionsInDescription

_jth998tkn001

protected static java.lang.String[] _jth998tkn001
Constructor Detail

JSourceFileFilter

public JSourceFileFilter()
Creates a file filter. If no filters are added, then all files are accepted.


JSourceFileFilter

public JSourceFileFilter(java.lang.String extension)
Creates a file filter that accepts files with the given extension. Example: new JSourceFileFilter("html");


JSourceFileFilter

public JSourceFileFilter(java.lang.String extension,
                         java.lang.String description)
Creates a file filter that accepts the given file type. Example: new JSourceFileFilter("html", "Web pages"); Note that the "." before the extension is not needed. If provided, it will be ignored.


JSourceFileFilter

public JSourceFileFilter(java.lang.String[] filters)
Creates a file filter from the given string array. Example: new JSourceFileFilter(String {"html", "htm"}); Note that the "." before the extension is not needed and will be ignored.


JSourceFileFilter

public JSourceFileFilter(java.lang.String[] filters,
                         java.lang.String description)
Creates a file filter from the given string array and description. Example: new JSourceFileFilter(String {"html", "htm"}, "Web pages"); Note that the "." before the extension is not needed and will be ignored.

Method Detail

accept

public boolean accept(java.io.File f)
Return true if this file should be shown in the directory pane, false if it shouldn't. Files that begin with "." are ignored.


getExtension

public java.lang.String getExtension(java.io.File f)
Return the extension portion of the file's name .


addExtension

public void addExtension(java.lang.String extension)
Adds a filetype "dot" extension to filter against. For example: the following code will create a filter that filters out all files except those that end in ".jpg" and ".tif":
   JSourceFileFilter filter = new JSourceFileFilter();
   filter.addExtension("jpg");
   filter.addExtension("tif");
 
Note that the "." before the extension is not needed and will be ignored.


getDescription

public java.lang.String getDescription()
Returns the human readable description of this filter. For example: "JPEG and GIF Image Files (*.jpg, *.gif)"


setDescription

public void setDescription(java.lang.String description)
Sets the human readable description of this filter. For example: filter.setDescription("Gif and JPG Images");


setExtensionListInDescription

public void setExtensionListInDescription(boolean b)
Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description. Only relevent if a description was provided in the constructor or using setDescription();


isExtensionListInDescription

public boolean isExtensionListInDescription()
Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description. Only relevent if a description was provided in the constructor or using setDescription();