public abstract class AnnotationProvider extends Object
ServiceProvider.| Constructor and Description |
|---|
AnnotationProvider() |
| Modifier and Type | Method and Description |
|---|---|
abstract Action[] |
actions(Set<? extends FileObject> files)
Provides actions that should be added to given set of files.
|
void |
addFileStatusListener(FileStatusListener listener)
Registers FileStatusListener to receive events.
|
abstract Image |
annotateIcon(Image icon,
int iconType,
Set<? extends FileObject> files)
Annotate the icon of a file cluster.
|
abstract String |
annotateName(String name,
Set<? extends FileObject> files)
Annotate the name of a file cluster.
|
abstract String |
annotateNameHtml(String name,
Set<? extends FileObject> files)
Annotate a name such that the returned value contains HTML markup.
|
protected void |
fireFileStatusChanged(FileStatusEvent event)
Notifies all registered listeners about change of status of some files.
|
abstract InterceptionListener |
getInterceptionListener()
Returns an InterceptionListener.
|
void |
removeFileStatusListener(FileStatusListener listener)
Removes FileStatusListener from the list of listeners.
|
public abstract String annotateName(String name, Set<? extends FileObject> files)
name - the name suggested by defaultfiles - an immutable set of FileObjects belonging to this filesystempublic abstract Image annotateIcon(Image icon, int iconType, Set<? extends FileObject> files)
Please do not modify the original; create a derivative icon image, using a weak-reference cache if necessary.
icon - the icon suggested by defaulticonType - an icon type from BeanInfofiles - an immutable set of FileObjects belonging to this filesystempublic abstract String annotateNameHtml(String name, Set<? extends FileObject> files)
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
HTMLStatus.
name - the name suggested by default. It cannot contain HTML
markup tags but must escape HTML metacharacters. For example
"<default package>" is illegal but "<default package>"
is fine.files - an immutable set of FileObjects belonging to this filesystemHtmlRenderer,
DataNode.getHtmlDisplayName(),
Nodepublic abstract Action[] actions(Set<? extends FileObject> files)
files - an immutable set of FileObjects belonging to this filesystempublic final void addFileStatusListener(FileStatusListener listener) throws TooManyListenersException
listener - The listener to register.TooManyListenersExceptionpublic final void removeFileStatusListener(FileStatusListener listener)
listener - The listener to remove.protected final void fireFileStatusChanged(FileStatusEvent event)
event - The event to be firedpublic abstract InterceptionListener getInterceptionListener()
Built on June 18 2013. | Portions Copyright 1997-2013 Oracle. All rights reserved.