| <!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>Service policy UI</title> |
| <style type="text/css">@import url("../../book.css");</style> |
| <style type="text/css">@import url("../../schema.css");</style> |
| </HEAD> |
| <BODY> |
| <H1 style="text-align:center">Service policy UI</H1> |
| <p></p> |
| <h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.service.policy.ui.servicePolicyUI<p></p> |
| <h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0 |
| <p></p> |
| |
| <h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension allows extenders to add service policy UI operations for the |
| service policies that they have added.<p></p> |
| <h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6> |
| <p></p> |
| <p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.servicePolicyUI">servicePolicyUI</a>+)></p> |
| <p class="code SchemaDtd"><!ATTLIST extension</p> |
| <p class="code SchemaDtdAttlist">point CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #IMPLIED<p class="code SchemaDtdAttlist">name CDATA #IMPLIED></p> |
| <p></p> |
| <ul class="ConfigMarkupAttlistDesc"> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.servicePolicyUI">servicePolicyUI</a> (<a href="#e.operation">operation</a>* | <a href="#e.quickFix">quickFix</a>*)></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| This extension is intended for extenders who want to add UI operations to the Service policies that they have defined.</p> |
| <br><br> |
| <p class="code SchemaDtd"><!ELEMENT <a name="e.descriptor">descriptor</a> EMPTY></p> |
| <p class="code SchemaDtd"><!ATTLIST descriptor</p> |
| <p class="code SchemaDtdAttlist">description CDATA #IMPLIED<p class="code SchemaDtdAttlist">shortName CDATA #IMPLIED<p class="code SchemaDtdAttlist">longName CDATA #IMPLIED<p class="code SchemaDtdAttlist">contextHelpId CDATA #IMPLIED<p class="code SchemaDtdAttlist">iconpath CDATA #IMPLIED></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| A descriptor for this Service policy operation or action.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>description</b> - A description of this service operation.</li> |
| <li><b>shortName</b> - The short name of this service operation. Note: if a short name is not specified it is defaulted to the value of the long name.</li> |
| <li><b>longName</b> - The long name of this service operation. Note: if a long name attribute is not specified it is defaulted to the shortName value.</li> |
| <li><b>contextHelpId</b> - The context help id for this service operation if it is required.</li> |
| <li><b>iconpath</b> - A plugin relative path to some icon file for this service operation.</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.operation">operation</a> (<a href="#e.descriptor">descriptor</a> , <a href="#e.enabled">enabled</a>? , (<a href="#e.enumeration">enumeration</a> | <a href="#e.selection">selection</a> | <a href="#e.complex">complex</a>))></p> |
| <p class="code SchemaDtd"><!ATTLIST operation</p> |
| <p class="code SchemaDtdAttlist">id CDATA #REQUIRED<p class="code SchemaDtdAttlist">policyPattern CDATA #REQUIRED<p class="code SchemaDtdAttlist">workspaceOnly (true | false) <p class="code SchemaDtdAttlist">defaultdata (true | false) "true"></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| Defines a Service policy operation.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>id</b> - This unique id of this service operation.</li> |
| <li><b>policyPattern</b> - The attribute specifies which service polices this operation is associated with. Any Java regular expression may be specified. This expression will be used to match the ids of all known service policy ids.</li> |
| <li><b>workspaceOnly</b> - This attribute indicates if this operation is only to be used in the workspace preference page. If this attribute is not specified it is defaulted to false.</li> |
| <li><b>defaultdata</b> - </li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.enumeration">enumeration</a> EMPTY></p> |
| <p class="code SchemaDtd"><!ATTLIST enumeration</p> |
| <p class="code SchemaDtdAttlist">id CDATA #REQUIRED<p class="code SchemaDtdAttlist">defaultItem CDATA #IMPLIED></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| This element defines the enumeration that this operation is associated with.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>id</b> - The id of this enumeration.</li> |
| <li><b>defaultItem</b> - Overrides the default set by the enumeration.</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.selection">selection</a> EMPTY></p> |
| <p class="code SchemaDtd"><!ATTLIST selection</p> |
| <p class="code SchemaDtdAttlist">icon (true | false) ></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| This element indicates that the service policy operation is associated with a some kind of UI boolean selection. All service policies that are associated with this operation should use the org.eclipse.wst.service.policy.booleanEnum enumeration.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>icon</b> - This boolean attribute indicates that the boolean selection should be rendered via an icon.</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.complex">complex</a> EMPTY></p> |
| <p class="code SchemaDtd"><!ATTLIST complex</p> |
| <p class="code SchemaDtdAttlist">launchClass CDATA #REQUIRED></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| This element indicates that this operation is complex to render and persist. The launchClass attribute can be used to launch a dialog to set more complex data. The extender will need to call the service policy platform API to persist data on each policy as required.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>launchClass</b> - A class that can be used to launch a dialog. The class specified must implement the ILaunchOperation interface.</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.enabled">enabled</a> EMPTY></p> |
| <p class="code SchemaDtd"><!ATTLIST enabled</p> |
| <p class="code SchemaDtdAttlist">enabledClass CDATA #IMPLIED<p class="code SchemaDtdAttlist">multiselect CDATA #IMPLIED></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| Indicates if this operation is enabled/grayed out or not in the UI.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>enabledClass</b> - The class specified in the attribute much implement the IEnableOperation interface. This class allows extenders to provide a more complex logic for when the operation should be enabled or not.</li> |
| <li><b>multiselect</b> - Indicates if this operation allows multiple selection of policy objects or not.</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.quickFix">quickFix</a> (<a href="#e.action">action</a>+)></p> |
| <p class="code SchemaDtd"><!ATTLIST quickFix</p> |
| <p class="code SchemaDtdAttlist">pluginId CDATA #REQUIRED<p class="code SchemaDtdAttlist">code CDATA #REQUIRED></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| This element allows extenders to add quick fixes to the Service policy UI frameworks.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>pluginId</b> - The plugin id that the enclosed quick fix actions apply to. This is the id that will match the plugin id from the IStatus of a ServicePolicy object.</li> |
| <li><b>code</b> - The code that the enclosed quick fix actions apply to. This is the code that will match the code from the IStatus of a ServicePolicy object.</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.action">action</a> (<a href="#e.descriptor">descriptor</a>)></p> |
| <p class="code SchemaDtd"><!ATTLIST action</p> |
| <p class="code SchemaDtdAttlist">class CDATA #REQUIRED></p> |
| <p></p> |
| <p class="ConfigMarkupElementDesc"> |
| The element is used to add a quick fix action.</p> |
| <br> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>class</b> - The class that the framework will call for a particular quick fix action. This class must implement the IQuickFixAction interface.</li> |
| </ul> |
| <br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>[Enter extension point usage example here.] |
| <p></p> |
| |
| <h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>[Enter information about supplied implementation of this extension point.] |
| <p></p> |
| |
| <br> |
| <p class="note SchemaCopyright"> |
| </p> |
| </BODY> |
| </HTML> |
