Példa - Tájékoztatóeszköz (Readme)

Bevezetés

A Tájékoztatószerkesztő azt mutatja meg, hogy hogyan határozhatók meg saját kiterjesztési pontok más bedolgozók általi használathoz. Azt is bemutatja, hogy hogyan hozhatók létre kiterjesztések az erőforrások előugró menüinek bejegyzéseihez, új erőforrás varázslókhoz, adott kiterjesztésű (.readme) fájlok szerkesztőihez, egyéni nézethez és adatlapokhoz.

A példa futtatása

Ezen példa használatának elkezdéséhez a fájllétrehozás varázsló vagy a példalétrehozás varázsló használatával hozzon létre egy fájlt .readme kiterjesztéssel. Ezen példa  által biztosított kiegészítő nézet az Ablak > Nézet megjelenítése > Egyéb menüpont kiválasztásával és a Tájékoztató rész kibontásával tekinthető meg. A nézet művelet a Navigátor nézetben a tájékoztató ikonra kattintással jeleníthető meg.

Új tájékoztatófájl létrehozása

Új fájl létrehozása .readme fájlkiterjesztéssel.  A Fájl menüben válassza az Új, majd az Egyéb... menüpontot. Kattintson a varázslóban az Egyszerű lehetőségre, majd válassza a Fájl lehetőséget a bal oldali listában. Kattintson a Tovább elemre a fájlnév megadásához (figyeljen rá, hogy a kiterjesztés .readme legyen!), majd arra a mappára, amelyben el szeretné helyezni a fájlt.

Példalétrehozás varázslók

A Fájl menüben válassza az Új, majd a Példa... menüpontot.  Ezután válassza a Példalétrehozás varázslók lehetőséget. Válassza a Tájékoztatófájl lehetőséget. Kattintson a Tovább gombra. Válassza ki azt a mappát, amelyben a fájlt létre szeretné hozni. Írja be a fájl nevét .readme kiterjesztéssel. Kattintson a Befejezés gombra.

Tájékoztató nézet kiterjesztése művelet

A Navigátor nézetben válasszon ki egy .readme kiterjesztésű fájlt. Ha nincs ilyen, akkor hozzon létre egyet. A Navigátor nézet helyi eszköztárában egy gomb látható, amely előugró leírása a Tájékoztató nézet kiterjesztésének futtatása szöveget tartalmazza.  Kattintson erre a gombra.  Egy párbeszédablak fog megjelenni a Nézet művelet végrehajtva szöveggel.

Előugró menük

A Navigátor nézetben válasszon ki egy .readme kiterjesztésű fájlt.  Ha nincs ilyen, akkor hozzon létre egyet.  Válassza ki a fájlt az előugró menü megnyitásához.  Az előugró menü rendelkezik egy Tájékoztató művelet megjelenítése menüponttal.  Válassza ezt a menüpontot, amely megnyit egy párbeszédablakot az Előugró menü művelet végrehajtva szöveggel.

Beállítás oldal

Az Ablak menüben válassza a Beállítások menüpontot.  Kattintson a Tájékoztató példa nevű oldalra.  Ez megjelenít egy példát egy beállítási oldalról.

Adatlap

A Navigátor nézetben válasszon ki egy .readme kiterjesztésű fájlt.  Ha nincs ilyen, akkor hozzon létre egyet.  Válassza ki a fájlt az előugró menü megnyitásához, majd válassza a Tulajdonságok menüpontot.  Kattintson a Tájékoztatóeszköz nevű oldalra egy példaadatlap megjelenítéséhez.

Tájékoztatófájl-szerkesztő

A Tájékoztatófájl-szerkesztő a *.readme típusú fájlok alapértelmezett szerkesztője.  Hozzon létre egy .readme kiterjesztésű fájlt és kattintson az egérgombbal duplán a fájlra a megnyitásához vagy nyissa meg az előugró menüt és  válassza a Megnyitás..., majd a Tájékoztatófájl-szerkesztővel elemet.   A szerkesztőben látható egy ceruza ikon.  Ez az a szerkesztő, amelyet a tájékoztatóeszköz alapértelmezésben használ a *.readme típusú fájlokhoz.

Tájékoztatószerkesztő műveletek

Itt egy példa látható azokra a műveletekre, amelyek csak egy bizonyos szerkesztőre vonatkoznak.  Amikor egy tájékoztatófájl-szerkesztőnél van a fókusz, akkor 4 kiegészítő eszköztárgomb látható: Tájékoztatószerkesztő kiterjesztésének futtatása, Tájékoztatószerkesztő 1. művelet, Tájékoztatószerkesztő 2. művelet, Tájékoztatószerkesztő 3. művelet.

Egy Tájékoztató nevű legördülő menü jelenik meg, amikor egy tájékoztatófájl-szerkesztő fókuszban van.  Ez az előzőleg leírt műveleteket tartalmazza: Tájékoztatószerkesztő 1. művelet, Tájékoztatószerkesztő 2. művelet, Tájékoztatószerkesztő 3. művelet.

Tájékoztatórészek nézet

A Tájékoztatórészek nézet megjelenítéséhez az Ablak menüben válassza a Nézet megjelenítése, majd az Egyéb... menüpontot.  Bontsa ki a Tájékoztató elemet, majd válassza a Tájékoztatórészek lehetőséget.  Ez megjeleníti az aktuális *.readme fájl részeinek listáját, ha egy .readme fájl ki van választva a Navigátor nézetben.  A *.readme fájl szerkezetét is megtekintheti a Vázlat nézetben.

Egy .readme kiterjesztésű fájl részekre bontható, ahol minden rész egy számmal kezdődik.  Például, ha az alábbi szöveg került beírásra a tájékoztatófájl-szerkesztőben, akkor a tájékoztatóeszköz két részt észlel.   Annak megtekintéséhez, hogy a részeket milyen módon észleli a tájékoztatóeszköz, írjon be valamilyen szöveget a tájékoztatófájl-szerkesztőbe és mentse el a fájlt a CTRL-S billentyűkombináció megnyomásával vagy a  Fájl>Mentés menüpont kiválasztásával.Nyissa meg a Tájékoztatórészek nézetet és válassza ki a .readme fájlt a Navigátor nézetben.

Példaszöveg:

99.1 Ez az első rész
Ez egy szöveg az első részben.

99.1.1 Ez egy alrész
Ez egy szöveg az alrészben.

Fogd és vidd technika

A Fogd és vidd funkcionalitás a Vázlat nézetben egy rész kiválasztásával és a kijelölés egy szövegfájl fölé húzásával tekinthető meg. A kijelölés tartalma hozzáfűzésre kerül a fájlhoz.

Súgó közreműködés

A tájékoztatóeszköz példája azt is bemutatja, hogy a környezetérzékeny súgó hogyan használható és valósítható meg a biztosított összes kiterjesztésen (egy nézet, különféle műveletek és egy varázsló oldal).  Egy művelettel kapcsolatos környezetérzékeny súgó megjelenítéséhez húzza az egeret a menüpont fölé, de ne válassza ki, majd nyomja meg az F1 billentyűt.  A Tájékoztatórészek nézetben és a Példalétrehozás varázslók oldalon (az Új varázsló részben) is használható a környezetérzékeny (F1) súgó.
 

Részletek

A Tájékoztatóeszköz példa egy kiterjesztési pontot deklarál és számos kiterjesztést biztosít.  A biztosított kiterjesztések elég részletesek a Munkaterület működésének megértéséhez, mivel a munkaterület által deklarált számos jóval érdekesebb kiterjesztési pontot használnak fel.  Az ezen példában lévő biztosított kiterjesztések nézetek és nézetműveletek, beállítási oldalak, adatlapok, varázslók, szerkesztők és szerkesztőműveletek, előugró menük, tevékenységkészletek, súgó közreműködések, súgókörnyezetek, valamint lerakás műveletek.

Ez a példa egy bedolgozóban deklarált kiterjesztési pontot is biztosít. Az IReadmeFileParser osztály szükséges minden bedolgozó számára, amely az ezen példa által meghatározott org.eclipse.ui.examples.readmetool.sectionParser kiterjesztést használja. A DefaultSectionParser osztály az IReadmeFileParser példamegvalósítása.

A ReadmeEditor osztály az IEditorPart felületet valósítja meg és a .readme fájlok szerkesztőjeként van megadva a plugin.xml fájlban az org.eclipse.ui.editors kiterjesztési pont használatával. A ReadmeSectionsView osztály az IViewPart felületet valósítja meg és nézetként van megadva az org.eclipse.ui.views kiterjesztési pont használatával. Ez a kiterjesztési pont egy kategóriát határoz meg a nézet számára a nézet kijelölésében használatra.

A beállítások két típusa van megadva ebben a példában, a munkaterület beállítások és az erőforrás tulajdonságok. A munkaterület beállítás a ReadmePreferencePage osztályban van megadva, amely az IWorkbenchPreferencePage felületet valósítja meg, így az Ablak->Beállítások párbeszédablakhoz hozzáadásra fog kerülni. Az osztály az org.eclipse.ui.preferencePages kiterjesztési pontban van megadva a plugin.xml fájlban. A két erőforrás-adatlap a ReadmeFilePropertyPage és a ReadmeFilePropertyPage2, amelyek az IWorkbenchPropertyPage felületet valósítják meg. Mindkettő az IFile típusban a plugin.xml fájlban lévő org.eclipse.ui.propertyPages kiterjesztési pont objectClass jelölője általi meghívásra került meghatározásra.

A ReadmeCreationWizard osztály az INewWizard felületet valósítja meg és a plugin.xml fájlban az org.eclipse.ui.newWizards kiterjesztési pontban van megadva. Ez a kiterjesztési pont annak a varázslónak a kategóriáját is meghatározza, amely akkor jelenik meg, amikor a felhasználó a Fájl->Új->Példa... menüpontot választja ki.

Számos műveletcsonkot tartalmaz ez a példa. A tevékenységkészlet egy Tájékoztatófájl-szerkesztő címkéjű menüt deklarál, amelyet a munkaterület ablak menüsorában kell megjeleníteni az org.eclipse.ui.actionSets kiterjesztési pont használatával. Egy műveletet is meghatároz a munkaterület eszköztára és menüsora számára a toolbarPath és menubarPath jelölők használatával. A WindowActionDelegate osztályt használja, amely az IWorkbenchWindowActionDelegate felületet valósítja meg a művelet kivitelezéséhez. Az előugró menü műveletét a PopupMenuActionDelegate osztály határozza meg objectContribution elemként az  org.eclipse.ui.popupMenus kiterjesztési pontban. A PopupMenuActionDelegate az IObjectActionDelegate felületet valósítja meg és az IWorkbenchPart felületet használja, amely egy üzenet párbeszédablak megnyitására használható. A ViewActionDelegate nézetművelet az org.eclipse.ui.viewActions kiterjesztési pontban van megadva és az IViewActionDelegate felületet valósítja meg. A nézetet, amelyben megjelenik, a targetID jelölő határozza meg, amely ebben a példában org.eclipse.ui.views.ResourceNavigator. A szerkesztőműveletet az EditorActionDelegate osztály adja meg, amely az IEditorActionDelegate felületet valósítja meg és az org.eclipse.ui.editorActions kiterjesztési pont használatával került hozzáadásra. A szerkesztőt, amelyre vonatkozik, a targetID jelölő adja meg, amely ebben a példában org.eclipse.ui.examples.readmetool.ReadmeEditor.

A ReadmeDropActionDelegate az IDropDelegate felületet valósítja meg. Az IDropDelegate felületek minden esetben értesítést kapnak, amikor lerakás művelet kerül végrehajtásra a munkaterületen. Ezen művelet kiterjesztési pontja az org.eclipse.ui.dropActions.