Package com.cosylab.vdct.util

Class UniversalFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

com.cosylab.vdct.util.UniversalFileFilter

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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

UniversalFileFilter

public UniversalFileFilter()

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

See Also:

addExtension(java.lang.String)

UniversalFileFilter

public UniversalFileFilter(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 - filters

See Also:

addExtension(java.lang.String)

UniversalFileFilter

public UniversalFileFilter(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 - filters

description - description

See Also:

addExtension(java.lang.String)

UniversalFileFilter

public UniversalFileFilter(String extension)

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

Parameters:

extension - extension

See Also:

addExtension(java.lang.String)

UniversalFileFilter

public UniversalFileFilter(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 - extension

description - description

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 - f

Returns:

something

See Also:

getExtension(java.io.File), 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 - 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:

something

See Also:

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

getExtension

public String getExtension(File f)

Return the extension portion of the file's name .

Parameters:

f - f

Returns:

something

See Also:

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

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:

something

See Also:

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

setDescription

public void setDescription(String description)

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

Parameters:

description - description

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

Parameters:

b - b

See Also:

getDescription(), setDescription(java.lang.String), isExtensionListInDescription()