org.openide.filesystems

Interface FileChooserBuilder.BadgeProvider

Enclosing class:

FileChooserBuilder

public static interface FileChooserBuilder.BadgeProvider

Provides "badges" for icons that indicate files or folders of particular interest to the user.

See Also:

FileChooserBuilder.setBadgeProvider(org.openide.filesystems.FileChooserBuilder.BadgeProvider)

Method Summary

Modifier and Type	Method and Description
Icon	getBadge(File file) Get the badge the passed file should use.
int	getXOffset() Get the x offset for badges produced by this provider.
int	getYOffset() Get the y offset for badges produced by this provider.

Method Detail

getBadge

Icon getBadge(File file)

Get the badge the passed file should use. Note: this method is called for every visible file. The negative test (deciding not to badge a file) should be very, very fast and immediately return null.

Parameters:

file - The file in question

Returns:

an icon or null if no change to the appearance of the file is needed

getXOffset

int getXOffset()

Get the x offset for badges produced by this provider. This is the location of the badge icon relative to the real icon for the file.

Returns:

a rightward pixel offset

getYOffset

int getYOffset()

Get the y offset for badges produced by this provider. This is the location of the badge icon relative to the real icon for the file.

Returns:

a downward pixel offset