| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HTML> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <!-- default platform documentation stylesheets --> |
| <style>@import url("book.css");</style> |
| <!-- default schema documentation stylesheets --> |
| <style>@import url("schema.css");</style> |
| </HEAD> |
| <BODY> |
| <H1><CENTER>Visualiser Providers</CENTER></H1> |
| <p></p> |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.contribution.visualiser.providers<p></p> |
| <p> |
| <h6 class=CaptionFigColumn id=header>Description: </h6>This extension point is used to plug in to the Visualiser by specifying a provider. Each extension must provide an implementor of <FONT face="Courier New" size="-1">org.eclipse.contribution.visualiser.interfaces.IContentProvider</font> and an implementor of <FONT face="Courier New" size="-1">org.eclipse.contribution.visualiser.interfaces.IMarkupProvider</font>.</p> |
| <p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p> |
| <p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.provider">provider</a>)></p> |
| <p class=code id=dtd><!ATTLIST extension</p> |
| <p class=code id=dtdAttlist>point CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>name CDATA #IMPLIED></p> |
| <p></p> |
| <ul class=ConfigMarkup id=attlistDesc> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.provider">provider</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST provider</p> |
| <p class=code id=dtdAttlist>contentProviderClass CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>name CDATA #REQUIRED<p class=code id=dtdAttlist>description CDATA #IMPLIED<p class=code id=dtdAttlist>markupProviderClass CDATA #REQUIRED<p class=code id=dtdAttlist>title CDATA #IMPLIED<p class=code id=dtdAttlist>priority CDATA #IMPLIED<p class=code id=dtdAttlist>paletteid CDATA #IMPLIED<p class=code id=dtdAttlist>emptyMessage CDATA #IMPLIED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| Provider definition.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>contentProviderClass</b> - Content Provider class (must implement org.eclipse.contribution.visualiser.interface.IContentProvider).</li> |
| <li><b>id</b> - Unique ID for the provider</li> |
| <li><b>name</b> - Name of the provider, to be used in the Visualiser preference page.</li> |
| <li><b>description</b> - Description of the provider, to be used in the Visualiser preference page.</li> |
| <li><b>markupProviderClass</b> - Markup provider class (must implement org.eclipse.contribution.visualiser.interfaces.IMarkupProvider).</li> |
| <li><b>title</b> - Title, to be used in the Visualiser view's title.</li> |
| <li><b>priority</b> - Integer value where 0 is the lowest, stating the priority of the provider in the list on the Visualiser preference page. This value also determines which of the available providers is selected by default.</li> |
| <li><b>paletteid</b> - If present, this defines the default palette to be used by this provider</li> |
| <li><b>emptyMessage</b> - Empty Message - to be displayed in the Visualiser view when no data is available from the content provider. Should ideally direct the user to how to get some data into the view (e.g. "Click on something in the navigator view").</li> |
| </ul> |
| <br><h6 class=CaptionFigColumn id=header>Examples: </h6>An example of a simple file-based provider: |
| <P><FONT face="Courier New" color="#000080" size="-1"><extension<BR> |
| id=<FONT color="#008000">"file_providers"<FONT color="#000080"><BR> |
| name=<FONT color="#008000">"File Providers"<FONT color="#000080"><BR> |
| point=<FONT color="#008000">"org.eclipse.contribution.visualiser.providers"<FONT color="#000080">><BR> |
| <contentProvider<BR> |
| markupclass=<FONT color="#008000">"org.eclipse.contribution.visualiser.interfaces.simpleImpl.FileMarkupProvider"<FONT color="#000080"><BR> |
| name=<FONT color="#008000">"File content provider"<FONT color="#000080"><BR> |
| priority=<FONT color="#008000">"0"<FONT color="#000080"><BR> |
| description=<FONT color="#008000">"Simple test provider that reads flat file to determine groups, members and marks"<FONT color="#000080"><BR> |
| class=<FONT color="#008000">"org.eclipse.contribution.visualiser.interfaces.simpleImpl.FileContentProvider"<font color="#000080"><BR> |
| id=<FONT color="#008000">"filecontentprovider"<font color="#000080">><BR> |
| </contentProvider><BR> |
| </extension></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></FONT></P> |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>Several implementation examples are included with the Visualiser |
| <p></p> |
| |
| <br> |
| <p class=note id=copyright> |
| </p> |
| </BODY> |
| </HTML> |
