Esimerkki - Readme-työkalu

Johdanto

Readme-muokkausohjelma näyttää, miten määritetään omat laajennuspisteet toisten lisäosien käytettäväksi. Se myös näyttää, miten luodaan laajennuksia resurssin ponnahdusvalikkomerkinnöille, ohjatuille uusien resurssien luontitoiminnoille, tiedostonmuokkausohjelmille tunnistetta (.readme) varten, mukautetulle näkymälle ja ominaisuussivuille.

Esimerkin ajo

Luo .readme-tunnisteinen tiedosto tämän esimerkin käytön aloitusta varten käyttämällä ohjattua tiedoston luontitoimintoa tai ohjattua esimerkin luontitoimintoa. Tämä esimerkin tuottama lisänäkymä saadaan esiin valitsemalla Ikkuna > Näytä näkymä > Muu ja laajentamalla Readme-osa. Näkymätoiminto saadaan esiin napsauttamalla navigaattorinäkymän readme-kuvaketta.

Uuden readme-tiedoston luonti

Luo uusi .readme-tunnisteinen tiedosto. Valitse Tiedosto-valikosta Uusi-vaihtoehto ja sitten alivalikosta Muu...-vaihtoehto.Valitse Yksinkertainen-vaihtoehto ohjatussa toiminnossa ja valitse sitten vasemmalla olevasta luettelosta Tiedosto-vaihtoehto.Napsauta Seuraava-painiketta ja määritä tiedoston nimi (varmista, että tunniste on .readme) ja kansio tiedoston säilytystä varten.

Ohjatut esimerkkien luontitoiminnot

Valitse Tiedosto-valikosta Uusi-vaihtoehto ja alivalikosta Esimerkki...-vaihtoehto. Valitse sitten Example Creation Wizards -vaihtoehto. Valitse Readme-tiedosto. Napsauta Seuraava-painiketta. Valitse kansio, johon haluat luoda tiedoston. Kirjoita tiedoston nimi, jolla on .readme-tunniste. Napsauta Valmis-painiketta.

Readme-näkymätunnistetoiminto

Valitse navigaattorinäkymässä .readme-tunnisteinen tiedosto. Jos .readme-tunnisteista tiedostoa ei ole, luo sellainen. Navigaattorinäkymän paikallisella työkalurivillä on painike, jonka koho-ohje osoittaa, että painike on Readme-näkymätunnisteen ajamista varten.Napsauta tätä painiketta.Esiin tulee valintaikkuna, joka osoittaa, että näkymätoiminto on suoritettu.

Ponnahdusvalikot

Valitse navigaattorinäkymässä .readme-tunnisteinen tiedosto. Jos .readme-tunnisteista tiedostoa ei ole, luo sellainen.Valitse tiedosto, jolloin ponnahdusvalikko tulee esiin.Huomaa, että ponnahdusvalikossa on vaihtoehto, jolla voit saada esiin Readme-toiminnon.Avaa valintaikkuna, joka ilmoittaa, että ponnahdusvalikon toiminto on suoritettu, valitsemalla tämä valikkovaihtoehto.

Oletusasetussivu

Valitse Ikkuna-valikosta Oletusasetukset-vaihtoehto.Napsauta sivua Readme Example.Tämä näyttää oletusasetussivun esimerkin.

Ominaisuussivu

Valitse navigaattorinäkymässä .readme-tunnisteinen tiedosto. Jos .readme-tunnisteista tiedostoa ei ole, luo sellainen.Valitse tiedosto, jolloin ponnahdusvalikko tulee esiin, ja valitse sitten Ominaisuudet-valikkovaihtoehto.Napsauta Readme-työkalu-sivua, jotta saat esiin ominaisuussivun esimerkin.

Readme-tiedoston muokkausohjelma

Readme-tiedoston muokkausohjelma on sellaisten tiedostojen oletusmuokkausohjelma, joiden tyyppi on *.readme.  Luo .readme-tunnisteinen tiedosto ja avaa tiedosto kaksoisnapsauttamalla sitä tai tuomalla esiin ponnahdusvalikko, valitsemalla Avaa seuraavan kohteen avulla -vaihtoehto ja valitsemalla sitten alivalikosta Readme File Editor -vaihtoehto.Huomaa, että muokkausohjelman kuvakkeessa on kynän kuva.Readme-työkalu käyttää tätä muokkausohjelmaa oletusarvoisesti *.readme-tyyppisten tiedostojen yhteydessä.

Readme-muokkausohjelman toiminnot

Tämä näyttää esimerkin toiminnoista, joita voidaan käyttää vain jossain tietyssä muokkausohjelmassa.Kun readme-tiedosto on aktiivinen, huomaa työkalurivin 4 lisäpainiketta eli Readme-muokkausohjelmatunnisteen ajon, Readme-muokkausohjelman toiminnon 1, Readme-muokkausohjelman toiminnon 2 ja Readme-muokkausohjelman toiminnon 3 painikkeet.

Näyttöön tulee avattava Readme-valikko, kun readme-tiedostonmuokkausohjelma on aktiivinen.Se sisältää aiemmin kuvatut toiminnot eli Readme-muokkausohjelman toiminto 1:n, Readme-muokkausohjelman toiminto 2:n ja Readme-muokkausohjelman toiminto 3:n.

Readme-osien näkymä

Saat esiin tämän Readme-osien näkymän valitsemalla Ikkuna-valikosta Näytä näkymä -vaihtoehdon ja sitten alivalikosta Muu...-vaihtoehdon.Laajenna Readme-vaihtoehto ja valitse sitten Readme Sections.Esiin tulee *.readme-tiedoston osien luettelo, kun .readme-tiedosto on valittuna navigaattorinäkymässä.Voit myös tarkastella *.readme-tiedoston rakennetta hahmotelmanäkymässä.

.readme-tunnisteinen tiedosto voidaan jakaa osiin, jolloin jokainen osa alkaa numerolla.Jos esimerkiksi seuraava teksti syötetään readme-tiedoston muokkausohjelmaan, readme-työkalu tunnistaa kaksi osaa.Huomaat, miten osat tunnistetaan readme-työkalussa, kun kirjoitat tekstiä readme-tiedoston muokkausohjelmaan ja tallennat tiedoston joko painamalla näppäinyhdistelmää CTRL+S tai valitsemalla  Tiedosto->Tallenna.Avaa Readme-osien näkymä ja valitse navigaattorinäkymässä .readme-tiedosto.

Esimerkkiteksti:

99.1 Tämä on ensimmäinen osa.
Tässä on ensimmäisen osan tekstiä.

99.1.1 Tämä on aliosa.
Tässä on aliosan tekstiä.

Veto ja pudotus

Veto ja pudotus -toiminto tapahtuu siten, että hahmotelmanäkymässä valitaan osa ja valinta vedetään tekstitiedoston päälle. Valinnan sisältö liitetään tiedostoon.

Ohjeet

Readme-työkaluesimerkki myös havainnollistaa, miten käytetään tilannekohtaista ohjetta kaikissa sen antamissa laajennuksissa - näkymässä, eri toiminnoissa ja ohjatun toiminnon sivulla - ja miten ohje toteutetaan.Saat esiin toiminnon tilannekohtaisen ohjeen, kun osoitat valikkovaihtoehtoa, mutta et valitse sitä, ja painat sitten F1-näppäintä.Tilannekohtainen ohje (F1) saadaan esiin myös Readme-osien näkymässä ja ohjatun esimerkin luontitoiminnon sivulla (ohjatussa Uusi-toiminnossa).
 

Tiedot

Readme-työkalun esimerkki esittelee yhden laajennuspisteen ja sisältää muita laajennuksia.Esimerkin sisältämät laajennukset käsittelevät melko laajasti Työympäristön toimintaa, koska siinä käytetään useita työympäristön esittelemiä kiinnostavia laajennuspisteitä.Tämän esimerkin sisältämät laajennukset ovat näkymiä ja näkymätoimintoja, oletusasetussivuja, ominaisuussivuja, ohjattuja toimintoja, muokkausohjelmia ja niiden toimintoja, ponnahdusvalikkoja, toimintojoukkoja, ohjeita, ohjekonteksteja ja pudotustoimintoja.

Tämä esimerkki myös sisältää lisäosassa esitellyn laajennuspisteen. Luokkaa IReadmeFileParser tarvitaan mitä tahansa sellaista lisäosaa varten, jossa käytetään tämän esimerkin määrittämää org.eclipse.ui.examples.readmetool.sectionParser-laajennusta. Luokka DefaultSectionParser on esimerkki IReadmeFileParser-toteutuksesta.

Luokka ReadmeEditor toteuttaa IEditorPart-metodin, ja se on määritetty muokkausohjelmaksi .readme-tunnisteisia tiedostoja varten plugin.xml-tiedostossa käyttämällä org.eclipse.ui.editors-laajennuspistettä. Luokka ReadmeSectionsView toteuttaa rajapinnan IViewPart, ja se on määritetty näkymäksi käyttämällä org.eclipse.ui.views-laajennuspistettä. Tämä laajennuspiste myös määrittää luokan näkymää varten käytettäväksi näkymävalinnassa.

Tässä esimerkissä määritetään kahdentyyppisiä oletusasetuksia: työympäristön oletusasetuksia ja resurssin ominaisuuksia. Työympäristön oletusasetus on määritetty luokassa ReadmePreferencePage, joka toteuttaa rajapinnan IWorkbenchPreferencePage niin, että se lisätään valintaikkunaan Ikkuna > Oletusasetukset. Luokka on määritetty plugin.xml-tiedoston org.eclipse.ui.preferencePages-laajennuspisteessä. Resurssien kaksi ominaisuussivua ovat ReadmeFilePropertyPage ja ReadmeFilePropertyPage2, joista kumpikin toteuttaa rajapinnan IWorkbenchPropertyPage. Kumpikin niistä on määritetty sellaisiksi, että org.eclipse.ui.propertyPages-laajennuspisteen plugin.xml-tiedostossa oleva objectClass-tunniste kutsuu niitä IFile-tyyppiä varten.

Luokka ReadmeCreationWizard toteuttaa INewWizard-rajapinnan, ja se on määritetty plugin.xml-tiedoston org.eclipse.ui.newWizards-laajennuspisteessä. Tämä laajennuspiste myös määrittää luokan, joka tulee näkyviin ohjatussa toiminnossa, kun käyttäjä valitsee vaihtoehdot Tiedosto > Uusi > Esimerkki....

Tähän esimerkkiin lisätään useita toiminnon tukirakenteita. Toimintojoukko esittelee Readme File Editor -valikon , joka sisällytetään työympäristöikkunan valikkopalkkiin käyttämällä org.eclipse.ui.actionSets-laajennuspistettä. Se myös määrittää toiminnon työympäristön työkaluriville ja valikkopalkille käyttämällä tunnisteita toolbarPath ja menubarPath. Se käyttää toiminnon toteutukseen WindowActionDelegate-luokkaa, joka toteuttaa IWorkbenchWindowActionDelegate-rajapinnan. Ponnahdusvalikon toiminnon objectContribution-tyypiksi määrittää org.eclipse.ui.popupMenus-laajennuspisteen PopupMenuActionDelegate-luokka. PopupMenuActionDelegate toteuttaa IObjectActionDelegate-rajapinnan ja avaa sanomavalintaikkunan annetunIWorkbenchPart-komponentin avulla. Näkymätoiminto ViewActionDelegate määritetään org.eclipse.ui.viewActions-laajennuspisteessä ja se toteuttaa rajapinnan IViewActionDelegate. Toiminnon sisältämän näkymän määrittää tunniste targetID, joka tässä esimerkissä on org.eclipse.ui.views.ResourceNavigator. Muokkausohjelmatoiminnon määrittää EditorActionDelegate-luokka, joka toteuttaa IEditorActionDelegate-rajapinnan, ja se lisätään käyttämällä org.eclipse.ui.editorActions-laajennuspistettä. Muokkausohjelman, johon toiminto liitetään, määrittää tunniste targetID, joka tässä esimerkissä määritetään laajennuspisteessä org.eclipse.ui.examples.readmetool.ReadmeEditor.

ReadmeDropActionDelegate-luokka toteuttaa rajapinnan IDropDelegate. IDropDelegate-rajapinnoille ilmoitetaan aina, kun työympäristössä tehdään hylkäystoiminto. Tämän toiminnon laajennuspiste on org.eclipse.ui.dropActions.