org.openide.filesystems

Interface StatusDecorator

public interface StatusDecorator

Provides decorations based on file state. Allows a filesystem to annotate a group of files with additional markers.

This could be useful, for example, for a filesystem supporting version control. It could annotate names and icons of data nodes according to whether the files were current, locked, etc.

Textual and HTML markup annotations are supported. The implementation must support at least plain annotation.

This interface replaces and supersedes the former FileSystem.Status. Other markers are possible, e.g. icon, but they are not provided in this interface. For icon or other GUI artifacts, please see openide.filesystems.nb module, the ImageDecorator interface and FileUIUtils utility class.

Since:

9.1

Method Summary

Modifier and Type	Method and Description
String	annotateName(String name, Set<? extends FileObject> files) Annotate the name of a file cluster.
String	annotateNameHtml(String name, Set<? extends FileObject> files) Annotate a name such that the returned value contains HTML markup.

Method Detail

annotateName

String annotateName(String name,
                    Set<? extends FileObject> files)

Annotate the name of a file cluster.

Parameters:

name - the name suggested by default

files - an immutable set of FileObjects belonging to this filesystem

Returns:

the annotated name (may be the same as the passed-in name)

Throws:

ClassCastException - if the files in the set are not of valid types

annotateNameHtml

String annotateNameHtml(String name,
                        Set<? extends FileObject> files)

Annotate a name such that the returned value contains HTML markup. The return value less the HTML content should typically be the same as the return value from annotateName(). This is used, for example, by VCS filesystems to deemphasize the status information included in the file name by using a light grey font color.

For consistency with Node.getHtmlDisplayName(), filesystems that proxy other filesystems (and so must implement this interface to supply HTML annotations) should return null if the filesystem they proxy does not provide an implementation of FileSystem.HtmlStatus.

Note that since the name argument must be free of HTML, it is tricky to use this decorator on a Node arising from foreign code, to chain decorators, or otherwise when you wish to add decorations to an HTML label whose creation you do not control. As a workaround, pass in an arbitrary but HTML-free string as an argument (something unlikely to occur elsewhere) and replace that string in the result with the original HTML label - under the assumption that the decorator does not inspect its argument but merely adds some prefix and/or suffix.

Parameters:

name - the name suggested by default. It cannot contain HTML markup tags but must escape HTML metacharacters. For example "<default package>" is illegal but "&lt;default package&gt;" is fine.

files - an immutable set of FileObjects belonging to this filesystem

Returns:

the annotated name. It may be the same as the passed-in name. It may be null if getStatus returned status that doesn't implement HtmlStatus but plain Status.

Since:

FileSystems API, 4.30

See Also:

DataNode.getHtmlDisplayName(), Node.getHtmlDisplayName()