org.netbeans.modules.masterfs.providers

Class AnnotationProvider

java.lang.Object

org.netbeans.modules.masterfs.providers.BaseAnnotationProvider

org.netbeans.modules.masterfs.providers.AnnotationProvider

public abstract class AnnotationProvider
extends BaseAnnotationProvider

Can provide status and actions for FileObjects. Register it using ServiceProvider.

Constructor Summary

Constructors

Constructor and Description
AnnotationProvider()

Method Summary

Modifier and Type	Method and Description
Action[]	actions(Set<? extends FileObject> files) Deprecated. Will be deleted in the future. Overwrite AnnotationProvider.findExtrasFor(java.util.Set).
abstract Image	annotateIcon(Image icon, int iconType, Set<? extends FileObject> files) Annotate the icon of a file cluster.
Lookup	findExtrasFor(Set<? extends FileObject> files) Provides various (usually UI related) information about the given set of files.

Methods inherited from class org.netbeans.modules.masterfs.providers.BaseAnnotationProvider

addFileStatusListener, annotateName, annotateNameHtml, fireFileStatusChanged, getInterceptionListener, removeFileStatusListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationProvider

public AnnotationProvider()

Method Detail

annotateIcon

public abstract Image annotateIcon(Image icon,
                                   int iconType,
                                   Set<? extends FileObject> files)

Annotate the icon of a file cluster.

Please do not modify the original; create a derivative icon image, using a weak-reference cache if necessary.

Parameters:

icon - the icon suggested by default

iconType - an icon type from BeanInfo

files - an immutable set of FileObjects belonging to this filesystem

Returns:

the annotated icon or null if some other provider shall anotate the icon

actions

@Deprecated
public Action[] actions(Set<? extends FileObject> files)

Deprecated. Will be deleted in the future. Overwrite AnnotationProvider.findExtrasFor(java.util.Set).

Provides actions that should be added to given set of files.

Parameters:

files - an immutable set of FileObjects belonging to this filesystem

Returns:

null or array of actions for these files.

findExtrasFor

public Lookup findExtrasFor(Set<? extends FileObject> files)

Provides various (usually UI related) information about the given set of files.

Overrides:

findExtrasFor in class BaseAnnotationProvider

Parameters:

files - the files to

Returns:

lookup to be exposed as FileSystem.findExtrasFor(java.util.Set<org.openide.filesystems.FileObject>) - may return null

Since:

2.48