| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <STYLE type="text/css"> |
| div.dtd-fragment { |
| width: 100%; |
| border: none; |
| background-color: #eee; |
| } |
| </STYLE> |
| </HEAD> |
| <HTML> |
| <BODY> |
| <H1><CENTER>Functions</CENTER></H1> |
| <b><i>Identifier: </i></b>com.bolour.sample.eclipse.services.ui.functions<p> |
| <b><i>Since: </i></b>2.1.0.<p> |
| <b><i>Description: </i></b>Each extension provides one or more service callbacks functions. |
| For each function, the service UI plug-in will add |
| a button for invoking the function, and a label that identifies |
| the function, to its user interface. The UI plug-in also provides an input |
| field and a result field that are shared between all function. |
| The function takes a <i>long</i> as its input, and returns |
| a <i>long</i> as its output.<p><b><i>Configuration Markup:</i></b><p> |
| <p><samp><font color="#800000"> <!ELEMENT <a name="e.extension">extension</a> (<a href="#e.function">function</a>+)></font></samp> |
| <br><br><samp><font color="#800000"> <!ATTLIST extension</samp> |
| <br><samp> point CDATA #REQUIRED</samp> |
| <br><samp> id CDATA #IMPLIED</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> ></font></samp> |
| <ul> |
| <li><b>point</b> - The extension-point of this extension.</li> |
| <li><b>id</b> - Extension identifier.</li> |
| <li><b>name</b> - Name of this extension.</li> |
| </ul> |
| <p><samp><font color="#800000"> <!ELEMENT <a name="e.function">function</a> EMPTY></font></samp> |
| <br><br><samp><font color="#800000"> <!ATTLIST function</samp> |
| <br><samp> name CDATA #IMPLIED</samp> |
| <br><samp> class CDATA #IMPLIED</samp> |
| <br><samp> constant CDATA #IMPLIED</samp> |
| <br><samp> ></font></samp> |
| <ul> |
| <li><b>name</b> - The name of the function.</li> |
| <li><b>class</b> - The specific class implementing the function.</li> |
| <li><b>constant</b> - A constant parameter used in the computation of the function. |
| This constant may be interpreted differently by different extension members. |
| For example, in a member that provides an exponentiation function, |
| the constant is interpreted as the exponent.</li> |
| </ul> |
| <b><i>Examples: </i></b><p> |
| <pre> |
| <font color="#000080"><!-- Extend the functions of the host ... --></font> |
| <font color="#000080"><extension |
| id=<font color="#008000">"service.exponentiation"</font> |
| name=<font color="#008000">"ExponentiationFunctions"</font> |
| point=<font color="#008000">"com.bolour.sample.eclipse.service.ui.functions"</font>></font> |
| <font color="#000080"><service |
| constant=<font color="#008000">"3"</font> |
| name=<font color="#008000">"CUBE"</font> |
| class=<font color="#008000">"com.bolour.sample.eclipse.exponentiation.Exponentiation"</font>/></font> |
| <font color="#000080"><service |
| constant=<font color="#008000">"4"</font> |
| name=<font color="#008000">"FOURTH POWER"</font> |
| class=<font color="#008000">"com.bolour.sample.eclipse.exponentiation.Exponentiation"</font>/></font> |
| <font color="#000080"></extension></font> |
| </pre> |
| <p><p> |
| <b><i>API Information: </i></b>Extension callback objects implement the |
| com.bolour.sample.eclipse.service.ui.IFunction |
| interface.<p> |
| <b><i>Supplied Implementation: </i></b>An example implementation is provided in plug-in |
| com.bolour.sample.eclipse.service.exponentiation.<p> |
| <font size="-1" color="#336699"> |
| </font> |
| </BODY> |
| </HTML> |