Produsent av innhold i hjelpen
Identifikator:
org.eclipse.help.contentProducer
Siden:
3.0
Beskrivelse:
Brukes til å
skaffe dynamisk hjelpeinnhold som genereres i kjøretiden. Innholdsprodusenter registreres per plugin-modul og virker bare innen plugin-modulens omfang. For å gjenbruke en innholdsprodusent i en annen plugin-modul bruker du elementet binding
. Denne strategien hindrer plugin-moduler i å kapre innholdsprodusenter for alle plugin-moduler. Ved hjelp av binding til en innholdsprodusent gir en plugin-modul den tillatelse til å kontrollere innholdet som produseres for alle dokumentene ved tildeling av plugin-modul.
Konfigurasjonskodetype:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - implementeringsklassen
for produsenten av innholdet i hjelpen. Denne klassen må implementere
grensesnittet org.eclipse.help.IHelpContentProducer. Dette attributtet
kan utelates, og det nestede producer-elementet kan oppgis i stedet.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - implementeringsklassen
for produsenten av innholdet i hjelpen. Denne klassen må implementere
grensesnittet org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - navnet på en
parameter som sendes til implementeringsklassen.
- value - verdien av en
parameter som sendes til implementeringsklassen.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - et unikt navn på en innholdsprodusent definert et annet sted ved hjelp av elementet contentProducer. Binding gjør det mulig for en plugin-modul å gjenbruke en innholdsprodusent som er registrert i en annen plugin-modul, i stedet for å definere en egen.
Eksempler:
Her er et eksempel på bruk av utvidelsespunkt for innholdsprodusent:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"Mitt dynamiske hjelpeinnhold"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
API-informasjon:
Den oppgitte innholdsleverandørklassen må implementere
grensesnittet org.eclipse.help.IHelpContentProducer.
Produsenten er
ansvarlig for å skaffe innhold til dynamiske hjelperessurser fra en plugin-modul. Hjelpen sender kall
til innholdsprodusentens metode for hver hjelperessurs som hentes fra plugin-modulen.
Levert implementering:
Ingen. Hvis en plugin-modul
med dokumentasjon ikke har en produsent av innholdet i hjelpen, eller hvis et kall til den resulterer
i null, søker hjelpefunksjonen i doc.zip og i filsystemet på plugin-modulens installeringsplassering
etter et statisk dokument, og viser innholdet.
Copyright (c) 2000, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html