Esempio: strumento Readme
Introduzione
L'editor Readme illustra come definire dei punti di estensione che possano essere utilizzati da altri plug-in. 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 vista 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 vista aggiuntiva fornita da tale esempio può essere
visualizzata selezionando Finestra > Mostra vista > Altro ed
espandendo la sezione Readme. L'azione di
visualizzazione può essere, invece, visualizzata facendo clic sull'icona
Readme della vista Selezione.
Creazione di un nuovo file Readme
Creare un nuovo file con estensione .readme. Selezionare Nuovo nel menu
File, quindi Altro... nel sottomenu. Fare clic su Semplice nella
creazione guidata, quindi selezionare File dall'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 verrà inserito.
Creazioni guidate di esempi
Selezionare Nuovo nel menu File e Esempio...nel sottomenu. A questo
punto
selezionare Creazioni guidate esempio. Scegliere File Readme. 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 vista Readme
Selezionare un file con estensione .readme nella vista Selezione. Se non esiste alcun file con tale estensione, crearne uno. Sulla
barra degli strumenti locale della vista Selezione verrà visualizzato
un pulsante con la descrizione a comparsa Esegui estensione della vista
Readme. Fare clic su questo pulsante. Viene mostrata una finestra
di dialogo che conferma l'esecuzione dell'azione sulla vista.
Menu di scelta rapida
Nella vista Selezione, selezionare un file con estensione .readme. Se non esiste alcun file con tale estensione, crearne uno.
Selezionare il file per visualizzare il menu di scelta rapida. Nel menu
di scelta rapida è presente una voce Mostra azione Readme.
Selezionando questa voce viene aperta una finestra di dialogo che conferma
l'esecuzione dell'azione del menu di scelta rapida.
Pagina delle preferenze
Dal menu Finestra, selezionare Preferenze. Fare clic sulla pagina
Esempio readme.
Questa mostra un esempio di pagina delle preferenze.
Pagina delle proprietà
Nella vista Selezione, selezionare un file con estensione .readme. Se non
esiste alcun file con tale estensione, crearne uno. Selezionare il file
per visualizzare il menu di scelta rapida, quindi selezionare la voce di menu
Proprietà. Fare clic sulla pagina Strumento readme per visualizzare
un esempio di pagina delle proprietà.
Editor di file Readme
L'editor di file Readme rappresenta l'editor predefinito per i file di tipo
*.readme.
Creare un file con estensione .readme e aprirlo facendo doppio clic su di esso
oppure visualizzando il menu di scelta rapida e selezionando Apri con,
quindi scegliendo Editor del file readme nel sottomenu. L'editor presenta un'icona con una matita.
Lo strumento Readme utilizza tale editor come editor predefinito per
i file di tipo *.readme.
Azioni dell'editor Readme
Viene illustrato un esempio di azioni applicabili solo ad un editor particolare.
Quando è attivo un editor del file Readme, sono presenti 4 pulsanti aggiuntivi
sulla barra degli strumenti: Esegui estensione dell'editor Readme, Azione 1
dell'editor Readme, Azione 2 dell'editor Readme e Azione 3 dell'editor Readme.Quando è attivo un editor del file Readme, verrà visualizzato un menu a discesa denominato Readme.
Esso conterrà le azioni precedentemente descritte: Azione 1
dell'editor Readme, Azione 2 dell'editor Readme e Azione 3 dell'editor Readme.
Vista delle sezioni Readme
Per visualizzare la vista Sezioni Readme, dal menu Finestra selezionare
Mostra vista e quindi Altro... dal sottomenu. Espandere la voce Readme
e selezionare Sezioni Readme. Questo mostrerà un elenco di sezioni del
file *.readme corrente se è stato selezionato un file .readme file nella vista
Selezione. La struttura di un file *.readme può anche essere visualizzata
nella vista Struttura.
Un file con estensione .readme può essere suddiviso in sezioni quando
ciascuna sezione inizia con un numero. Ad esempio, se nell'editor del
file readme fosse immesso il testo seguente, lo strumento readme
individuerebbe 2 sezioni. Per esaminare come vengono individuate le
sezioni nello strumento Readme, immettere alcune parole nell'editor del
file readme, salvare il file con i tasti CTRL+S o scegliendo
File->Salva. Aprire la vista Sezioni Readme e selezionare il file .readme nella vista Selezione.
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
vista Struttura e trascinarla in cima ad un file di testo. Il contenuto della selezione verrà aggiunto al file.
Contributi della Guida
L'esempio di strumento Readme illustra anche come utilizzare e implementare
la Guida sensibile al contesto per tutte le estensioni fornite: una
vista, 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. La guida sensibile
al contesto (F1) è disponibile anche nella vista Sezioni Readme e nella
pagina Creazioni guidate esempio (nella procedura guidata Nuovo).
Dettagli
L'esempio dello strumento Readme dichiara un punto di estensione e fornisce
numerose 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 viste e azioni di visualizzazione, pagine
delle preferenze, pagine delle proprietà, procedure guidate, editor e azioni di
editor, menu di scelta rapida, insiemi 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 vista, utilizzando il punto di estensione org.eclipse.ui.views. Tale punto di estensione definisce anche
una categoria per la vista da utilizzare nella selezione della vista.
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 alla finestra di dialogo
Finestra->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->Esempio....
All'esempio vengono aggiunti diversi stub di azioni. L'insieme di azioni
dichiara un menu con etichetta Editor del file Readme 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 vista 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.