Class XTFRFileFilter


  • public class XTFRFileFilter
    extends javax.swing.filechooser.FileFilter
    This is taken from Sun's demo ExampleFileFiler.java 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(); XTFRFileFilter filter = new XTFRFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);
    Version:
    1.10 05/17/01
    Author:
    Jeff Dinkins
    • Constructor Summary

      Constructors 
      Constructor Description
      XTFRFileFilter()
      Creates a file filter.
      XTFRFileFilter​(java.lang.String extension)
      Creates a file filter that accepts files with the given extension.
      XTFRFileFilter​(java.lang.String[] filters)
      Creates a file filter from the given string array.
      XTFRFileFilter​(java.lang.String[] filters, java.lang.String description)
      Creates a file filter from the given string array and description.
      XTFRFileFilter​(java.lang.String extension, java.lang.String description)
      Creates a file filter that accepts the given file type.
    • Method Summary

      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 .
      java.lang.String getExtension​(java.lang.String filename)  
      OutputFilterInterface getOutputFilterInstance()  
      boolean isExtensionInList​(java.lang.String filename)  
      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.
      java.lang.String setExtension​(java.io.File f)
      Set the extension to be used for this type if one is not provided This will append the first key of the filter contained in the list
      java.lang.String setExtension​(java.lang.String f)  
      void setExtensionListInDescription​(boolean b)
      Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
      void setOutputFilterName​(java.lang.String className)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • XTFRFileFilter

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

        public XTFRFileFilter​(java.lang.String extension)
        Creates a file filter that accepts files with the given extension. Example: new XTFRFileFilter("jpg");
        Parameters:
        extension - an extension
      • XTFRFileFilter

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

        public XTFRFileFilter​(java.lang.String[] filters)
        Creates a file filter from the given string array. Example: new XTFRFileFilter(String {"gif", "jpg"}); Note that the "." before the extension is not needed adn will be ignored.
        Parameters:
        filters - some filter
      • XTFRFileFilter

        public XTFRFileFilter​(java.lang.String[] filters,
                              java.lang.String description)
        Creates a file filter from the given string array and description. Example: new XTFRFileFilter(String {"gif", "jpg"}, "Gif and JPG Images"); Note that the "." before the extension is not needed and will be ignored.
        Parameters:
        filters - some filter
        description - a description
    • 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 class javax.swing.filechooser.FileFilter
        Parameters:
        f - a file
        Returns:
        flag
      • getExtension

        public java.lang.String getExtension​(java.io.File f)
        Return the extension portion of the file's name .
        Parameters:
        f - file
        Returns:
        string
      • getExtension

        public java.lang.String getExtension​(java.lang.String filename)
      • 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": XTFRFileFilter filter = new XTFRFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif"); Note that the "." before the extension is not needed and will be ignored.
        Parameters:
        extension - an extension
      • 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 class javax.swing.filechooser.FileFilter
        Returns:
        string
      • 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 - a description
      • 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 - flag
      • 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:
        flag
      • setExtension

        public java.lang.String setExtension​(java.io.File f)
        Set the extension to be used for this type if one is not provided This will append the first key of the filter contained in the list
        Parameters:
        f - file
        Returns:
        string
      • setExtension

        public java.lang.String setExtension​(java.lang.String f)
      • isExtensionInList

        public boolean isExtensionInList​(java.lang.String filename)
      • setOutputFilterName

        public void setOutputFilterName​(java.lang.String className)