blob: 07c59b2512feb5047afbc6e16706061ab4564811 [file] [log] [blame]
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Workbench Extension Points</title>
</head>
<body link="#0000FF" vlink="#800080">
<center>
<h1>
Applications</h1></center>
<b><i>Identifier: </i></b>org.eclipse.core.runtime.applications<p><b><i>Description:
</i></b>Platform runtime supports plug-ins which would like to declare main
entry points.&nbsp; That is, programs which would like to run using the platform
runtime but yet control all aspects of execution can declare themselves as an <i>application</i>.&nbsp;
Declared applications can be run directly from the main platform launcher by
specifying the <i>-application</i> argument where the parameter is the id of an
extension supplied to the applications extension point described here.&nbsp;
This application is instantiated and run by the platform.&nbsp; Platform clients
can also use the platform to lookup and run multiple applications.&nbsp;&nbsp;
<p><b><i>Configuration Markup:</i></b>
<p><tt>&nbsp;&nbsp; &lt;!ELEMENT application run?></tt>
<p>
<tt>&nbsp;&nbsp; &lt;!ELEMENT run parameter*></tt>
<br><tt>&nbsp;&nbsp; &lt;!ATTLIST run</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp; ></tt>
<ul>
<li>
<b>class -</b> the fully-qualified name of a class which implements&nbsp; <tt>org.eclipse.core.boot.IPlatformRunnable</tt>.</li>
</ul>
<tt>&nbsp;&nbsp; &lt;!ELEMENT parameter EMPTY></tt>
<br><tt>&nbsp;&nbsp; &lt;!ATTLIST parameter</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
CDATA #REQUIRED</tt>
<br><tt>&nbsp;&nbsp; ></tt>
<ul>
<li>
<b>name</b> - the name of this parameter made available to instances of
the specified application class</li>
<li>
<b>value</b> - an arbitrary value associated with the given name and made
available to instances of the specified application class</li>
</ul>
<b><i>Examples:</i></b>
<p>Following is an example of a builder configuration:
<p><tt>&nbsp;&nbsp; &lt;extension id=&quot;coolApplication&quot; point=&quot;org.eclipse.core.runtime.applications&quot;&gt;</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;application&gt;</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;run class=&quot;com.xyz.applications.Cool&quot;&gt;</tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&lt;parameter name="optimize" value="true"/></tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/run></tt>
<br><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/application&gt;</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 an implementor of <tt>org.eclipse.core.boot.IPlatformRunnable</tt>.
<p><b><i>Supplied Implementation:</i></b> The platform itself supplies a number
of applications including the platform workbench itself.
<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>