org.netbeans.modules.versioning.spi

Class VCSAnnotator

java.lang.Object

org.netbeans.modules.versioning.spi.VCSAnnotator

public abstract class VCSAnnotator
extends Object

Annotator provides these services based on files' versioning status:

• coloring for labels (file and folder names, editor tabs, etc.)
• badging (modification of node icons)
• provides set of Actions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VCSAnnotator.ActionDestination Specifies destination of returned actions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VCSAnnotator() Protected constructor, does nothing.

Method Summary

Modifier and Type	Method and Description
Image	annotateIcon(Image icon, VCSContext context) Allows a versioning system to decorate given icon (badging).
String	annotateName(String name, VCSContext context) Allows a versioning system to decorate given name with HTML markup.
Action[]	getActions(VCSContext context, VCSAnnotator.ActionDestination destination) Returns set of actions to offer to the user use on a given context.

Methods inherited from class java.lang.Object

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

Constructor Detail

VCSAnnotator

protected VCSAnnotator()

Protected constructor, does nothing.

Method Detail

annotateName

public String annotateName(String name,
                           VCSContext context)

Allows a versioning system to decorate given name with HTML markup. This can be used to highlight file status.

Parameters:

name - text to decorate

context - a context this name represents

Returns:

decorated name or the same name left undecorated

annotateIcon

public Image annotateIcon(Image icon,
                          VCSContext context)

Allows a versioning system to decorate given icon (badging). This can be used to highlight file status.

Parameters:

icon - an icon to decorate

context - a context this icon represents

Returns:

decorated icon or the same icon left undecorated

getActions

public Action[] getActions(VCSContext context,
                           VCSAnnotator.ActionDestination destination)

Returns set of actions to offer to the user use on a given context.

Parameters:

context - context on which returned actions should operate

destination - where this actions will be used

Returns:

Action[] array of actions to display for the given context, use null for separators