Class EasyFileFilter
- java.lang.Object
-
- javax.swing.filechooser.FileFilter
-
- com.inductiveautomation.ignition.client.util.EasyFileFilter
-
public class EasyFileFilter 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 Macinthosh. Case is ignored.
Example - create a new filter that filerts out all files but gif and jpg image files:
JFileChooser chooser = new JFileChooser(); EasyFileFilter filter = new EasyFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);
-
-
Constructor Summary
Constructors Constructor Description EasyFileFilter()
Creates a file filter.EasyFileFilter(java.lang.String extension)
Creates a file filter that accepts files with the given extension.EasyFileFilter(java.lang.String[] filters)
Creates a file filter from the given string array.EasyFileFilter(java.lang.String[] filters, java.lang.String description)
Creates a file filter from the given string array and description.EasyFileFilter(java.lang.String extension, java.lang.String description)
Creates a file filter that accepts the given file type.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.
-
-
-
Constructor Detail
-
EasyFileFilter
public EasyFileFilter()
Creates a file filter. If no filters are added, then all files are accepted.- See Also:
addExtension(String)
-
EasyFileFilter
public EasyFileFilter(java.lang.String extension)
Creates a file filter that accepts files with the given extension. Example: new ExampleFileFilter("jpg");- See Also:
addExtension(String)
-
EasyFileFilter
public EasyFileFilter(java.lang.String extension, java.lang.String description)
Creates a file filter that accepts the given file type. Example: new EasyFileFilter("jpg", "JPEG Image Images");Note that the "." before the extension is not needed. If provided, it will be ignored.
- See Also:
addExtension(String)
-
EasyFileFilter
public EasyFileFilter(java.lang.String[] filters)
Creates a file filter from the given string array. Example: new EasyFileFilter(String {"gif", "jpg"});Note that the "." before the extension is not needed adn will be ignored.
- See Also:
addExtension(String)
-
EasyFileFilter
public EasyFileFilter(java.lang.String[] filters, java.lang.String description)
Creates a file filter from the given string array and description. Example: new EasyFileFilter(String {"gif", "jpg"}, "Gif and JPG Images");Note that the "." before the extension is not needed and will be ignored.
- See Also:
addExtension(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.
- Specified by:
accept
in classjavax.swing.filechooser.FileFilter
- See Also:
getExtension(File)
,FileFilter#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":
EasyFileFilter filter = new EasyFileFilter(); 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)"- Specified by:
getDescription
in classjavax.swing.filechooser.FileFilter
- See Also:
setDescription(java.lang.String)
,setExtensionListInDescription(boolean)
,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");
-
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();
-
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();
-
-