VdexReload 1.1.3 API

uk.ac.reload.dweezil.gui
Class ReloadFileFilter

java.lang.Object
  extended byjavax.swing.filechooser.FileFilter
      extended byuk.ac.reload.dweezil.gui.ReloadFileFilter

public class ReloadFileFilter
extends javax.swing.filechooser.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 Macintosh. Case is ignored. Example - create a new filter that filters out all files but gif and jpg image files: JFileChooser chooser = new JFileChooser(); ToomolFileFilter filter = new ToomolFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);


Constructor Summary
ReloadFileFilter()
          Creates a file filter.
ReloadFileFilter(java.lang.String extension)
          Creates a file filter that accepts files with the given extension.
ReloadFileFilter(java.lang.String[] filters)
          Creates a file filter from the given string array.
ReloadFileFilter(java.lang.String[] filters, java.lang.String description)
          Creates a file filter from the given string array and description.
ReloadFileFilter(java.lang.String extension, java.lang.String description)
          Creates a file filter that accepts the given file type.
 
Method Summary
 boolean accept(java.io.File f)
          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 .
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReloadFileFilter

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

See Also:
addExtension(java.lang.String)

ReloadFileFilter

public ReloadFileFilter(java.lang.String extension)
Creates a file filter that accepts files with the given extension. Example: new ToomolFileFilter("jpg");

Parameters:
extension - the given file extension
See Also:
addExtension(java.lang.String)

ReloadFileFilter

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

Parameters:
extension - the given file extension
description - the given file description
See Also:
addExtension(java.lang.String)

ReloadFileFilter

public ReloadFileFilter(java.lang.String[] filters)
Creates a file filter from the given string array. Example: new ToomolFileFilter(String {"gif", "jpg"}); Note that the "." before the extension is not needed and will be ignored.

Parameters:
filters - the given string array from which a file filter is created
See Also:
addExtension(java.lang.String)

ReloadFileFilter

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

Parameters:
filters - the given string array from which a file filter is created
description - the given file description
See Also:
addExtension(java.lang.String)
Method Detail

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.

Parameters:
f - the given file
See Also:
getExtension(java.io.File), FileFilter.accept(java.io.File)

getExtension

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

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

Parameters:
extension - the given file extension

getDescription

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

Returns:
the human readable description of this filter
See Also:
setDescription(java.lang.String), setExtensionListInDescription(boolean), isExtensionListInDescription()

setDescription

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

Parameters:
description - the human readable description of this filter
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 - true if the extension list should be shown up in the human readable description, 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 should be shown up in the human readable description, false otherwise
See Also:
getDescription(), setDescription(java.lang.String), setExtensionListInDescription(boolean)

VdexReload 1.1.3 API