blob: 558b644bbabe9f471fca5799ff2630b6c4a7bc02 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Image Providers</title>
<link href="../book.css" rel="stylesheet" type="text/css">
</head>
<body>
<h1 style="text-align: center">Image Providers</h1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>
org.eclipse.graphiti.ui.imageProviders<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>
0.7.0
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>
Customers of Graphiti can use this extension point to register their own image providers.<p>
</p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.imageProvider">imageProvider</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp; CDATA #IMPLIED</p>
<p class="code SchemaDtdAttlist">name&nbsp; CDATA #IMPLIED</p>
&gt;<p></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.imageProvider">imageProvider</a>
EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST imageProvider</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp; CDATA #REQUIRED</p>
<p class="code SchemaDtdAttlist">class CDATA #REQUIRED</p>
&gt;<p></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - a unique name in the NWDS environment that will be used to identify
this image provider</li>
<li><b>class</b> - the name of a class that implements <samp>org.eclipse.graphiti.ui.platform.IImageProvider</samp>.</li>
</ul>
<br>
<h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>
<p></p>
<pre class="Example"><span class="code SchemaTag">
&lt;extension
point=</span><span class="code SchemaCstring">&quot;org.eclipse.graphiti.ui.imageProviders&quot;</span><span class="code SchemaTag">&gt;
&lt;imageProvider
id=</span><span class="code SchemaCstring">&quot;org.eclipse.graphiti.examples.common.SampleImageProvider&quot;</span><span class="code SchemaTag">&gt;
&lt;/imageProvider&gt;
&lt;/extension&gt;
</span></pre>
<p></p>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>
Instead of implementing the interface <samp>org.eclipse.graphiti.ui.platform.IImageProvider</samp>
directly, the customer should extend the base class <samp>org.eclipse.graphiti.ui.platform.AbstractImageProvider</samp>.
</body>
</html>