net.sf.magicproject.tools
Class FileFilterPlus

java.lang.Object
  javax.swing.filechooser.FileFilter
      net.sf.magicproject.tools.FileFilterPlus

All Implemented Interfaces:

java.io.FileFilter

public class FileFilterPlus
extends javax.swing.filechooser.FileFilter
implements java.io.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 ,png and jpg image files: JFileChooser chooser = new JFileChooser(); FileFilterPlus filter = new FileFilterPlus( new String{"gif", "jpg", "png"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);

Version:

1.15 11/01/03

Author:

Jeff Dinkins, Fabrice Daugan (has only changed the originaly name of this class)

Constructor Summary

FileFilterPlus()
Creates a file filter.

FileFilterPlus(java.lang.String extension)
Creates a file filter that accepts files with the given extension.

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

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

FileFilterPlus(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()
java.lang.String	getExtension(java.io.File fiile) Return the extension part 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

FileFilterPlus

public FileFilterPlus()

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

FileFilterPlus

public FileFilterPlus(java.lang.String extension)

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

Parameters:

extension - the filter extension.

See Also:

addExtension(String)

FileFilterPlus

public FileFilterPlus(java.lang.String extension,
                      java.lang.String description)

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

Parameters:

extension - the filter extension.

description - the filter description.

See Also:

addExtension(String)

FileFilterPlus

public FileFilterPlus(java.lang.String[] filters)

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

Parameters:

filters - set of allowed filters.

See Also:

addExtension(String)

FileFilterPlus

public FileFilterPlus(java.lang.String[] filters,
                      java.lang.String description)

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

Parameters:

filters - set of allowed filters.

description - file filter 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 interface java.io.FileFilter

Specified by:

accept in class javax.swing.filechooser.FileFilter

Parameters:

f - is the file to verify

Returns:

true if this file should be shown in the directory pane, false if it shouldn't.

See Also:

getExtension(File)

getExtension

public java.lang.String getExtension(java.io.File fiile)

Return the extension part of the file's name .

Parameters:

fiile - the fulle file.

Returns:

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

Parameters:

extension - the filter extension.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class javax.swing.filechooser.FileFilter

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 - the filter 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 relevent if a description was provided in the constructor or using setDescription();

Parameters:

b - ?

See Also:

FileFilter.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 relevent if a description was provided in the constructor or using setDescription();

Returns:

true if use extensions in description

See Also:

FileFilter.getDescription(), setDescription(String), setExtensionListInDescription(boolean)