net.hblok.io
Class ExtensionFileFilter

java.lang.Object
  javax.swing.filechooser.FileFilter
      net.hblok.io.ExtensionFileFilter

All Implemented Interfaces:

FileFilter

public class ExtensionFileFilter
extends FileFilter
implements 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 Macintosh. Case is ignored. Example - create a new filter that filters out all files but gif and jpg image files: JFileChooser chooser = new JFileChooser(); ExtensionFileFilter filter = new ExtensionFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);

Version:

1.9 04/23/99

Author:

Jeff Dinkins, Havard Rast Blok

Constructor Summary

ExtensionFileFilter()
Creates a file filter.

ExtensionFileFilter(String extension)
Creates a file filter that accepts files with the given extension.

ExtensionFileFilter(String[] filters)
Creates a file filter from the given string array.

ExtensionFileFilter(String[] filters, boolean exclude)

ExtensionFileFilter(String[] filters, String description)
Creates a file filter from the given string array and description.

ExtensionFileFilter(String extension, boolean exclude)

ExtensionFileFilter(String extension, String description)
Creates a file filter that accepts the given file type.

Method Summary

boolean	accept(File f) Return true if this file should be shown in the directory pane, false if it shouldn't.
void	addExtension(String extension) Adds a filetype "dot" extension to filter against.
String	getDescription() Returns the human readable description of this filter.
String	getExtension(File f) Return the extension portion of the file's name .
boolean	isExclude() Returns the exclude status of this filter.
boolean	isExtensionListInDescription() Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
boolean	isIncludeDirectories()
void	setDescription(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.
void	setIncludeDirectories(boolean includeDirectories)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionFileFilter

public ExtensionFileFilter()

Creates a file filter. If no filters are added, then all files are accepted.

See Also:

addExtension(java.lang.String)

ExtensionFileFilter

public ExtensionFileFilter(String extension)

Creates a file filter that accepts files with the given extension. Example: new ExtensionFileFilter("jpg");

See Also:

addExtension(java.lang.String)

ExtensionFileFilter

public ExtensionFileFilter(String extension,
                           boolean exclude)

ExtensionFileFilter

public ExtensionFileFilter(String extension,
                           String description)

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

See Also:

addExtension(java.lang.String)

ExtensionFileFilter

public ExtensionFileFilter(String[] filters)

Creates a file filter from the given string array. Example: new ExtensionFileFilter(String {"gif", "jpg"}); Note that the "." before the extension is not needed and will be ignored.

See Also:

addExtension(java.lang.String)

ExtensionFileFilter

public ExtensionFileFilter(String[] filters,
                           boolean exclude)

ExtensionFileFilter

public ExtensionFileFilter(String[] filters,
                           String description)

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

See Also:

addExtension(java.lang.String)

Method Detail

accept

public boolean accept(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 interface FileFilter

Specified by:

accept in class FileFilter

See Also:

getExtension(java.io.File), FileFilter.accept(File)

getExtension

public String getExtension(File f)

Return the extension portion of the file's name .

See Also:

getExtension(java.io.File), FileFilter.accept(java.io.File)

addExtension

public void addExtension(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": ExtensionFileFilter filter = new ExtensionFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif"); Note that the "." before the extension is not needed and will be ignored.

getDescription

public String getDescription()

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

Specified by:

getDescription in class FileFilter

See Also:

setDescription(java.lang.String), setExtensionListInDescription(boolean), isExtensionListInDescription()

setDescription

public void setDescription(String description)

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

See Also:

setDescription(java.lang.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();

See Also:

getDescription(), setDescription(java.lang.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();

See Also:

getDescription(), setDescription(java.lang.String), setExtensionListInDescription(boolean)

isIncludeDirectories

public boolean isIncludeDirectories()

Returns:

Returns the includeDirectories.

setIncludeDirectories

public void setIncludeDirectories(boolean includeDirectories)

Parameters:

includeDirectories - The includeDirectories to set.

isExclude

public boolean isExclude()

Returns the exclude status of this filter.

Returns:

true if extensions in this filter are excluded, and false if they are included in the filtering