Estensione elemento della pagina di aiuto
Identificativo:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
Da:
3.0
Descrizione:
Questo punto di estensione deve essere utilizzato quando è necessario aggiungere un pulsante supplementare ad un'avanzamento della pagina di aiuto.
È possibile inserire un nuovo attributo nel tag "item" del file del contenuto della pagina di aiuto e, quando il valore viene letto dal framework della pagina di aiuto, viene verificato se esiste una classe registrata mediante il punto di estensione che gestisce questo attributo. Il nome dell'attributo rilevato nel file del contenuto della pagina di aiuto viene confrontato con tutti i valori rilevati nell'attributo "itemAttribute" di tutte le implementazioni del punto cheatsheetItemExtension registrato. Se esiste una corrispondenza, la classe specificata per gestire l'attributo di questo elemento viene caricata dal framework della pagina di aiuto e richiamata per gestire l'attributo specificato nel file del contenuto della pagina di aiuto.
Una volta analizzato il valore dell'attributo dell'elemento, la classe resta disponibile per il framework delle pagine di aiuto. Quando l'elemento viene presentato per la vista delle pagine di aiuto, la classe viene richiamata di nuovo per gestire l'aggiunta dei componenti all'elemento Composito. Gli elementi aggiunti a questo elemento composito vengono visualizzati nella pagina di aiuto (attualmente accanto all'icona della guida). Tali elementi vengono visualizzati solo per l'avanzamento descritto dal tag "item" dell'attributo visualizzato nel file del contenuto della pagina di aiuto.
L'utilizzo consigliato di questo punto di estensione prevede l'aggiunta di un piccolo pulsante (16x16) con un'immagine, che apre una finestra di dialogo quando premuto.
Tag di configurazione:
<!ELEMENT extension (itemExtension)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - identificativo completo del punto di estensione di
destinazione
- id - identificativo dell'istanza dell'estensione
- name - nome dell'istanza dell'estensione facoltativo
<!ELEMENT itemExtension EMPTY>
<!ATTLIST itemExtension
itemAttribute CDATA #REQUIRED
class CDATA #REQUIRED>
Utilizzare l'estensione di questo elemento per aggiungere elementi agli avanzamenti delle pagine di aiuto. È possibile utilizzare questo punto di estensione per aggiungere icone e pulsanti (attualmente, accanto all'icona della guida) per un avanzamento della pagina di aiuto.
Specificare il nome di un attributo che verrà inserito nel tag dell'elemento della pagina di aiuto. Specificare anche la classe che gestirà l'analisi del valore dell'attributo del file del contenuto della pagina di aiuto, quando viene caricata la pagina di aiuto. Il valore dell'attributo deve essere una stringa. La classe specificata deve avere la sottoclasse org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
. Una volta analizzato e caricato il file del contenuto della pagina di aiuto, la classe specificata nel punto di estensione viene richiamata mediante l'interfaccia per aggiungere immagini o pulsanti all'avanzamento della pagina di aiuto (attualmente, accanto al pulsante della guida).
- itemAttribute - questo valore di attributo deve essere una stringa di un nome di attributo inserita in un tag di elemento del file del contenuto della pagina di aiuto. Se la stringa di questo attributo corrisponde a un attributo analizzato dal tag di elemento del file del contenuto della pagina di aiuto, la classe specificata verrà caricata e richiamata per l'analisi del valore completo dell'attributo, mediante la specifica DOM w3. Verrà successivamente richiamata per aggiungere controlli a un elemento composito e i componenti aggiunti (in genere immagini o pulsanti) verranno visualizzati nell'avanzamento della pagina di aiuto per l'elemento specificato (attualmente, accanto all'icona della guida per questo avanzamento).
- class - nome completo della classe che presenta la sottoclasse
org.eclipse.ui.intro.cheatsheets.AbstractItemExtensionElement
per gestire gli attributi conosciuti del file del contenuto
della pagina di aiuto ed estendere gli avanzamenti della pagina di aiuto. La classe deve essere public e avere un costruttore public di 1 argomento che accetti il nome dell'attributo (una stringa
).
Esempi:
Di seguito viene riportato un esempio di
implementazione del punto di estensione:
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
Questo è l'attributo dell'elemento per l'estensione:
<item title=
"XYZ Title"
xyzButton=
"/icon/button.gif"
/>
Il valore dell'attributo nel tag dell'elemento può essere ANYTHING. Il valore può essere tale perché la classe che analizza l'attributo è la classe HandleParsingAndAddButton, che nell'esempio analizza una stringa /icon/button.gif dell'attributo. Successivamente verranno utilizzate queste informazioni per caricare il gif come icona per un nuovo pulsante.
Informazioni API:
Per i dettagli sulle API; consultare le informazioni Javadoc relative a org.eclipse.ui.cheatsheets.AbstractItemExtensionElement.
Implementazione fornita:
Al momento non esiste alcuna implementazione fornita.
Copyright (c) 2004 IBM Corporation e altri.
Tutti i diritti riservati. Questo programma e il materiale di accompagnamento sono disponibili secondo i termini della Eclipse Public
License v1.0 che sono distribuiti con il prodotto, e disponibili all'indirizzo
http://www.eclipse.org/legal/epl-v10.html