org.openorb.board.shared.dialog

Class FileFilter

public class FileFilter 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);

Author: Jeff Dinkins

Constructor Summary
FileFilter()
Creates a file filter.
FileFilter(String extension)
Creates a file filter that accepts files with the given extension.
FileFilter(String extension, String description)
Creates a file filter that accepts the given file type.
FileFilter(String[] filters)
Creates a file filter from the given string array.
FileFilter(String[] filters, String description)
Creates a file filter from the given string array and description.
Method Summary
booleanaccept(File f)
Return true if this file should be shown in the directory pane, false if it shouldn't.
voidaddExtension(String extension)
Adds a filetype "dot" extension to filter against.
StringgetDescription()
Returns the human readable description of this filter.
StringgetExtension(File f)
Return the extension portion of the file's name .
booleanisExtensionListInDescription()
Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
voidsetDescription(String description)
Sets the human readable description of this filter.
voidsetExtensionListInDescription(boolean b)
Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description.

Constructor Detail

FileFilter

public FileFilter()
Creates a file filter. If no filters are added, then all files are accepted.

FileFilter

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

FileFilter

public FileFilter(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.

FileFilter

public FileFilter(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.

FileFilter

public FileFilter(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.

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.

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.

getDescription

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

getExtension

public String getExtension(File f)
Return the extension portion of the file's name .

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();

setDescription

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

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();