com.highqsoft.fwk

Class FwkFileFilter

java.lang.Object

javax.swing.filechooser.FileFilter

com.highqsoft.fwk.FwkFileFilter

All Implemented Interfaces:

FwkComponentInterface, FwkFileFilterInterface

Direct Known Subclasses:

FwkSimpleASCIIColumnsReader, FwkSimpleASCIIColumnsWriter, LMSAscii, RpcIIIReader, UBH, UBHFileWriter

public class FwkFileFilter
extends javax.swing.filechooser.FileFilter
implements FwkComponentInterface, FwkFileFilterInterface

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 filters out all files but gif and jpg image files: JFileChooser chooser = new JFileChooser(); FwkFileFilter filter = new FwkFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);

Since:

$Date: 2017/04/28 08:47:40 $

Version:

$Revision: 1.14 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Constructor Summary

Constructors

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

Method Summary

Methods

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.net.URL url) Return true if this file should be shown in the directory pane, false if it shouldn't.
void	addExtension(java.lang.String extension) Adds a filetype "dot" extension to filter against.
java.lang.String	getDescription() Returns the human readable description of this filter.
java.lang.String	getExtension(java.io.File f) Return the extension portion of the file's name .
java.lang.String	getVersion()
boolean	isExtensionListInDescription() Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
void	setDescription(java.lang.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.
void	setPattern(java.lang.String pattern) Set a file pattern.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkFileFilter

public FwkFileFilter()

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

See Also:

addExtension(java.lang.String)

FwkFileFilter

public FwkFileFilter(java.lang.String extension)

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

Parameters:

extension - The extension to be filtered.

See Also:

addExtension(java.lang.String)

FwkFileFilter

public FwkFileFilter(java.lang.String extension,
             java.lang.String description)

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

Parameters:

extension - The extension to be filtered.

description - The description of the filters.

See Also:

addExtension(java.lang.String)

FwkFileFilter

public FwkFileFilter(java.lang.String[] filters)

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

Parameters:

filters - An array of filters to be applied.

See Also:

addExtension(java.lang.String)

FwkFileFilter

public FwkFileFilter(java.lang.String[] filters,
             java.lang.String description)

Creates a file filter from the given string array and description. Example: new FwkFileFilter(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 filters to be applied.

description - The description of the filters.

See Also:

addExtension(java.lang.String)

Method Detail

getVersion

public java.lang.String getVersion()

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.

Specified by:

accept in interface FwkFileFilterInterface

Specified by:

accept in class javax.swing.filechooser.FileFilter

Parameters:

file - The file to be checked.

Returns:

True id file is acepted.

See Also:

getExtension(java.io.File), FileFilter#accepts

accept

public boolean accept(java.net.URL url)

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 interface FwkFileFilterInterface

Parameters:

url - the URL to be checked.

Returns:

True id file is acepted.

See Also:

getExtension(java.io.File), FileFilter#accepts

getExtension

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

Return the extension portion of the file's name .

Parameters:

file - The file with the extension.

Returns:

The extension of the file.

See Also:

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

addExtension

public void addExtension(java.lang.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": FwkFileFilter filter = new FwkFileFilter(); 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 filtered.

setPattern

public void setPattern(java.lang.String pattern)

Set a file pattern. This pattern has a higher priority than the extension value.

Parameters:

pattern - a reg exp pattern for filename matches.

getDescription

public java.lang.String getDescription()

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

Specified by:

getDescription in interface FwkFileFilterInterface

Specified by:

getDescription in class javax.swing.filechooser.FileFilter

Returns:

The description of the filter.

See Also:

setDescription, setExtensionListInDescription, isExtensionListInDescription, FileFilter.getDescription()

setDescription

public void setDescription(java.lang.String description)

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

See Also:

setDescription, setExtensionListInDescription, 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 - Set to true if extensions shall appear in description.

See Also:

getDescription, setDescription, 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 extensions appear in description.

See Also:

getDescription, setDescription, setExtensionListInDescription