OpenJDK 27 · javax.swing.filechooser.FileView · APIdia, the JavaDoc alternative

FileView defines an abstract class that can be implemented to provide the filechooser with UI information for a File. Each L&F JFileChooserUI object 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 own FileView to JFileChooser to return different icons or additional information using javax.swing.JFileChooser#setFileView.

JFileChooser first looks to see if there is a user defined FileView, if there is, it gets type information from there first. If FileView returns null for any method, JFileChooser then uses the L&F specific view to get the information. So, for example, if you provide a FileView class that returns an Icon for JPG files, and returns null icons for all other files, the UI's FileView will 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.

Access	Constructor and Description
protected	FileView() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public String	Returns: a `String` containing a description of the file or `null` if it is not available. getDescription(File a `File` object f) A human readable description of the file.
public Icon	Returns: an `Icon` which represents the specified `File` or `null` if it is not available. getIcon(File a `File` object f) The icon that represents this file in the `JFileChooser`.
public String	Returns: a `String` representing the name of the file getName(File a `File` object f) The name of the file.
public String	Returns: a `String` containing a description of the type of the file or `null` if it is not available . getTypeDescription(File a `File` object f) A human readable description of the type of the file.
public Boolean	Returns: `true` if the directory is traversable, `false` if it is not, and `null` if the file system should be checked. isTraversable(File a `File` object representing a directory f) Whether the directory is traversable or not.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

FileView	back to summary
protected FileView() Constructor for subclasses to call.

Method Detail

getDescription back to summary

getDescription	back to summary
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:File a `File` object Returns:String a `String` containing a description of the file or `null` if it is not available.

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:File: a File object

Returns:String

a String containing a description of the file or null if it is not available.

getIcon back to summary

getIcon	back to summary
public Icon getIcon(File f) The icon that represents this file in the `JFileChooser`. Parameters f:File a `File` object Returns:Icon an `Icon` which represents the specified `File` or `null` if it is not available.

public Icon getIcon(File f)

The icon that represents this file in the JFileChooser.

Parameters

f:File: a File object

Returns:Icon

an Icon which represents the specified File or null if it is not available.

getName back to summary

getName	back to summary
public String getName(File f) The name of the file. Normally this would be simply `f.getName()`. Parameters f:File a `File` object Returns:String a `String` representing the name of the file

public String getName(File f)

The name of the file. Normally this would be simply f.getName().

Parameters

f:File: a File object

Returns:String

a String representing the name of the file

getTypeDescription back to summary

getTypeDescription	back to summary
public String getTypeDescription(File f) A human readable description of the type of the file. For example, a `jpg` file might have a type description of: "A JPEG Compressed Image File" Parameters f:File a `File` object Returns:String a `String` containing a description of the type of the file or `null` if it is not available .

public String getTypeDescription(File f)

A human readable description of the type of the file. For example, a jpg file might have a type description of: "A JPEG Compressed Image File"

Parameters

f:File: a File object

Returns:String

a String containing a description of the type of the file or null if it is not available .

isTraversable back to summary

isTraversable	back to summary
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:File a `File` object representing a directory Returns:Boolean `true` if the directory is traversable, `false` if it is not, and `null` if the file system should be checked. See Also `FileSystemView#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:File: a File object representing a directory

Returns:Boolean

true if the directory is traversable, false if it is not, and null if the file system should be checked.

See Also

FileSystemView#isTraversable

public abstract Class FileView

Constructor Summary

Method Summary

Constructor Detail

Method Detail