Ohjatut lisäosien sisällön luontitoiminnot
Tunniste:
org.eclipse.pde.ui.pluginContent
Kuvaus:
Tämän laajennuspisteen avulla voidaan ottaa käyttöön ohjattuja toimintoja, jotka luovat lisäsisältöä PDE-lisäosaprojekteihin. Kun lisäosan manifest-tiedosto ja avaintiedostot on luotu, näiden ohjattujen toimintojen avulla voidaan lisätä tiedostoja ja laajennuksia alkuperäiseen rakenteeseen. Tällaisen ohjatun toiminnon tavallinen toteutus lisää sisältöä parametroidun mallipohjan perusteella. Mallipohja puolestaan on mukautettu käyttäjän ohjatussa toiminnossa tekemien valintojen perusteella.
Tavoitteena on lisäosa, joka tekee jotakin hyödyllistä heti luonnin jälkeen (esimerkiksi lisää näkymän tai muokkausohjelman).
Merkintärakenne:
<!ELEMENT extension (wizard*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - kohteena olevan laajennuspisteen tarkka tunnus.
- id - laajennuksen ilmentymän valinnainen tunnus.
- name - laajennuksen ilmentymän valinnainen nimi.
<!ELEMENT wizard (description?)>
<!ATTLIST wizard
id CDATA #REQUIRED
name CDATA #REQUIRED
icon CDATA #IMPLIED
class CDATA #REQUIRED
category CDATA #IMPLIED
ui-content (true | false) "true"
java (true | false) "true"
rcp (true | false) "false"
pureOSGi (true | false) "false"
requiresActivator (true | false) "false">
- id - yksilöllinen nimi, jonka avulla tämä ohjattu toiminto yksilöidään.
- name - käännettävä nimi, jota käytetään tämän ohjatun toiminnon käyttöliittymäesityksessä.
- icon - sen kuvakkeen suhteellinen polku, jota käytetään ohjatun toiminnon visuaaliseen esitykseen.
- class - org.eclipse.pde.ui.IPluginContentWizard-rajapinnan toteuttavan luokan tarkennettu nimi.
- category - valinnainen tunniste, jonka avulla ohjattuja sisällön luontitoimintoja voidaan liittää eri kohdeprojekteihin.
- ui-content - määrite, joka osoittaa, lisääkö ohjattu toiminto koodia käyttöliittymän sisällön kanssa. Tämä määrite vaikuttaa siihen, mikä lisäosaluokka valitaan (käyttöliittymän lisäosat laajentavat
AbstractUIPlugin
-luokkaa, kun taas muut kuin käyttöliittymän lisäosat laajentavat Plugin
-perusluokkaa). Koska monissa Eclipse-lisäyksissä on käyttöliittymän sisältöä, tämän määritteen oletusarvo on true
.
- java - määrite, joka osoittaa, että ohjattu toiminto lisää Java-sisältöä. Koska useimmissa Eclipse-lisäosissa on Java-koodia, määritteen oletusarvo on
true
. Aseta määritteen arvoksi false
, jos lisäosassa ei ole tarkoitus olla Java-koodia (vaan esimerkiksi vain dokumentaatiotiedostoja).
- rcp - käytössä versiosta 3.1 alkaen. Totuusarvomäärite, joka osoittaa, lisääkö ohjattu toiminto erillisen RCP-sovelluksen täysversion. Jos määritteen arvoksi asetetaan
true
, ohjattu toiminto näkyy ohjatussa uuden lisäosaprojektin luontitoiminnossa vain, kun käyttäjä valitsee RCP-sovellus-vaihtoehdon.
- pureOSGi - käytössä versiosta 3.2 alkaen. Totuusarvomäärite, joka osoittaa, lisääkö ohjattu toiminto aidon OSGi-resurssijoukon. Jos määritteen arvoksi asetetaan
true
, ohjattu toiminto näkyy ohjatussa uuden lisäosaprojektin luontitoiminnossa vain, kun käyttäjä luo aidon OSGi-resurssijoukon.
- requiresActivator - käytössä versiosta 3.2 alkaen. Totuusarvomäärite, joka osoittaa, lisääkö ohjattu toiminto aktivointiluokan. Jos määritteen arvoksi asetetaan
true
, ohjattu toiminto näkyy ohjatussa uuden lisäosaprojektin luontitoiminnossa vain, kun käyttäjä luo aktivointitoiminnon ohjaamaan lisäosan elinkaarta.
<!ELEMENT description (#PCDATA)>
Tämän ohjatun toiminnon lyhyt kuvaus.
Esimerkkejä:
Seuraavassa on esimerkki laajennuspisteestä:
<extension point=
"org.eclipse.pde.ui.pluginContent"
>
<wizard
name=
"Example Plug-in Content Generator"
icon=
"icons/content_wizard.gif"
class=
"com.example.xyz.ContentGeneratorWizard"
id=
"com.example.xyz.ExampleContentGenerator"
>
<description>
Lisää näkymän ja oletusasetussivun.
</description>
</wizard>
</extension>
API-tiedot:
Tähän laajennuspisteeseen kytkettävien ohjattujen toimintojen täytyy toteuttaa org.eclipse.pde.ui.IPluginContentWizard-rajapinta, ja niiden oletetaan laajentavan org.eclipse.jface.wizard.Wizard
-rajapintaa.
Toimitettu toteutus:
PDE-kehitysympäristössä voidaan sovellusohjelmaliittymien (API) avulla lisätä ohjattuja sisällön luontitoimintoja mukautettujen mallipohjien perusteella. Itse PDE-käyttöliittymä antaa käyttöön useita näihin mallipohjiin perustuvia konkreettisia ohjattuja toimintoja.
Copyright (c) 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which
accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html.