Estensione elemento della pagina di aiuto

org.eclipse.ui.cheatsheets.cheatSheetItemExtension

3.0

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.

<!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>

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).



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.

Per i dettagli sulle API; consultare le informazioni Javadoc relative a org.eclipse.ui.cheatsheets.AbstractItemExtensionElement.

Al momento non esiste alcuna implementazione fornita.