| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Wed Jun 12 19:57:03 BST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1"> |
| <title>ServiceProviderConfigurationWidget (PTP API Specification)</title> |
| <meta name="date" content="2013-06-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ServiceProviderConfigurationWidget (PTP API Specification)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServiceProviderConfigurationWidget.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceModelWidget.RemoveListener.html" title="class in org.eclipse.ptp.services.ui.widgets"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html" target="_top">Frames</a></li> |
| <li><a href="ServiceProviderConfigurationWidget.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.ptp.services.ui.widgets</div> |
| <h2 title="Class ServiceProviderConfigurationWidget" class="title">Class ServiceProviderConfigurationWidget</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>Composite</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.ptp.services.ui.widgets.ServiceProviderConfigurationWidget</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ServiceProviderConfigurationWidget</span> |
| extends Composite</pre> |
| <div class="block">A widget for configuring the services providers for a given service |
| configuration. |
| |
| Displays a table containing the service providers grouped by category on the |
| left part of the widget. When a provider is selected, the right hand part of |
| the widget will display the provider configuration along with a check box to |
| enable/disable the provider and a combo to select a different provider for |
| the service. |
| |
| The configuration UI for the selected provider is supplied by the |
| providerContributor extension point.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#ServiceProviderConfigurationWidget(Composite, int)">ServiceProviderConfigurationWidget</a></strong>(Composite parent, |
| int style)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#addSelectionListener(SelectionListener)">addSelectionListener</a></strong>(SelectionListener listener)</code> |
| <div class="block">Adds the listener to the collection of listeners who will be notified |
| when the users selects a service configuration </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#applyChangesToConfiguration()">applyChangesToConfiguration</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#changeServiceState(boolean)">changeServiceState</a></strong>(boolean disabled)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/ptp/services/core/IServiceConfiguration.html" title="interface in org.eclipse.ptp.services.core">IServiceConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#getServiceConfiguration()">getServiceConfiguration</a></strong>()</code> |
| <div class="block">Returns the service configuration object that is being displayed by this |
| widget.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#removeSelectionListener(SelectionListener)">removeSelectionListener</a></strong>(SelectionListener listener)</code> |
| <div class="block">Removes the listener from the collection of listeners who will be |
| notified when a service configuration is selected by the user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#setServiceConfiguration(org.eclipse.ptp.services.core.IServiceConfiguration)">setServiceConfiguration</a></strong>(<a href="../../../../../../org/eclipse/ptp/services/core/IServiceConfiguration.html" title="interface in org.eclipse.ptp.services.core">IServiceConfiguration</a> conf)</code> |
| <div class="block">Causes the tree to display all the services that are available in the |
| system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html#setServiceConfiguration(org.eclipse.ptp.services.core.IServiceConfiguration, java.util.Set)">setServiceConfiguration</a></strong>(<a href="../../../../../../org/eclipse/ptp/services/core/IServiceConfiguration.html" title="interface in org.eclipse.ptp.services.core">IServiceConfiguration</a> configuration, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> natureIds)</code> |
| <div class="block">Causes the tree to display all the services that are available in the |
| system.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ServiceProviderConfigurationWidget(Composite, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServiceProviderConfigurationWidget</h4> |
| <pre>public ServiceProviderConfigurationWidget(Composite parent, |
| int style)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addSelectionListener(SelectionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSelectionListener</h4> |
| <pre>public void addSelectionListener(SelectionListener listener)</pre> |
| <div class="block">Adds the listener to the collection of listeners who will be notified |
| when the users selects a service configuration </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener that will be notified of the selection</dd></dl> |
| </li> |
| </ul> |
| <a name="applyChangesToConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyChangesToConfiguration</h4> |
| <pre>public void applyChangesToConfiguration()</pre> |
| </li> |
| </ul> |
| <a name="getServiceConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceConfiguration</h4> |
| <pre>public <a href="../../../../../../org/eclipse/ptp/services/core/IServiceConfiguration.html" title="interface in org.eclipse.ptp.services.core">IServiceConfiguration</a> getServiceConfiguration()</pre> |
| <div class="block">Returns the service configuration object that is being displayed by this |
| widget. In order for the changes made by the user to be reflected in the |
| configuration the applyChangesToConfiguration() method must be called |
| first.</div> |
| </li> |
| </ul> |
| <a name="removeSelectionListener(SelectionListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSelectionListener</h4> |
| <pre>public void removeSelectionListener(SelectionListener listener)</pre> |
| <div class="block">Removes the listener from the collection of listeners who will be |
| notified when a service configuration is selected by the user.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener which will no longer be notified</dd></dl> |
| </li> |
| </ul> |
| <a name="setServiceConfiguration(org.eclipse.ptp.services.core.IServiceConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServiceConfiguration</h4> |
| <pre>public void setServiceConfiguration(<a href="../../../../../../org/eclipse/ptp/services/core/IServiceConfiguration.html" title="interface in org.eclipse.ptp.services.core">IServiceConfiguration</a> conf)</pre> |
| <div class="block">Causes the tree to display all the services that are available in the |
| system. Services that are not part of the given service configuration |
| will be shown as disabled. Services that are part of the given |
| configuration will show as enabled. |
| |
| Any changes made by the user will only be applied to the given |
| configuration when the applyChangesToConfiguration() method is called.</div> |
| </li> |
| </ul> |
| <a name="setServiceConfiguration(org.eclipse.ptp.services.core.IServiceConfiguration, java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServiceConfiguration</h4> |
| <pre>public void setServiceConfiguration(<a href="../../../../../../org/eclipse/ptp/services/core/IServiceConfiguration.html" title="interface in org.eclipse.ptp.services.core">IServiceConfiguration</a> configuration, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> natureIds)</pre> |
| <div class="block">Causes the tree to display all the services that are available in the |
| system. Services that are not part of the given service configuration |
| will be shown as disabled. Services that are part of the given |
| configuration will show as enabled. |
| |
| Any changes made by the user will only be applied to the given |
| configuration when the applyChangesToConfiguration() method is called. |
| |
| Additionally the services tree will be filtered to exclude services that |
| do not apply to the given set of project nature IDs. This is useful when |
| the widget is used as part of a project properties page as only the |
| services that apply to the project will be shown.</div> |
| </li> |
| </ul> |
| <a name="changeServiceState(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>changeServiceState</h4> |
| <pre>protected void changeServiceState(boolean disabled)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServiceProviderConfigurationWidget.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/eclipse/ptp/services/ui/widgets/ServiceModelWidget.RemoveListener.html" title="class in org.eclipse.ptp.services.ui.widgets"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/ptp/services/ui/widgets/ServiceProviderConfigurationWidget.html" target="_top">Frames</a></li> |
| <li><a href="ServiceProviderConfigurationWidget.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p> |
| </body> |
| </html> |
