Uitbreidingsitem voor hulpblad
ID:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
Sinds:
3.0
Beschrijving:
Dit extensiepunt wordt gebruikt wanneer een extra knop moet worden toegevoegd aan een stap in het hulpblad.
U kunt een nieuw kenmerk in de "item"-tag in het hulpbladcontentbestand plaatsen. Als deze waarde wordt gelezen door het hulpbladframework, wordt gecontroleerd of er een klasse is geregistreerd via dit extensiepunt die dit kenmerk gaat afhandelen. De kenmerknaam die wordt aangetroffen in het hulpbladcontentbestand, wordt vergeleken met alle waarden die zijn aangetroffen in het kenmerk itemAttribute van alle geregistreerde implementaties van cheatsheetItemExtension. Als een overeenkomst wordt aangetroffen, wordt de klasse die is opgegeven voor het afhandelen van dit item-kenmerk geladen door het hulpbladframework en aangeroepen voor het afhandelen van het kenmerk dat is opgegeven in het hulpbladcontentbestand.
Nadat de klasse de waarde van het kenmerk item heeft ontleed, blijft de klasse beschikbaar voor het hulpbladframework. Wanneer het item wordt weergegeven in de view Hulpbladen, wordt de klasse opnieuw aangeroepen om de toevoeging van componenten aan een Samenstelling af te handelen. De items die aan deze samenstelling worden toegevoegd, worden weergegeven in de hulpbladstap (naast het pictogram Help). Deze wordt alleen weergegeven voor de stap die wordt beschreven door de tag item van het kenmerk in het hulpbladcontentbestand.
Voor dit extensiepunt wordt aangeraden een kleine (16x16) knop toe te voegen met een grafische afbeelding, waarmee u een dialoogvenster kunt openen.
Configuratiemarkup:
<!ELEMENT extension (itemExtension)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - een volledig gekwalificeerd ID van het doelextensiepunt.
- id - een optioneel ID van de extensie-instance.
- name - een optionele naam van de extensie-instance.
<!ELEMENT itemExtension EMPTY>
<!ATTLIST itemExtension
itemAttribute CDATA #REQUIRED
class CDATA #REQUIRED>
Gebruik deze itemextensie om elementen toe te voegen aan de stappen van het hulpblad. U kunt dit extensiepunt gebruiken om pictogrammen en knoppen toe te voegen (naast het Help-pictogram) voor stappen in het hulpblad.
U geeft de naam van een kenmerk op dat u in de tag item van het hulpblad plaatst. U geeft ook een klasse op die het ontleden van de kenmerkwaarde van het hulpbladcontentbestand gaat afhandelen wanneer het hulpblad is geladen. De kenmerkwaarde moet een tekenreeks zijn. De opgegeven klasse moet een subklasse zijn onder org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
. Nadat het hulpbladcontentbestand ontleed en geladen is, wordt de klasse die is opgegeven in het extensiepunt opnieuw aangeroepen via de interface om afbeeldingen of knoppen toe te voegen aan de stap in het hulpblad (naast de Help-knop).
- itemAttribute - deze kenmerkwaarde moet een tekenreeks zijn van een kenmerknaam, die in de tag item is geplaatst in het hulpbladcontentbestand. Als deze kenmerktekenreeks overeenkomt met een kenmerk dat is ontleed uit de itemtag in het hulpbladcontentbestand, wordt de opgegeven klasse geladen en wordt deze aangeroepen om de volledige waarde van het kenmerk te ontleden met behulp van de w3 DOM-specificatie. Later wordt deze klasse aangeroepen voor het toevoegen van besturingsfuncties aan een Composite en verschijnen de toegevoegde componenten (meestal grafische afbeeldingen of knoppen) in de stap van het hulpblad van het opgegeven item (naast het Help-pictogram van deze stap).
- class - de volledig gekwalificeerde naam van een klasse die als subklasse onder
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
is geplaatst om onbekende kenmerken af te handelen in het hulpbladcontentbestand en de stappen in het hulpblad uit te breiden. De klasse moet openbaar zijn en een public 1-argumentconstructor hebben die de kenmerknaam (type String
) accepteert.
Voorbeelden:
Dit is een voorbeeldimplementatie van dit extensiepunt:
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
Hier ziet u het kenmerk item voor deze extensie:
<item title=
"Titel XYZ"
xyzButton=
"/icon/button.gif"
/>
De waarde van het kenmerk in de itemtag kan van alles zijn. Dit is zo, omdat de klasse die het kenmerk ontleedt, de klasse HandleParsingAndAddButton is. In dit voorbeeld ontleedt deze een tekenreeks /icon/button.gif uit het kenmerk. Later worden deze gegevens door de klasse gebruikt om het .gif-bestand te laden en te gebruiken als pictogram voor een nieuwe knop.
API-informatie:
Zie de Javadoc-informatie over org.eclipse.ui.cheatsheets.AbstractItemExtensionElement voor meer details over API's.
Verstrekte implementatie:
Op dit moment wordt geen implementatie verstrekt.
Copyright (c) 2004, 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.