Class CompoundFileFilter


  • public class CompoundFileFilter
    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(); CompoundFileFilter filter = new CompoundFileFilter( new String{"gif", "jpg"}, "JPEG & GIF Images") chooser.addChoosableFileFilter(filter); chooser.showOpenDialog(this);
    • Constructor Summary

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

      • CompoundFileFilter

        public CompoundFileFilter()
        Creates a file filter. If no filters are added, then all files are accepted.
      • CompoundFileFilter

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

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

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

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

        public void setDescription​(java.lang.String description)
        Sets the human readable description of this filter. For example: filter.setDescription("Gif and JPG Images");
      • addDescription

        public void addDescription​(java.lang.String 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();
      • 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();