Class JFileFilter


public class JFileFilter extends 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.

  • Field Details

    • filters

      private Hashtable<String,JFileFilter> filters
    • description

      private String description
    • fullDescription

      private String fullDescription
    • useExtensionsInDescription

      private boolean useExtensionsInDescription
  • Constructor Details

    • JFileFilter

      public JFileFilter()
      Creates a file filter. If no filters are added, then all files are accepted.
      See Also:
    • JFileFilter

      public JFileFilter(String extension)
      Creates a file filter that accepts files with the given extension. Example: new JFileFilter("jpg");
      Parameters:
      extension - string containing file extension
      See Also:
    • JFileFilter

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

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

      public JFileFilter(String[] filters, String description)
      Creates a file filter from the given string array and description. Example: new JFileFilter(String {"gif", "jpg"}, "Gif and JPG Images"); Note that the "." before the extension is not needed and will be ignored.
      Parameters:
      filters - string array containing extensions
      description - string containing file description
      See Also:
  • Method Details

    • accept

      public boolean accept(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 FileFilter
      See Also:
    • getExtension

      public String getExtension(File f)
      Return the extension portion of the file's name .
      Parameters:
      f - File handle to get extension for
      Returns:
      extension as string (excluding the '.')
      See Also:
    • addExtension

      public void addExtension(String extension)
      Adds a file type "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": JFileFilter filter = new JFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif"); Note that the "." before the extension is not needed and will be ignored.
      Parameters:
      extension - file extension (e.g. '.sup')
    • getDescription

      public String getDescription()
      Returns the human readable description of this filter. For example: "JPEG and GIF Image Files (*.jpg, *.gif)"
      Specified by:
      getDescription in class FileFilter
      See Also:
    • setDescription

      public void setDescription(String description)
      Sets the human readable description of this filter. For example: filter.setDescription("Gif and JPG Images");
      Parameters:
      description - string containing file description
      See Also:
    • setExtensionListInDescription

      public void setExtensionListInDescription(boolean b)
      Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description. Only relevant if a description was provided in the constructor or using setDescription();
      Parameters:
      b - true if the extension list should show up in the human readable description
      See Also:
    • isExtensionListInDescription

      public boolean isExtensionListInDescription()
      Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description. Only relevant if a description was provided in the constructor or using setDescription();
      Returns:
      true if the extension list should show up in the human readable description
      See Also: