Esempio - Strumento Readme
Introduzione
L'editor Readme mostra come definire i propri punti di estensione che saranno utilizzati da altri plugin. Inoltre illustra le modalità di
creazione delle estensioni per le voci dei menu a comparsa delle risorse, le procedure guidate delle nuove risorse, gli editor di file per
un'estensione (.readme), una vista personalizzata e le pagine delle proprietà.
Esecuzione dell'esempio
Per iniziare ad utilizzare questo esempio, creare un file con estensione .readme con la procedura guidata di creazione file oppure
creare un file con la procedura guidata di creazione esempio.
La vista aggiuntiva fornita da questo esempio, può essere visualizzata selezionando Finestra > Mostra vista > Altro ed espandendo
la sezione Readme. L'azione di visualizzazione può essere mostrata selezionando l'icona del readme nella vista Selezione.
Creazione di un nuovo file readme
Creare un nuovo file con estensione .readme. Dal menu File, selezionare Nuovo e poi Altro... dal menu secondario. Nella
procedura guidata scegliere Semplice e poi selezionare File dall'elenco a sinistra. Scegliere Avanti per fornire il nome file
(assicurarsi che l'estensione sia .readme) e la cartella in cui devono essere contenuti i file.
Procedure guidate di creazione esempio
Dal menu File, selezionare Nuovo e dal menu secondario selezionare Esempio...
Quindi selezionare Example Creation Wizards. Selezionare File Readme. Scegliere Avanti. Selezionare la cartella in cui creare
il file. Immettere il nome del file con un'estensione .readme. Scegliere Fine.
Azione di estensione della vista readme
Nella vista Selezione, selezionare un file con estensione .readme. Se non ne esiste uno, creare un file con tale estensione. Sulla barra
degli strumenti locale della vista Selezione, è presente un pulsante con la descrizione a comparsa Run Readme View Extension.
Premere questo pulsante. Viene visualizzata una finestra di dialogo che indica l'esecuzione dell'azione di visualizzazione.
Menu a comparsa
Nella vista Selezione, selezionare un file con estensione .readme. Se non ne esiste uno, creare un file con tale estensione.
Selezionare il file per visualizzare il menu a comparsa. Nel menu a comparsa è presente una voce di menu Show Readme
Action.
Scegliere questa voce di menu per aprire una finestra di dialogo che indica l'esecuzione dell'azione del menu a comparsa.
Pagina delle preferenze
Dal menu Finestra, selezionare Preferenze. Selezionare la pagina denominata Readme Example. Questo mostra un esempio di
pagina delle preferenze.
Pagina delle proprietà
Nella vista Selezione, selezionare un file con estensione .readme. Se non ne esiste uno, creare un file con tale estensione.
Selezionare il file per visualizzare il menu a comparsa, quindi selezionare la voce di menu Proprietà. Selezionare la pagina
denominata Strumento readme per visualizzare un esempio di pagina delle proprietà.
Editor del file readme
L'editor del file readme è l'editor predefinito per i file di tipo *.readme.
Creare un file con estensione .readme ed aprire il file con un doppio clic, oppure aprire il menu a comparsa, selezionando Apri con e
poi scegliendo Readme File Editor dal menu secondario. L'editor è indicato da un'icona con una matita. Per
impostazione predefinita, questo è l'editor utilizzato dallo strumento readme per i file di tipo *.readme.
Azioni dell'editor readme
Viene mostrato un esempio di azioni applicabili solo ad un particolare editor. Quando un editor del file readme è attivo, si può
notare la presenza di altri 4 pulsanti della barra degli strumenti - Run Readme Editor Extension, Readme Editor Action 1,
Readme Editor Action 2, Readme Editor Action 3.
Un menu a discesa denominato Readme viene visualizzato quando l'editor del file readme
diventa attivo. Questo contiene le azioni precedentemente descritte: Readme Editor
Action 1, Readme Editor Action 2, Readme Editor Action 3.
Vista delle sezioni del readme
Per visualizzare la vista Readme Sections, dal menu Finestra selezionare Mostra vista, quindi selezionare Altro... del menu secondario.
Espandere la voce Readme e poi selezionare Readme Sections. Quando si seleziona un
file .readme dalla vista Selezione, viene mostrato un elenco di sezioni del file *.readme corrente. La struttura di un file *.readme può
essere visualizzata anche nella vista Struttura.
Un file con estensione .readme può essere suddiviso in sezioni quando ogni sezione inizia con un numero. Ad esempio, se il testo
riportato di seguito viene immesso nell'editor del file readme, lo strumento readme rileverà 2 sezioni. Per vedere come le sezioni
sono rilevate dallo strumento readme, immettere un testo nell'editor del file readme, salvare il file premendo CTRL-S o
selezionando File->Salva. Aprire la vista Readme Sections e selezionare il file .readme nella vista Selezione.
Testo di esempio:
99.1 Questa è la prima sezione
Altro testo per la prima sezione.
99.1.1 Questa è una sezione secondaria
Altro testo per la sezione secondaria.
Trascinamento e rilascio
La funzione di Trascinamento e rilascio può essere visualizzata selezionando una sezione nella vista Struttura e trascinando la
selezione su un file di testo. Il contenuto della selezione viene accodato al file.
Contributo alla Guida
L'esempio dello strumento readme mostra anche l'uso e l'implementazione della guida sensibile al contesto per tutte le estensioni fornite:
una vista, più azioni e una pagina della procedura guidata. Per ottenere la guida sensibile al contesto per un'azione, passare sulla
voce di menu senza selezionarla, quindi premere il tasto F1. La guida sensibile al contesto (F1) è disponibile anche per la vista delle
sezioni del readme e per la pagina delle procedure guidate di creazione esempio (nella procedura guidata Nuovo).
Dettagli
L'esempio dello strumento readme dichiara un punto di estensione e fornisce diverse estensioni. Le estensioni fornite coprono
ampiamente il funzionamento del workbench, in quanto sono utilizzati numerosi punti di estensione interessanti dichiarati dal workbench.
Le estensioni fornite incluse in questo esempio sono viste e azioni di visualizzazione, pagine delle preferenze, pagine delle proprietà,
procedure guidate, editor e azioni di editor, menu a comparsa, insiemi di azioni, contributi alla guida, contesti della guida e azioni di
rilascio.
Questo esempio fornisce anche un punto di estensione dichiarato nel plugin.
La classe IReadmeFileParser è richiesta per tutti i plugin che utilizzano l'estensione org.eclipse.ui.examples.readmetool.sectionParser
definita da questo esempio. La classe DefaultSectionParser è un'implementazione di esempio di IReadmeFileParser.
La classe ReadmeEditor implementa IEditorPart ed è definita come editor sui file con estensione .readme nel plugin.xml che
utilizza il punto di estensione org.eclipse.ui.editors. La classe ReadmeSectionsView implementa IViewPart ed è definita come una vista che
utilizza il punto di estensione org.eclipse.ui.views. Questo punto di estensione definisce anche una categoria per la vista da utilizzare
nella selezione della vista.
In questo esempio sono definiti due tipi di impostazioni delle preferenze, preferenze del workbench e proprietà delle risorse. La
preferenza del workbench viene definita nella classe ReadmePreferencePage che implementa IWorkbenchPreferencePage, in modo da aggiungerla
alla finestra di dialogo Finestra -> Preferenze. La classe viene definita nel punto di estensione org.eclipse.ui.preferencePages in
plugin.xml. Le due pagine delle proprietà delle risorse sono ReadmeFilePropertyPage
e ReadmeFilePropertyPage2, entrambe che implementano IWorkbenchPropertyPage.
Queste sono state definite per essere richiamate sul tipo IFile dal tag objectClass
nel plugin.xml del punto di estensione org.eclipse.ui.propertyPages.
La classe ReadmeCreationWizard implementa INewWizard ed è definita nel punto di estensione org.eclipse.ui.newWizards in plugin.xml. Questo
punto di estensione definisce anche la categoria della procedura guidata visualizzata quando si seleziona File -> Nuovo -> Esempio....
A questo esempio sono stati aggiunti numerosi stub di azione. L'insieme di azioni dichiara un menu con etichetta Readme File Editor
da includere nella barra dei menu della finestra del workbench che utilizza il punto di estensione org.eclipse.ui.actionSets. Definisce
anche un'azione per la barra degli strumenti e per la barra di menu del workbench che utilizza i tag toolbarPath e menubarPath. Utilizza
la classe WindowActionDelegate che implementa IWorkbenchWindowActionDelegate per realizzare l'azione.
L'azione per il menu a comparsa viene definita come objectContribution dalla classe PopupMenuActionDelegate nel punto di estensione org.eclipse.ui.popupMenus.
PopupMenuActionDelegate implementa IObjectActionDelegate ed utilizza l'IWorkbenchPart fornito
per aprire una finestra di dialogo dei messaggi. L'azione di visualizzazione ViewActionDelegate è definita nel punto di estensione
org.eclipse.ui.viewActions ed implementa IViewActionDelegate. La vista in cui appare viene definita dal tag targetID, che in questo esempio
è org.eclipse.ui.views.ResourceNavigator. L'azione dell'editor viene definita dalla classe EditorActionDelegate che implementa IEditorActionDelegate
ed è aggiunta utilizzando il punto di estensione org.eclipse.ui.editorActions. L'editor a cui si applica viene definito dal tag targetID,
che in questo esempio è org.eclipse.ui.examples.readmetool.ReadmeEditor.
La classe ReadmeDropActionDelegate implementa IDropDelegate. Gli
IDropDelegate sono informati ogni volta che viene eseguita un'azione di rilascio nel workbench . Il punto di estensione per questa azione è org.eclipse.ui.dropActions.