Lisäosan luokka

Aiemmin on tarkasteltu erilaisia readme-työkalun toimittamia laajennuksia. Seuraavaksi tarkastellaan readme-työkalulisäosan yleistä määritystä.

Lisäosan määritys

Readme-työkalun lisäosa määritetään MANIFEST.MF-tiedostossa.

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Plugin.name
Bundle-SymbolicName: org.eclipse.ui.examples.readmetool; singleton:=true
Bundle-Version: 3.2.0.qualifier
Bundle-ClassPath: readmetool.jar
Bundle-Activator: org.eclipse.ui.examples.readmetool.ReadmePlugin
Bundle-Vendor: %Plugin.providerName
Bundle-Localization: plugin
Require-Bundle: org.eclipse.ui,
 org.eclipse.core.resources,
 org.eclipse.core.runtime,
 org.eclipse.ui.views,
 org.eclipse.ui.ide,
 org.eclipse.jface.text,
 org.eclipse.text,
 org.eclipse.ui.workbench.texteditor,
org.eclipse.ui.editors
Eclipse-AutoStart: true
Eclipse-AutoStart-kommentti: Käytä Eclipse-AutoStart-parametria
mieluummin kuin Eclipse-LazyStart-toimintoa, koska
readme-esimerkki pitää voida aja asekä 3.1- että 3.2-versiossa.

Lisäosamääritykseen sisältyvät seuraavat lisäosan tiedot: Bundle-Name, Bundle-SymbolicName (lisäosan tunnus), Bundle-Version ja Bundle-Vendor. Useimmat näistä parametreista on esitelty hello world -lisäosan yhteydessä. Readme-työkalu määrittää myös oman lisäosaluokkansa ReadmePlugin.

Myös jar-tiedoston nimi määritetään. Bundle-ClassPath-parametrissa määritetyt tiedostonimet ovat suhteessa lisäosan hakemistoon, joten readme-työkalun jar-tiedosto täytyy sijoittaa suoraan lisäosan hakemistoon.

Require-Bundle-elementti ilmoittaa käyttöympäristölle readme-työkalun riippuvuudet. Työympäristön käyttöliittymälisäosat on lueteltu pakollisina lisäosina yhdessä eri ydinosa-, jface- ja tekstilisäosien kanssa.

AbstractUIPlugin

ReadmePlugin-luokka kuvaa readme-työkalun lisäosaa ja hallitsee lisäosan elinkaarta.  Kuten Hello World -esimerkissä näkyi, lisäosaluokkaa ei tarvitse määrittää.  Ympäristö toimittaa sen.  Tällöin lisäosan on alustettava käyttöliittymään liittyvät tiedot aloituksen yhteydessä.  Ympäristön luokka AbstractUIPlugintarjoaa rakenteen käyttöliittymän resurssien hallintaa varten, ja sen laajentaa ReadmePlugin.

AbstractUIPlugin käyttää yleisiä aloitus- ja lopetusmetodeja kuvien, valintaikkunoiden asetusten ja oletusasetusvaraston hallintaan lisäosan elinkaaren aikana.  ReadmePlugin-luokan yksityiskohtia tarkastellaan valintaikkunoiden ja oletusasetusten yhteydessä.