Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

lemurproject::lemur::FileExtension Class Reference

List of all members.

Public Member Functions

 FileExtension ()
 FileExtension (String extension)
 FileExtension (String extension, String description)
 FileExtension (String[] filters)
 FileExtension (String[] filters, String description)
boolean accept (File f)
String getExtension (File f)
void addExtension (String extension)
String getDescription ()
void setDescription (String description)
void setExtensionListInDescription (boolean b)
boolean isExtensionListInDescription ()

Private Attributes

Hashtable filters = null
String description = null
String fullDescription = null
boolean useExtensionsInDescription = true

Static Private Attributes

String TYPE_UNKNOWN = "Type Unknown"
String HIDDEN_FILE = "Hidden File"

Detailed 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.

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);

Version:
1.13 06/13/02
Author:
Jeff Dinkins


Constructor & Destructor Documentation

lemurproject::lemur::FileExtension::FileExtension  )  [inline]
 

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

See also:
addExtension

lemurproject::lemur::FileExtension::FileExtension String  extension  )  [inline]
 

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

See also:
addExtension

lemurproject::lemur::FileExtension::FileExtension String  extension,
String  description
[inline]
 

Creates a file filter that accepts the given file type. Example: new FileExtension("jpg", "JPEG Image Images");

Note that the "." before the extension is not needed. If provided, it will be ignored.

See also:
addExtension

lemurproject::lemur::FileExtension::FileExtension String[]  filters  )  [inline]
 

Creates a file filter from the given string array. Example: new FileExtension(String {"gif", "jpg"});

Note that the "." before the extension is not needed adn will be ignored.

See also:
addExtension

lemurproject::lemur::FileExtension::FileExtension String[]  filters,
String  description
[inline]
 

Creates a file filter from the given string array and description. Example: new FileExtension(String {"gif", "jpg"}, "Gif and JPG Images");

Note that the "." before the extension is not needed and will be ignored.

See also:
addExtension


Member Function Documentation

boolean lemurproject::lemur::FileExtension::accept File  f  )  [inline]
 

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

void lemurproject::lemur::FileExtension::addExtension String  extension  )  [inline]
 

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":

FileExtension filter = new FileExtension(); filter.addExtension("jpg"); filter.addExtension("tif");

Note that the "." before the extension is not needed and will be ignored.

String lemurproject::lemur::FileExtension::getDescription  )  [inline]
 

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

String lemurproject::lemur::FileExtension::getExtension File  f  )  [inline]
 

Return the extension portion of the file's name .

See also:
getExtension

FileFilter#accept

boolean lemurproject::lemur::FileExtension::isExtensionListInDescription  )  [inline]
 

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();

void lemurproject::lemur::FileExtension::setDescription String  description  )  [inline]
 

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

void lemurproject::lemur::FileExtension::setExtensionListInDescription boolean  b  )  [inline]
 

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();


Member Data Documentation

String lemurproject::lemur::FileExtension::description = null [private]
 

Hashtable lemurproject::lemur::FileExtension::filters = null [private]
 

String lemurproject::lemur::FileExtension::fullDescription = null [private]
 

String lemurproject::lemur::FileExtension::HIDDEN_FILE = "Hidden File" [static, private]
 

String lemurproject::lemur::FileExtension::TYPE_UNKNOWN = "Type Unknown" [static, private]
 

boolean lemurproject::lemur::FileExtension::useExtensionsInDescription = true [private]
 


The documentation for this class was generated from the following file:
Generated on Tue Jun 15 11:03:07 2010 for Lemur by doxygen 1.3.4