Súgótartalom-előállító
Azonosító:
org.eclipse.help.contentProducer
Minimális verziószám:
3.0
Leírás:
Dinamikusus, a futás
során előállított súgótartalom biztosításához. A tartalomelőállítók bedolgozóként vannak bejegyezve és csak
bedolgozó hatókörben működnek. Egy tartalom-előállító újrafelhasználása érdekében a bindig
elemet
kell használni. A stratégia megakadályozza, hogy a bedolgozók eltérítsék a tartalomelőállítást minden bedolgozóra
vonatkozóan. Egy tartalom-előállítóhoz kötéssel egy bedolgozó jogosultságot ad a tartalom-előállítás vezérlésére a
feljogosító bedolgozó minden dokumentumára vonatkozóan.
Konfigurációs kód:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - a súgótartalom-előállító megvalósítását végző
osztály. Az osztálynak meg kell valósítania az
org.eclipse.help.IHelpContentProducer felületet. Ez az
attribútum kihagyható, helyette megadható a beágyazott
producer elem.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - a súgótartalom-előállító megvalósítását végző osztály.
Az osztálynak meg kell valósítania az
org.eclipse.help.IHelpContentProducer felületet.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - a megvalósító osztálynak átadott paraméter neve.
- value - a megvalósító osztálynak átadott paraméter értéke.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - a tartalom-előállító egyedi neve, amely bárhol megadható a contentProducer
elemmel. A kötés lehetővé teszi, hogy a bedolgozó újrafelhasználjon egy másik bedolgozóban megadott
tartalom-előállítót egy saját megadása helyett.
Példák:
Az alábbiakban bemutatjuk a tartalom-előállító
kiterjesztési pont használatát:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"My Dynamic Help Content"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
API-információk:
Az osztálynak
meg kell valósítania az
org.eclipse.help.IHelpContentProducer felületet.
Az előállító
feladata egy bedolgozóból biztosítani a dinamikus súgóerőforrások
tartalmát. A tartalomelőállító metódust a súgó minden egyes alkalommal
meghívja, amikor a bedolgozótól súgó erőforrást kérnek le.
Szállított megvalósítás:
Nincs.
Ha egy dokumentáció bedolgozó nem biztosít súgótartalom-előállítót,
vagy annak meghívása nullértéket ad vissza, akkor a súgórendszer
a doc.zip fájlban és a bedolgozó telepítési helyének a fájlrendszerében
keres egy statikus dokumentumot és annak tartalmát jeleníti meg.
Copyright (c) 2000, 2006 IBM Corporation és mások.
Minden jog fenntartva. Jelen program és annak kísérőanyagai a csomaghoz
tartozó, illetve a
http://www.eclipse.org/legal/epl-v10.html
címen is elérhető Eclipse Public License 1.0 verziójának hatálya alatt lettek
közzétéve.