blob: d734da269acf89edc1200d404831a9da51a1228c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Services View Extension Point</title>
<style type="text/css">@import url("../../../../org.eclipse.platform.doc.isv/book.css");</style>
<style type="text/css">@import url("../../../../org.eclipse.platform.doc.isv/schema.css");</style>
<H1 style="text-align:center">Services View Extension Point</H1>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ecf.remoteservice.ui.servicesview<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.3.0 of this plugin.
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point allows new Services views to be created by other plugins and then used by the Remote Services Perspective to display the OSGi services on the local OSGi service registry.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.servicesview">servicesview</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p>
<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<ul class="ConfigMarkupAttlistDesc">
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.servicesview">servicesview</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST servicesview</p>
<p class="code SchemaDtdAttlist">viewid&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">local&nbsp;&nbsp;&nbsp;&nbsp;(true | false) </p>
<p class="code SchemaDtdAttlist">priority&nbsp;CDATA #IMPLIED&gt;</p>
<p class="ConfigMarkupElementDesc">
Defines a services view.</p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>viewid</b> - A required viewid for the extension services view. The given viewid must correspond to a view that implements IViewPart, and should also implement IServicesView. This viewid must also have been registered as an Eclipse view extension.</li>
<li><b>local</b> - Boolean indication of whether the given view is for displaying the services from the local OSGi services registry (true) or not (false).</li>
<li><b>priority</b> - Priority (positive integer) of this services view. This allows multiple services views to determine their relative priority to each other. The Remote Services perspective picks the services view with the highest priority value to display the contents of the local OSGi services registry. Only service views with local="true" will be considered.</li>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following example shows the use of the extension point to make a ServicesView (assumed to implement IServicesView interface with viewid=org.eclipse.ecf.remoteservice.ui.serviceview.ServiceView, local=true (for local OSGi service registry), and priority=1000. The priority=1000 means that any local services view with a priority > 1000 will be used rather than this one as the local OSGi services view in the Remote Service perspective.
<pre class="Example"><span class="code SchemaTag">
point=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.remoteservice.ui.servicesview&quot;</span><span class="code SchemaTag">&gt;
local=</span><span class="code SchemaCstring">&quot;true&quot;</span><span class="code SchemaTag">
priority=</span><span class="code SchemaCstring">&quot;1000&quot;</span><span class="code SchemaTag">
viewid=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.remoteservice.ui.serviceview.ServiceView&quot;</span><span class="code SchemaTag">&gt;
<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>See the IServicesView interface. This interface allows other views to set the selected service in the associated view. If the view given does not implement IServicesView then it will not be used in this manner, but this interface should be implemented by Service View extensions.
<p class="note SchemaCopyright">
Copyright (c) 2015 Composent, Inc. and others.
This program and the accompanying materials are made
available under the terms of the Eclipse Public License 2.0
which is available at
SPDX-License-Identifier: EPL-2.0