org.eclipse.contribution.visualiser.interfaces.simpleImpl
Class FileMarkupProvider
java.lang.Object
org.eclipse.contribution.visualiser.interfaces.simpleImpl.SimpleMarkupProvider
org.eclipse.contribution.visualiser.interfaces.simpleImpl.FileMarkupProvider
- All Implemented Interfaces:
- IMarkupProvider
- public class FileMarkupProvider
- extends SimpleMarkupProvider
Example implementation of a markup provider. It allows the superclass 'SimpleMarkupProvider'
to handle much of the grunt work, this subclass is purely responsible for retrieving markup
data from a file in a specified format. The three key elements of this class are:
1) initialise() is called by the org.eclipse.contribution.visualiser to get a markup provider ready
2) the provider adds stripes to the SimpleMarkupProvider using the method
addMarkup(full_membername, stripe)
3) after adding all the markups, it calls processMarkups on the superclass, processMarkups
analyses all the places where stripes overlap
Method Summary |
void |
initialise()
Initialise the provider - loads markup information from a file |
void |
loadMarkups(java.lang.String filename)
Load the markup information froma file with the given name |
Methods inherited from class org.eclipse.contribution.visualiser.interfaces.simpleImpl.SimpleMarkupProvider |
addMarkup, changeMode, getAllMarkupKinds, getColorFor, getColorFor, getGroupMarkups, getMemberMarkups, hasMultipleModes, processMarkups, processMouseclick, setColorFor |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FileMarkupProvider
public FileMarkupProvider()
initialise
public void initialise()
- Initialise the provider - loads markup information from a file
- Specified by:
initialise
in interface IMarkupProvider
- Overrides:
initialise
in class SimpleMarkupProvider
loadMarkups
public void loadMarkups(java.lang.String filename)
- Load the markup information froma file with the given name
- Parameters:
filename
-