SonarVis.Metcast.MetcastUtilities

Class ExampleFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

SonarVis.Metcast.MetcastUtilities.ExampleFileFilter

public class ExampleFileFilter
extends 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(); ExampleFileFilter filter = new ExampleFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);

Version:

$Id: ExampleFileFilter.java 9106 2015-07-29 05:00:27Z brutzman $

Author:

Jeff Dinkins

Contact: Don Brutzman (web.nps.navy.mil/~brutzman) brutzman@nps.navy.mil

See Also:

FileImporter

Constructor Summary

Constructors

Constructor and Description
ExampleFileFilter() Creates a file filter.
ExampleFileFilter(String extension) Creates a file filter that accepts files with the given extension.
ExampleFileFilter(String[] filters) Creates a file filter from the given string array.
ExampleFileFilter(String[] filters, String description) Creates a file filter from the given string array and description.
ExampleFileFilter(String extension, String description) Creates a file filter that accepts the given file type.

Method Summary

Modifier and Type	Method and Description
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	isExtensionListInDescription() Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleFileFilter

public ExampleFileFilter()

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

See Also:

addExtension(java.lang.String)

ExampleFileFilter

public ExampleFileFilter(String extension)

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

Parameters:

extension - String of a file extension.

See Also:

addExtension(java.lang.String)

ExampleFileFilter

public ExampleFileFilter(String extension,
                         String description)

Creates a file filter that accepts the given file type. Example: new ExampleFileFilter("jpg", "JPEG Image Images");

Note that the "." before the extension is not needed. If provided, it will be ignored.

Parameters:

extension - String of a file extension.

description - A description of a file extension.

See Also:

addExtension(java.lang.String)

ExampleFileFilter

public ExampleFileFilter(String[] filters)

Creates a file filter from the given string array. Example: new ExampleFileFilter(String {"gif", "jpg"});

Note that the "." before the extension is not needed adn will be ignored.

Parameters:

filters - String array.

See Also:

addExtension(java.lang.String)

ExampleFileFilter

public ExampleFileFilter(String[] filters,
                         String description)

Creates a file filter from the given string array and description. Example: new ExampleFileFilter(String {"gif", "jpg"}, "Gif and JPG Images");

Note that the "." before the extension is not needed and will be ignored.

Parameters:

filters - String array.

description - A description of a file extension.

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 class FileFilter

Parameters:

f - A file which is given.

Returns:

'true' if this file should be shown in the directory pane; 'false' otherwise.

See Also:

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

getExtension

public String getExtension(File f)

Return the extension portion of the file's name .

Parameters:

f - A file that needs to get extension.

Returns:

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":

ExampleFileFilter filter = new ExampleFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif");

Note that the "." before the extension is not needed and will be ignored.

Parameters:

extension - String of a file extension.

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

Returns:

The description of file.

See Also:

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

setDescription

public void setDescription(String description)

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

Parameters:

description - String of a file description.

See Also:

getDescription(), 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 - 'true' if the extension list should show up; 'false' otherwise.

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

Returns:

'true' if the extension list (.jpg, .gif, etc) show up; 'false' otherwise.

See Also:

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