did.io
Class DIDFileFilter

java.lang.Object
  |
  +--javax.swing.filechooser.FileFilter
        |
        +--did.io.DIDFileFilter

public class DIDFileFilter
extends javax.swing.filechooser.FileFilter

File:         DIDFileFilter.java
Version:      1.1
Description:  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.

Modification Log:
Date          Name    Comment
xx-xx-xxxx    XXX     xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx


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

DIDFileFilter

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

DIDFileFilter

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

DIDFileFilter

public DIDFileFilter(java.lang.String extension,
                     java.lang.String description)
Creates a file filter that accepts the given file type. Example: new DIDFileFilter("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)

DIDFileFilter

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

DIDFileFilter

public DIDFileFilter(java.lang.String[] filters,
                     java.lang.String description)
Creates a file filter from the given string array and description. Example: new DIDFileFilter(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(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.
Overrides:
accept in class javax.swing.filechooser.FileFilter
See Also:
getExtension(java.io.File), DIDFileFilter#accepts

getExtension

public java.lang.String getExtension(java.io.File f)
Return the extension portion of the file's name .
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": DIDFileFilter filter = new DIDFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif"); Note that the "." before the extension is not needed and will be ignored.

getDescription

public java.lang.String getDescription()
Returns the human readable description of this filter. For example: "JPEG and GIF Image Files (*.jpg, *.gif)"
Overrides:
getDescription in class javax.swing.filechooser.FileFilter
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();
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();
See Also:
getDescription, setDescription, setExtensionListInDescription