examples.filechooser
Class VemaxsFileFilter

java.lang.Object
  |
  +--javax.swing.filechooser.FileFilter
        |
        +--examples.filechooser.VemaxsFileFilter

public class VemaxsFileFilter
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
Version: 1.12 12/03/01

Field Summary
 private Stringdescription
           
 private Hashtablefilters
           
 private StringfullDescription
           
 private static StringHIDDEN_FILE
           
 private final static Loggerlog
           
 private static StringTYPE_UNKNOWN
           
 private booleanuseExtensionsInDescription
           

Constructor Summary
VemaxsFileFilter()
          Creates a file filter.
VemaxsFileFilter(String extension)
          Creates a file filter that accepts files with the given extension.
VemaxsFileFilter(String extension, String description)
          Creates a file filter that accepts the given file type.
VemaxsFileFilter(String[] filters)
          Creates a file filter from the given string array.
VemaxsFileFilter(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.


Methods inherited from class java.lang.Object
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize

Field Detail

description

private String description

filters

private Hashtable filters

fullDescription

private String fullDescription

HIDDEN_FILE

private static String HIDDEN_FILE

log

private final static Logger log

TYPE_UNKNOWN

private static String TYPE_UNKNOWN

useExtensionsInDescription

private boolean useExtensionsInDescription
Constructor Detail

VemaxsFileFilter

public VemaxsFileFilter()
Creates a file filter. If no filters are added, then all
files are accepted.
See Also:
addExtension(java.lang.String)

VemaxsFileFilter

public VemaxsFileFilter(String extension)
Creates a file filter that accepts files with the given extension.
Example: new ExampleFileFilter("jpg");
See Also:
addExtension(java.lang.String)

VemaxsFileFilter

public VemaxsFileFilter(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.
See Also:
addExtension(java.lang.String)

VemaxsFileFilter

public VemaxsFileFilter(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.
See Also:
addExtension(java.lang.String)

VemaxsFileFilter

public VemaxsFileFilter(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.
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.
See Also:
getExtension(java.io.File), FileFilter#accepts

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)"
See Also:
setDescription, setExtensionListInDescription, isExtensionListInDescription, javax.swing.filechooser.FileFilter.getDescription()

getExtension

public String getExtension(File f)
Return the extension portion of the file's name .
See Also:
getExtension(java.io.File), javax.swing.filechooser.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();
See Also:
getDescription, setDescription, setExtensionListInDescription

setDescription

public void setDescription(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();
See Also:
getDescription, setDescription, isExtensionListInDescription

Association Links

to Class java.lang.String

to Class java.lang.String

to Class java.util.Hashtable

to Class java.lang.String

to Class java.lang.String