ptolemy.gui

Class ExtensionFilenameFilter

java.lang.Object

javax.swing.filechooser.FileFilter

ptolemy.gui.PtFilenameFilter

ptolemy.gui.ExtensionFilenameFilter

All Implemented Interfaces:

java.io.FilenameFilter

public class ExtensionFilenameFilter
extends PtFilenameFilter

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.

Extension - create a new filter that filters out all files but gif and jpg image files:

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

Note that as of Java 1.6, there is a FileNameExtensionFilter which replaces this class. See http://download.oracle.com/javase/6/docs/api/javax/swing/filechooser/FileNameExtensionFilter.html However, this class can be used with both java.awt.FileDialog and javax.swing.JFileChooser because it implements java.io.FilenameFilter and extends javax.swing.FilenameFilter.

Since:

Ptolemy II 10.0

Version:

$Id: ExtensionFilenameFilter.java 69607 2014-07-30 17:07:26Z cxh $, $Id: ExtensionFilenameFilter.java 69607 2014-07-30 17:07:26Z cxh $

Author:

Jeff Dinkins

Constructor Summary

Constructors

Constructor and Description
ExtensionFilenameFilter() Creates a file filter.
ExtensionFilenameFilter(java.util.List<java.lang.String> extensions) Construct a file filter that filters out all files that do not have one of the extensions in the given list.
ExtensionFilenameFilter(java.lang.String extension) Creates a file filter that accepts files with the given extension.
ExtensionFilenameFilter(java.lang.String[] filters) Creates a file filter from the given string array.
ExtensionFilenameFilter(java.lang.String[] filters, java.lang.String description) Creates a file filter from the given string array and description.
ExtensionFilenameFilter(java.lang.String extension, java.lang.String description) Creates a file filter that accepts the given file type.

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File f) Return true if this file should be shown in the directory pane, false if it shouldn't.
boolean	accept(java.io.File directory, java.lang.String name) Return true if this file should be shown in the directory pane, false if it shouldn't.
void	addExtension(java.lang.String extension) Add a filetype "dot" extension to filter against.
java.lang.String	getDefaultExtension() If the filter contains only one extension, return the extension name.
java.lang.String	getDescription() Return 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() Return true if the extension list (.jpg, .gif, etc) should show up in the human readable description.
void	setDescription(java.lang.String description) Set the human readable description of this filter.
void	setExtensionListInDescription(boolean useExtensionListInDescription) Determine whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
java.lang.String	toString() Return a string description of this filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionFilenameFilter

public ExtensionFilenameFilter()

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

See Also:

addExtension(String)

ExtensionFilenameFilter

public ExtensionFilenameFilter(java.lang.String extension)

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

Parameters:

extension - The file name extension with no leading period ('.').

See Also:

addExtension(String)

ExtensionFilenameFilter

public ExtensionFilenameFilter(java.lang.String extension,
                               java.lang.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.

Parameters:

extension - The file name extension with no leading period ('.').

description - A description of this file filter.

See Also:

addExtension(String)

ExtensionFilenameFilter

public ExtensionFilenameFilter(java.lang.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.

Parameters:

filters - An array of file extensions.

See Also:

addExtension(String)

ExtensionFilenameFilter

public ExtensionFilenameFilter(java.lang.String[] filters,
                               java.lang.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.

Parameters:

filters - An array of file extensions.

description - A description of this file filter.

See Also:

addExtension(String)

ExtensionFilenameFilter

public ExtensionFilenameFilter(java.util.List<java.lang.String> extensions)

Construct a file filter that filters out all files that do not have one of the extensions in the given list.

Parameters:

extensions - A list of extensions, each of which is a 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.

This method is used by javax.swing.JFileChoosers.

Overrides:

accept in class PtFilenameFilter

Parameters:

f - The file to be checked.

Returns:

True if the argument is a directory or if the the extension of the file matches one of the extensions.

See Also:

accept(File, String), getExtension(File), FileFilter.accept(File)

accept

public boolean accept(java.io.File directory,
                      java.lang.String name)

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

Files that begin with "." are ignored.

This method is used by java.awt.FileDialog.

Specified by:

accept in interface java.io.FilenameFilter

Overrides:

accept in class PtFilenameFilter

Parameters:

directory - The directory in which the file was found.

name - The name of the file.

Returns:

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

See Also:

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

addExtension

public void addExtension(java.lang.String extension)

Add 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.

Parameters:

extension - The extension to be added.

getDefaultExtension

public java.lang.String getDefaultExtension()

If the filter contains only one extension, return the extension name. Otherwise, return null.

Returns:

The default extension.

getDescription

public java.lang.String getDescription()

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

Overrides:

getDescription in class PtFilenameFilter

Returns:

The human readable description of this filter.

See Also:

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

getExtension

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

Return the extension portion of the file's name.

Parameters:

f - The file.

Returns:

the extension portion of the name of the file or null if the argument is null.

isExtensionListInDescription

public boolean isExtensionListInDescription()

Return true if 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 (.jpg, .gif, etc) should show up in the human readable description.

See Also:

getDescription()

setDescription

public void setDescription(java.lang.String description)

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

Parameters:

description - The human readable description of this filter.

See Also:

getDescription(), setExtensionListInDescription(boolean), isExtensionListInDescription()

setExtensionListInDescription

public void setExtensionListInDescription(boolean useExtensionListInDescription)

Determine whether the extension list (.jpg, .gif, etc) should show up in the human readable description. This method is only relevant if a description was provided in the constructor or using setDescription();

Parameters:

useExtensionListInDescription - True if the list of extensions should appear in the human readable description.

See Also:

getDescription(), isExtensionListInDescription()

toString

public java.lang.String toString()

Return a string description of this filter.

Overrides:

toString in class java.lang.Object

See Also:

getDescription()