- java.lang.Object
-
- javax.swing.filechooser.FileView
-
- Direct Known Subclasses:
BasicFileChooserUI.BasicFileView
public abstract class FileView extends Object
FileViewdefines an abstract class that can be implemented to provide the filechooser with UI information for aFile. Each L&FJFileChooserUIobject implements this class to pass back the correct icons and type descriptions specific to that L&F. For example, the Microsoft Windows L&F returns the generic Windows icons for directories and generic files. Additionally, you may want to provide your ownFileViewtoJFileChooserto return different icons or additional information usingJFileChooser.setFileView(javax.swing.filechooser.FileView).JFileChooserfirst looks to see if there is a user definedFileView, if there is, it gets type information from there first. IfFileViewreturnsnullfor any method,JFileChooserthen uses the L&F specific view to get the information. So, for example, if you provide aFileViewclass that returns anIconfor JPG files, and returnsnullicons for all other files, the UI'sFileViewwill provide default icons for all other files.For an example implementation of a simple file view, see
yourJDK/demo/jfc/FileChooserDemo/ExampleFileView.java. For more information and examples see How to Use File Choosers, a section in The Java Tutorial.- See Also:
JFileChooser
-
-
Constructor Summary
Constructors Constructor Description FileView()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetDescription(File f)A human readable description of the file.IcongetIcon(File f)The icon that represents this file in theJFileChooser.StringgetName(File f)The name of the file.StringgetTypeDescription(File f)A human readable description of the type of the file.BooleanisTraversable(File f)Whether the directory is traversable or not.
-
-
-
Method Detail
-
getName
public String getName(File f)
The name of the file. Normally this would be simplyf.getName().- Parameters:
f- aFileobject- Returns:
- a
Stringrepresenting the name of the file
-
getDescription
public String getDescription(File f)
A human readable description of the file. For example, a file named jag.jpg might have a description that read: "A JPEG image file of James Gosling's face".- Parameters:
f- aFileobject- Returns:
- a
Stringcontaining a description of the file ornullif it is not available.
-
getTypeDescription
public String getTypeDescription(File f)
A human readable description of the type of the file. For example, ajpgfile might have a type description of: "A JPEG Compressed Image File"- Parameters:
f- aFileobject- Returns:
- a
Stringcontaining a description of the type of the file ornullif it is not available .
-
getIcon
public Icon getIcon(File f)
The icon that represents this file in theJFileChooser.- Parameters:
f- aFileobject- Returns:
- an
Iconwhich represents the specifiedFileornullif it is not available.
-
isTraversable
public Boolean isTraversable(File f)
Whether the directory is traversable or not. This might be useful, for example, if you want a directory to represent a compound document and don't want the user to descend into it.- Parameters:
f- aFileobject representing a directory- Returns:
trueif the directory is traversable,falseif it is not, andnullif the file system should be checked.- See Also:
FileSystemView.isTraversable(java.io.File)
-
-