Producent van Help-inhoud
ID:
org.eclipse.help.contentProducer
Sinds:
3.0
Beschrijving:
Voor het verstrekken van dynamische Help-inhoud die tijdens runtime wordt gegenereerd. Contentproducenten worden per plugin geregistreerd en werken alleen binnen het bereik van de plugin. Als u een contentproducent in een andere plugin wilt hergebruiken, kunt u het element binding
gebruiken. Zo wordt voorkomen dat plugins de contentproductie voor alle plugins wegkapen. Als u een binding met een contentproducent creëert, krijgt de plugin toestemming de contentproductie te besturen voor alle documenten in de plugin die toegang verleent.
Configuratiemarkup:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - de implementatieklasse van de producent van Help-inhoud. De interface org.eclipse.help.IHelpContentProducer moet door deze klasse worden geïmplementeerd. Dit kenmerk is niet verplicht; u kunt ook het geneste element producer opgeven.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - de implementatieklasse van de producent van Help-inhoud. De interface org.eclipse.help.IHelpContentProducer moet door deze klasse worden geïmplementeerd.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - de naam van de parameter die aan de implementatieklasse wordt doorgegeven.
- value - de waarde van de parameter die aan de implementatieklasse wordt doorgegeven.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - de unieke naam van een contentproducent die elders is gedefinieerd met het element contentProducer. Door middel van een binding kan een plugin de contentproducent hergebruiken die voor een andere plugin is geregistreerd en hoeft de plugin geen nieuwe producent te definiëren.
Voorbeelden:
Dit is een voorbeeld van de extensie contentProducer:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"Mijn dynamische Help-inhoud"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
API-informatie:
De interface org.eclipse.help.IHelpContentProducer moet door de verstrekte klasse van de contentproducent worden geïmplementeerd. De producent zorgt voor het leveren van content van dynamische Help-resources in plugins. De methode van de contentproducent wordt door de Help aangeroepen voor elke Help-resource die uit de plugin is opgehaald.
Verstrekte implementatie:
Geen. Als voor documentatieplugins geen producent van Help-inhoud is ingesteld of als het aanroepen van de producent null oplevert, wordt het bestand doc.zip en de installatiedirectory van de plugin in het bestandssysteem doorzocht om een statisch document af te beelden.
Copyright (c) 2000, 2006 IBM Corporation en anderen.
Alle rechten voorbehouden. Dit programma en het begeleidende materiaal zijn beschikbaar gesteld onder de voorwaarden van de Eclipse Public License v1.0 die bij deze distributie is geleverd en beschikbaar is op http://www.eclipse.org/legal/epl-v10.html.