projectviewer.vpt
Interface IconComposer.VCProvider

Enclosing class:

IconComposer

public static interface IconComposer.VCProvider

Version control plugins that want to provide file status info to PV should implement this interface.

Since:

PV 2.1.0

Method Summary

int	getFileState(java.io.File f, java.lang.String path) This method should return one of the VC_STATE possible values for the given file.
javax.swing.Icon	getIcon(int state) This should return the icon to be used to represent the requested state.

Method Detail

getFileState

int getFileState(java.io.File f,
                 java.lang.String path)

This method should return one of the VC_STATE possible values for the given file. The file argument may be null, in which case the path should be used to identify the file (this will be the case, for example, with files from a VFS).

No range checking is performed on the returned values, so make sure that the value is one of the defined constants.

Parameters:

f - The file, if it's a local file.

path - The path to the file (absolute path if local, VFS URL otherwise).

getIcon

javax.swing.Icon getIcon(int state)

This should return the icon to be used to represent the requested state.

Parameters:

state - One of the defined VC_STATE_* constants.