Eintragserweiterung des Spickzettels
Kennung:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
Seit:
3.0
Beschreibung:
Dieser Erweiterungspunkt sollte verwendet werden, wenn eine Extra-Schaltfläche zu einem Schritt in dem Spickzettel hinzugefügt werden muss.
Sie können ein neues Attribut in dem Tag "item" in der Spickzettel-Inhaltsdatei hinzufügen. Wenn dieser Wert von dem Spickzettelgerüst gelesen wird, wird geprüft, ob eine Klasse über diesen Erweiterungspunkt registriert wurde, der dieses Attribut abwickelt. Der Attributname, der in der Spickzetteldatei gefunden wurde, stimmt mit keinem der Werte überein, die in dem Attribut "itemAttribute" aller registrierter Implementierungen 'cheatsheetItemExtension point' gefunden wurde. Bei einer Übereinstimmung wird die Klasse, die zur Abwicklung dieses Attributelement angegeben wurde, durch das Spickzettelgerüst geladen und wird zur Abwicklung des Attributs aufgerufen, das in der Spickzettel-Inhaltsdateiangegeben wird.
Nachdem der Wert des Attributelementes syntaktisch analysiert wurd, ist die Klasse weiterhin für das Spickzettelgerüst verfügbar. Wenn das Element für die Spickzettelsicht wiedergegeben wurde, wird die Klasse erneut aufgerufen, um die Hinzufügung von Komponenten zu einem 'kombinierten Anzeigenobjekt' abzuwickeln. Die zu diesem kombinierten Anzeigenobjekt hinzugefügten Elemente werden in dem Spickzettelschritt (gegenwärtig, neben dem Hilfesymbol) angezeigt. Es wird nur für den Schritt angezeigt, der durch den Tag 'Item' beschrieben wird, den das Attribut in der Spickzettelinhaltsdatei darstellt.
Die vorgeschlagene Verwendung dieses Erweiterungspunktes fügt eine kleine Schaltfläche(16x16) mit einer Grafik hinzu, die ein Dialogfenster öffnet, wenn man auf die Schaltfläche drückt.
Konfigurationsbefehle:
<!ELEMENT extension (itemExtension)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - Vollständig qualifizierte Kennung des Zielerweiterungspunktes
- id - Optionale ID des Erweiterungsexemplars
- name - Optionaler Name des Erweiterungsexemplars
<!ELEMENT itemExtension EMPTY>
<!ATTLIST itemExtension
itemAttribute CDATA #REQUIRED
class CDATA #REQUIRED>
Verwenden Sie diese Elementerweiterung zum Hinzufügen von Elementen zu den Spickzettelschritten. Sie können diesen Erweiterungspunkt zum Hinzufügen von Symbolen und Schaltflächen (gegenwärtig, neben dem Hilfesymbol) für einen Schritt in dem Spickzettel verwenden.
Sie geben den Namen eines Attributs an, den Sie in den Elementtag des Spickzettels hinzufügen möchten. Sie geben außerdem eine Klasse an, die die syntaktische Analyse des Attributwertes aus der Spickzettelinhaltsdatei abwickelt, wenn der Spickzettel geladen wird. Der Attributwert muss eine Zeichenfolge sein. Die angegebene Klasse mussorg.eclipse.ui.cheatsheets.AbstractItemExtensionElement
als Unterklasse aufnehmen. Nach der syntaktischen Analyse und dem Laden der Spickzettelinhaltsdatei, wird die Klasse, die in dem Erweiterungspunkt angegeben ist, über die Schnittstelle erneut aufgerufen, um Grafiken und Schaltflächen zu dem Schritt auf dem Spickzettel (gegenwärtig, neben der Hilfeschaltfläche) hinzuzufügen.
- itemAttribute - Dieser Attributwert muss der Zeichenfolgewert eines Attributnamens sein, der in einen Elementtag in der Spickzettelinhaltsdatei gesetzt wird. Wenn diese Attributzeichenfolge mit einem Attribut übereinstimmt, das durch den Elementtag in der Spickzettelinhaltsdatei syntaktisch analysiert wird, wird die angegebene Klasse geladen und wird aufgerufen, den vollständigen Wert des Attributes durch Verwendung der Spezifikation 'w3 DOM' syntaktisch zu analysieren. Später wird sie aufgerufen, um Steuerelemente zu einem kombinierten Anzeigenobjekt hinzuzufügen und die hinzugefügten Komponenten (normalerweise Grafiken oder Schaltflächen) werden in dem Schritt des Spickzettels für das angegebene Element angezeigt (gegenwärtig neben dem Hilfesymbol für diesen Schritt).
- class - Der vollständig qualifiziert Klassenname der Klasse, die
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
in Unterklassen einteilt, um unbekannte Attribute in der Spickzettelinhaltsdatei abzuwickeln und die Schritte in dem Spickzettel zu erweitern. Die Klasse muss öffentlich sein und einen öffentliches 1-Argument-Konstruktur haben, der den Attributnamen
(a String
) akzeptiert.
Beispiele:
Beispielimplementierung dieses Erweiterungspunktes:
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
Dies ist das Element-Attribut für diese Erweiterung:
<item title=
"XYZ Title"
xyzButton=
"/icon/button.gif"
/>
Bitte beachten Sie, dass der Wert des Attributs in dem Elementtag ALLES sein kann. Es kann alles sein, weil die Klasse, die dieses Attribut syntaktisch analysiert, die Klasse 'HandleParsingAndAddButton' ist, die in diesem Beispiel eine Datei 'string /icon/button.gif' des Attributes syntaktisch analysiert. Es wird später diese Info zum Laden der gif-Datei verwenden und sie als Symbol für eine neue Schaltfläche verwenden.
API-Information:
API-Details finden Sie in der Java-Information für org.eclipse.ui.cheatsheets.AbstractItemExtensionElement.
Bereitgestellte Implementierung:
Momentan gibt es kene bereitgestellte Implementierung.
Copyright (c) 2004 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.