| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.4.2_05) on Fri Aug 12 09:39:09 BST 2005 --> |
| <TITLE> |
| ProviderManager |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.contribution.visualiser.core.ProviderManager class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ProviderManager"; |
| } |
| </SCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProviderManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/contribution/visualiser/core/RendererDefinition.html" title="class in org.eclipse.contribution.visualiser.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ProviderManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.contribution.visualiser.core</FONT> |
| <BR> |
| Class ProviderManager</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.eclipse.contribution.visualiser.core.ProviderManager</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>ProviderManager</B><DT>extends java.lang.Object</DL> |
| |
| <P> |
| The provider manager parses the contents of the defined extensions to the |
| extension-point org.eclipse.contribution.visualiser.providers. Two extensions |
| are allowed - one for the content of the visualiser and one for the markups |
| within the content of the visualiser. The markup one can be left out - but it |
| rather limits the usefulness of the visualiser. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#PROVIDER_EXTENSION">PROVIDER_EXTENSION</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core">ProviderDefinition</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#getAllProviderDefinitions()">getAllProviderDefinitions</A></B>()</CODE> |
| |
| <BR> |
| Get all provider definitions</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IContentProvider.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IContentProvider</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#getContentProvider()">getContentProvider</A></B>()</CODE> |
| |
| <BR> |
| Get the currently active content provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core">ProviderDefinition</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#getCurrent()">getCurrent</A></B>()</CODE> |
| |
| <BR> |
| Get the current provider definition</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupProvider.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupProvider</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#getMarkupProvider()">getMarkupProvider</A></B>()</CODE> |
| |
| <BR> |
| Get the currently active markup provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html" title="class in org.eclipse.contribution.visualiser.core">ProviderManager</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#getProviderManager()">getProviderManager</A></B>()</CODE> |
| |
| <BR> |
| Get the single instance of the ProviderManager</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#initialise()">initialise</A></B>()</CODE> |
| |
| <BR> |
| Initialise the provider manager - read in the definitions for all |
| providers and initialise the content provider and markup provider classes</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html#setCurrent(org.eclipse.contribution.visualiser.core.ProviderDefinition)">setCurrent</A></B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core">ProviderDefinition</A> definition)</CODE> |
| |
| <BR> |
| Set the current provider definition.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="PROVIDER_EXTENSION"><!-- --></A><H3> |
| PROVIDER_EXTENSION</H3> |
| <PRE> |
| public static final java.lang.String <B>PROVIDER_EXTENSION</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.contribution.visualiser.core.ProviderManager.PROVIDER_EXTENSION">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getContentProvider()"><!-- --></A><H3> |
| getContentProvider</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IContentProvider.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IContentProvider</A> <B>getContentProvider</B>()</PRE> |
| <DL> |
| <DD>Get the currently active content provider |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the currently active content provider</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMarkupProvider()"><!-- --></A><H3> |
| getMarkupProvider</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupProvider.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupProvider</A> <B>getMarkupProvider</B>()</PRE> |
| <DL> |
| <DD>Get the currently active markup provider |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the currently active markup provider</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initialise()"><!-- --></A><H3> |
| initialise</H3> |
| <PRE> |
| public static void <B>initialise</B>()</PRE> |
| <DL> |
| <DD>Initialise the provider manager - read in the definitions for all |
| providers and initialise the content provider and markup provider classes |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProviderManager()"><!-- --></A><H3> |
| getProviderManager</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderManager.html" title="class in org.eclipse.contribution.visualiser.core">ProviderManager</A> <B>getProviderManager</B>()</PRE> |
| <DL> |
| <DD>Get the single instance of the ProviderManager |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the single instance of the ProviderManager</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAllProviderDefinitions()"><!-- --></A><H3> |
| getAllProviderDefinitions</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core">ProviderDefinition</A>[] <B>getAllProviderDefinitions</B>()</PRE> |
| <DL> |
| <DD>Get all provider definitions |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrent()"><!-- --></A><H3> |
| getCurrent</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core">ProviderDefinition</A> <B>getCurrent</B>()</PRE> |
| <DL> |
| <DD>Get the current provider definition |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current provider definition</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCurrent(org.eclipse.contribution.visualiser.core.ProviderDefinition)"><!-- --></A><H3> |
| setCurrent</H3> |
| <PRE> |
| public static void <B>setCurrent</B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core">ProviderDefinition</A> definition)</PRE> |
| <DL> |
| <DD>Set the current provider definition. Activates the asociated content and |
| markup providers |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>definition</CODE> - </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProviderManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/contribution/visualiser/core/ProviderDefinition.html" title="class in org.eclipse.contribution.visualiser.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/contribution/visualiser/core/RendererDefinition.html" title="class in org.eclipse.contribution.visualiser.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ProviderManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |