deadbeef.Tools
Class JFileFilter

java.lang.Object
  extended by javax.swing.filechooser.FileFilter
      extended by deadbeef.Tools.JFileFilter

public class JFileFilter
extends javax.swing.filechooser.FileFilter

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 gif and jpg image files:

JFileChooser chooser = new JFileChooser(); JFileFilter filter = new JFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);

Version:
1.14 01/23/03
Author:
Jeff Dinkins

Constructor Summary
JFileFilter()
          Creates a file filter.
JFileFilter(java.lang.String extension)
          Creates a file filter that accepts files with the given extension.
JFileFilter(java.lang.String[] filters)
          Creates a file filter from the given string array.
JFileFilter(java.lang.String[] filters, java.lang.String description)
          Creates a file filter from the given string array and description.
JFileFilter(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 file type "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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JFileFilter

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

See Also:
addExtension(String)

JFileFilter

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

Parameters:
extension - string containing file extension
See Also:
addExtension(String)

JFileFilter

public JFileFilter(java.lang.String extension,
                   java.lang.String description)
Creates a file filter that accepts the given file type. Example: new JFileFilter("jpg", "JPEG Image Images"); Note that the "." before the extension is not needed. If provided, it will be ignored.

Parameters:
extension - string containing file extension
description - string containing file description
See Also:
addExtension(String)

JFileFilter

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

Parameters:
filters - string array containing extensions
See Also:
addExtension(String)

JFileFilter

public JFileFilter(java.lang.String[] filters,
                   java.lang.String description)
Creates a file filter from the given string array and description. Example: new JFileFilter(String {"gif", "jpg"}, "Gif and JPG Images"); Note that the "." before the extension is not needed and will be ignored.

Parameters:
filters - string array containing extensions
description - string containing file description
See Also:
addExtension(String)
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.

Specified by:
accept in class javax.swing.filechooser.FileFilter
See Also:
getExtension(File), accept(File)

getExtension

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

Parameters:
f - File handle to get extension for
Returns:
extension as string (excluding the '.')
See Also:
getExtension(File), accept(File)

addExtension

public void addExtension(java.lang.String extension)
Adds a file type "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": JFileFilter filter = new JFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif"); Note that the "." before the extension is not needed and will be ignored.

Parameters:
extension - file extension (e.g. '.sup')

getDescription

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

Specified by:
getDescription in class javax.swing.filechooser.FileFilter
See Also:
setDescription(String), setExtensionListInDescription(boolean), isExtensionListInDescription(), getDescription()

setDescription

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

Parameters:
description - string containing file description
See Also:
setDescription(String), setExtensionListInDescription(boolean), isExtensionListInDescription()

setExtensionListInDescription

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

Parameters:
b - true if the extension list should show up in the human readable description
See Also:
getDescription(), setDescription(String), isExtensionListInDescription()

isExtensionListInDescription

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

Returns:
true if the extension list should show up in the human readable description
See Also:
getDescription(), setDescription(String), setExtensionListInDescription(boolean)