Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: ee5e9f5a9e8acdf1a8c42d283028afbbf86ae4ee (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<!doctype html public "-//w3c//dtd html 4.0//en">
<html>
<head>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   <title>Eclipse Team UI Extension Point: Decorators</title>
</head>
<body link="#0000FF" vlink="#800080">

<center>
<h1>
Decorators</h1></center>
<b><i>Identifier: </i></b>org.eclipse.team.ui.decorators
<p><b><i>Description: </i></b>This extension point is used to register
object decorator extensions. These decorators may adorn objects with
labels and icons depending on certain aspects of their team status. For
example, elements which are locally modified may their label or icon
modified to indicate this status.
<p>Providers may provide an extension for this extension point, and an
implementation of <code>org.eclipse.team.ui.ITeamDecorator</code> which
decorates objects in a provider-specific fashion.
<p><b><i>Configuration Markup:</i></b>
<p><tt>&nbsp;&nbsp; &lt;!ELEMENT decorator EMPTY></tt>
<br><tt>&nbsp;&nbsp; &lt;!ATTLIST decorator</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; natureId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp; ></tt>

<ul>
<li><b>class -</b> a fully qualified name of the Java class implementing <tt>org.eclipse.team.ui.ITeamDecorator>.</li>
<li><b>natureId</b> - a name of the nature, projects having which will be decorated by this decorator.</li>
</ul>

<b><i>Examples:</i></b>
<p>Following is an example of decorator configuration:
<p><tt>&nbsp;&nbsp; &lt;extension point="org.eclipse.team.ui.decorators"></tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;decorator</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class="com.xyz.XYZDecorator"</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; natureId="com.xyz.XYZNature"></tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/decorator></tt>
<br><tt>&nbsp;&nbsp; &lt;/extension></tt>

<p><b><i>API Information</i>: </b>The value of the <tt>class</tt> attribute
must represent a class that implements <tt>org.eclipse.team.ui.ITeamDecorator</tt>.
This decorator may be called upon at any time to provide textual labels and
icon adornments for a given resource.

<p><b><i>Supplied Implementation: </i></b>The plug-in org.eclipse.team.provider.examples.ui contains
sample implementations of ITeamDecorator which decorate for the filesystem provider implementation
and the WebDAV provider implementation.

<p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. 2000, 2001.  All Rights Reserved." BORDER=0 height=12 width=195></a>
</body>
</html>

Back to the top