org.tn5250j.tools.filters

Class XTFRFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

org.tn5250j.tools.filters.XTFRFileFilter

public class XTFRFileFilter
extends FileFilter

This is taken from Sun's demo ExampleFileFiler.java 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(); XTFRFileFilter filter = new XTFRFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);

Version:

1.10 05/17/01

Author:

Jeff Dinkins

Constructor Summary

Constructors

Constructor and Description
XTFRFileFilter() Creates a file filter.
XTFRFileFilter(String extension) Creates a file filter that accepts files with the given extension.
XTFRFileFilter(String[] filters) Creates a file filter from the given string array.
XTFRFileFilter(String[] filters, String description) Creates a file filter from the given string array and description.
XTFRFileFilter(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 .
String	getExtension(String filename)
OutputFilterInterface	getOutputFilterInstance()
boolean	isExtensionInList(String filename)
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.
String	setExtension(File f) Set the extension to be used for this type if one is not provided This will append the first key of the filter contained in the list
String	setExtension(String f)
void	setExtensionListInDescription(boolean b) Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
void	setOutputFilterName(String className)

Methods inherited from class java.lang.Object

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

Constructor Detail

XTFRFileFilter

public XTFRFileFilter()

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

See Also:

addExtension(java.lang.String)

XTFRFileFilter

public XTFRFileFilter(String extension)

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

Parameters:

extension - an extension

XTFRFileFilter

public XTFRFileFilter(String extension,
                      String description)

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

Parameters:

extension - an extension

description - a description

XTFRFileFilter

public XTFRFileFilter(String[] filters)

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

Parameters:

filters - some filter

XTFRFileFilter

public XTFRFileFilter(String[] filters,
                      String description)

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

Parameters:

filters - some filter

description - a description

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

Returns:

flag

getExtension

public String getExtension(File f)

Return the extension portion of the file's name .

Parameters:

f - file

Returns:

string

getExtension

public String getExtension(String filename)

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

Parameters:

extension - an 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:

string

setDescription

public void setDescription(String description)

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

Parameters:

description - a description

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

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:

flag

setExtension

public String setExtension(File f)

Set the extension to be used for this type if one is not provided This will append the first key of the filter contained in the list

Parameters:

f - file

Returns:

string

setExtension

public String setExtension(String f)

isExtensionInList

public boolean isExtensionInList(String filename)

setOutputFilterName

public void setOutputFilterName(String className)

getOutputFilterInstance

public OutputFilterInterface getOutputFilterInstance()