Esempio: strumento Leggimi
Introduzione
L'editor Leggimi illustra come definire dei punti di estensione che possano essere utilizzati da altri plugin. Mostra, inoltre, come creare estensioni per le voci del menu di scelta rapida delle risorse, per le creazioni guidate nuova risorsa, per gli editor di file su un'estensione (.readme), per una visualizzazione personalizzata e per le pagine delle proprietà.
Esecuzione dell'esempio
Per iniziare a utilizzare questo esempio creare un file con estensione .readme mediante la Creazione guidata file oppure crearne uno utilizzando la Creazione guidata esempio.
La visualizzazione aggiuntiva fornita da tale esempio può essere visualizzata selezionando Prospettive > Mostra visualizzazione > Altro ed espandendo la sezione Leggimi. L'azione di visualizzazione può essere, invece, visualizzata facendo clic sull'icona Leggimi della visualizzazione Navigator.
Creazione di un nuovo file Leggimi
Creare un nuovo file con estensione .readme. Selezionare Nuovo nel menu File, quindi selezionare Altro...nel sottomenu. Fare clic su Semplice nella creazione guidata, quindi selezionare File nell'elenco a sinistra. Fare clic su Avanti per specificare il nome file (assicurarsi che l'estensione sia .readme) e la cartella nella quale il file sarà inserito.
Creazioni guidate esempio
Selezionare Nuovo nel menu File e Altro...nel sottomenu. A questo punto selezionare Creazioni guidate esempio. Scegliere File Leggimi. Fare clic su Avanti. Selezionare la cartella nella quale si desidera creare il file. Immettere il nome del file con estensione .readme. Fare clic su Fine.
Azione di estensione della visualizzazione Leggimi
Selezionare un file con estensione .readme nella visualizzazione Navigator. Se non esiste alcun file con tale estensione, crearne uno. Sulla barra degli strumenti locale della visualizzazione Navigator verrà visualizzato un pulsante con la descrizione a comparsa Esegui estensione della visualizzazione Leggimi.
Fare clic su tale pulsante. Verrà visualizzata una finestra di dialogo che avverte che l'azione di visualizzazione è stata eseguita.
Menu di scelta rapida
Selezionare un file con estensione .readme nella visualizzazione Navigator. Se non esiste alcun file con tale estensione, crearne uno. Selezionare il file per visualizzare il menu di scelta rapida. In tale menu esiste la voce Mostra azione Leggimi. Scegliere questa voce per aprire una finestra di dialogo che avverte che l'azione del menu di scelta è stata eseguita.
Pagina delle preferenze
Selezionare Preferenze nel menu Finestra. Fare clic sulla pagina denominata Esempio Leggimi. Verrà visualizzato un esempio di una pagina delle preferenze.
Pagina delle proprietà
Selezionare un file con estensione .readme nella visualizzazione Navigator. Se non esiste alcun file con tale estensione, crearne uno. Selezionare il file per visualizzare il menu di scelta rapida, quindi scegliere la voce di menu Proprietà. Fare clic sulla pagina denominata Strumento Leggimi per visualizzare un esempio di una pagina delle proprietà.
Editor di file Leggimi
L'editor di file Leggimi rappresenta l'editor predefinito per i file di tipo *.readme.
Creare un file con estensione .readme e aprirlo facendo doppio clic su di esso o visualizzando il menu di scelta rapida e selezionando Apri con, quindi scegliendo Editor del file Leggimi nel sottomenu. L'editor presenta un'icona con una matita. Lo strumento Leggimi utilizza tale editor come impostazione predefinita per i file di tipo *.readme.
Azioni dell'editor Leggimi
Viene illustrato un esempio di azioni che possono essere applicate solo a un editor specifico. Quando è attivo un editor del file Leggimi, sono presenti 4 pulsanti aggiuntivi sulla barra degli strumenti: Esegui estensione dell'editor Leggimi, Azione 1 dell'editor Leggimi, Azione 2 dell'editor Leggimi e Azione 3 dell'editor Leggimi.
Quando è attivo un editor del file Leggimi, verrà visualizzato un menu a discesa denominato Leggimi. Esso conterrà le azioni precedentemente descritte: Azione 1 dell'editor Leggimi, Azione 2 dell'editor Leggimi e Azione 3 dell'editor Leggimi.
Visualizzazione delle sezioni Leggimi
Per aprire la visualizzazione Sezioni Leggimi, selezionare Mostra visualizzazione nel menu Prospettiva, quindi scegliere Altro... nel sottomenu. Espandere la voce Leggimi, quindi selezionare Sezioni Leggimi. Questa operazione consentirà di visualizzare un elenco delle sezioni nel file *.readme corrente quando tale file verrà selezionato nella visualizzazione Navigator. È possibile, inoltre, visualizzare la struttura di un file *.readme nella visualizzazione Struttura.
Un file con estensione .readme può essere suddiviso in sezioni quando ciascuna di esse inizia con un numero. Ad esempio, se nell'editor del file Leggimi è stato inserito il testo riportato di seguito, lo strumento Leggimi individuerà 2 sezioni. Per esaminare come vengono individuate le sezioni nello strumento Leggimi, immettere alcune parole nell'editor del file Leggimi, salvare il file digitando CTRL+S o scegliendo File->Salva. Aprire la visualizzazione Sezioni Leggimi e selezionare il file .readme nella visualizzazione Navigator.
Testo di esempio:
99.1 Prima sezione
Testo nella prima sezione.
99.1.1 Sottosezione
Testo nella sottosezione.
Trascinamento
Per esaminare la funzione di trascinamento, selezionare una sezione nella visualizzazione Struttura e trascinarla in cima a un file di testo. Il contenuto della selezione verrà aggiunto al file.
Contributi della Guida
L'esempio di strumento Leggimi illustra anche come utilizzare e implementare la Guida sensibile al contesto per tutte le estensioni fornite: una visualizzazione, diverse azioni e una pagina di procedura guidata. Per ottenere la Guida sensibile al contesto per un'azione, posizionare il cursore sulla voce di menu senza selezionarla, quindi premere il tasto F1. È possibile ottenere la Guida sensibile al contesto (F1) anche per la visualizzazione Sezioni Leggimi e per la pagina delle Creazioni guidate esempio(contenuta nella creazione guidata).
Dettagli
L'esempio Strumento Leggimi dichiara un punto di estensione e fornisce determinate estensioni. Le estensioni fornite consentono di comprendere
come funziona il Workbench, dal momento che utilizza alcuni punti di estensione di un certo interesse dichiarati dal workbench. Le estensioni fornite incluse in tale esempio rappresentano visualizzazioni e azioni di visualizzazione, pagine
delle preferenze, pagine delle proprietà, procedure guidate, editor e azioni di editor, menu di scelta rapida, serie di azioni, contributi della Guida, contesti della guida e azioni di rilascio.
Questo esempio fornisce, inoltre, un punto di estensione dichiarato nel plug-in.
Per ogni plug-in che utilizza l'estensione org.eclipse.ui.examples.readmetool.sectionParser definita da tale esempio, viene richiesta la classe IReadmeFileParser. La classe DefaultSectionParser costituisce
una implementazione di esempio della classe IReadmeFileParser.
La classe ReadmeEditor implementa IEditorPart e viene definita quale editor
sui file con estensione .readme nel plugin.xml, utilizzando il punto di estensione org.eclipse.ui.editors. La classe ReadmeSectionsView implementa IViewPart e viene definita quale visualizzazione, utilizzando il punto di estensione org.eclipse.ui.views. Tale punto di estensione definisce anche
una categoria per la visualizzazione da utilizzare nella selezione della visualizzazione.
Questo esempio definisce due tipi di impostazioni di preferenze, le preferenze del workbench e le proprietà delle risorse. La preferenza del workbench viene definita nella classe ReadmePreferencePage che implementa IWorkbenchPreferencePage
in modo che sia aggiunta a Workbench->finestra di dialogo Preferenze. La classe viene definita nel punto di estensione org.eclipse.ui.preferencePages all'interno del
plugin.xml. Le due pagine di proprietà delle risorse sono ReadmeFilePropertyPage
e ReadmeFilePropertyPage2, che implementano entrambe IWorkbenchPropertyPage.
Sono entrambe definite per essere richiamate sul tipo IFile mediante il tag objectClass contenuto nel plugin.xml nel punto di estensione org.eclipse.ui.propertyPages.
La classe ReadmeCreationWizard implementa INewWizard e viene definita
nel punto di estensione org.eclipse.ui.newWizards all'interno del plugin.xml. Tale punto di estensione definisce anche la categoria che utilizza la procedura guidata visualizzata quando l'utente seleziona File->Nuovo>Altro....
All'esempio vengono aggiunti diversi stub di azioni. La serie di azioni dichiara un menu con etichetta Editor del file Leggimi da includere nella barra dei menu della finestra del workbench, mediante il punto di estensione org.eclipse.ui.actionSets. Definisce, inoltre, un'azione per la barra degli strumenti e la barra dei menu del workbench mediante i tag
toolbarPath e menubarPath. Utilizza, infine, la classe WindowActionDelegate
che implementa IWorkbenchWindowActionDelegate per implementare l'azione.
L'azione relativa al menu di scelta rapida viene definita come objectContribution dalla classe PopupMenuActionDelegate contenuta nel punto di estensione org.eclipse.ui.popupMenus.
PopupMenuActionDelegate implementa IObjectActionDelegate e utilizza la classe IWorkbenchPart
fornita per aprire una finestra di dialogo di messaggio. L'azione di visualizzazione ViewActionDelegate viene definita nel punto di estensione org.eclipse.ui.viewActions e implementa IViewActionDelegate. La visualizzazione in cui appare viene definita dal tag targetID
che nell'esempio è rappresentato da org.eclipse.ui.views.ResourceNavigator. Le azioni dell'editor vengono definite
dalla classe EditorActionDelegate che implementa IEditorActionDelegate
e vengono aggiunte mediante il punto di estensione org.eclipse.ui.editorActions. L'editor a cui sono applicate tali azioni viene definito dal tag targetID che nell'esempio viene determinato su org.eclipse.ui.examples.readmetool.ReadmeEditor.
La classe
ReadmeDropActionDelegate implementa IDropDelegate. Le classi IDropDelegate vengono informate ogni volta che viene eseguita un'azione di rilascio nel workbench. Il punto di estensione relativo a tale azione è rappresentato da org.eclipse.ui.dropActions.