Extension d'un élément de l'aide-mémoire

org.eclipse.ui.cheatsheets.cheatSheetItemExtension

3.0

Ce point d'extension doit être utilisé lorsqu'un bouton supplémentaire doit être ajouté à une étape dans l'aide-mémoire. Vous pouvez placer un nouvel attribut dans la balise item du fichier de contenu de l'aide-mémoire. Lorsque la valeur est lue par la structure, elle recherche si une classe enregistrée via ce point d'extension gère cet attribut. Le nom de l'attribut figurant dans le fichier de contenu de l'aide-mémoire est comparé à toutes les valeurs se trouvant dans l'attribut itemAttribute de toutes les implémentations cheatsheetItemExtension enregistrées. S'il y a une concordance, la classe indiquée pour gérer cet attribut item est chargée par la structure d'aide-mémoire et appelée pour gérer l'attribut dans le ficher de contenu de l'aide-mémoire. Après analyse de la valeur de l'attribut item, la classe reste disponible pour la structure. Lorsque l'élément est rendu pour la vue d'aide-mémoire, la classe est à nouveau appelée pour gérer l'ajout de composants à un composite. Les éléments ajoutés à ce composite s'affichent dans l'étape de l'aide-mémoire (généralement à côté de l'icône d'aide). L'affichage n'a lieu que pour l'étape décrite par la balise item, l'attribut figurant dans le fichier de contenu de l'aide-mémoire. La proposition d'utilisation de ce point d'extension est l'ajout d'un petit bouton (16x16) illustré qui ouvre une boîte de dialogue si vous cliquez dessus.

<!ELEMENT extension (itemExtension)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT itemExtension EMPTY>

<!ATTLIST itemExtension

itemAttribute CDATA #REQUIRED

class         CDATA #REQUIRED>

Utilisez cet extension d'élément pour ajouter des éléments aux étapes d'aide-mémoire. Vous pouvez utiliser ce point d'extension pour ajouter des icônes et des boutons (généralement à côté de l'icône d'aide) pour une étape dans l'aide-mémoire. Vous indiquez le nom d'un attribut que vous placerez dans la balise item. Vous pouvez également indiquer une classe qui gérera l'analyse de la valeur de l'attribut à partir du fichier de contenu de l'aide-mémoire lorsque l'aide-mémoire est chargé. La valeur de l'attribut doit être une chaîne. La classe indiquée doit sous-classer org.eclipse.ui.cheatsheets.AbstractItemExtensionElement. Une fois le fichier de contenu analysé et chargé, la classe indiquée dans le point d'extension est à nouveau appelée dans l'interface pour ajouter des illustrations ou des boutons à l'étape dans l'aide-mémoire (généralement à côté du bouton d'aide).



L'exemple ci-dessous illustre l'implémentation de ce point d'extension :

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"

>

<itemExtension itemAttribute=

"xyzButton"

class=

"com.example.HandleParsingAndAddButton"

>

</itemExtension>

</extension>

Voici l'attribut item pour cette extension :

<item title=

"Titre XYZ"

xyzButton=

"/icon/button.gif"

/>

Vous remarquez que l'attribut dans la balise item peut avoir n'importe quelle valeur. En effet, la classe analysant cet attribut est HandleParsingAndAddButton, qui dans l'exemple analyse une chaîne /icon/button.gif à partir de l'attribut. Elle utilisera ensuite ces informations pour charger le gif et s'en servir comme icône pour le nouveau bouton.

Voir les informations Javadoc pour org.eclipse.ui.cheatsheets.AbstractItemExtensionElement afin d'en savoir plus sur l'API.

Aucune implémentation n'est pour l'instant fournie.