Hauptkomponente anpassen

Bei der Verwendung des Hauptkomponentenmechanismus wird die Produktanpassung unterschiedlich durchgeführt. Das Branding (Markenkennzeichnung) für die Komponente befindet sich in einem Plug-in, das durch die Hauptkomponente identifiziert wird (bzw. dessen Name mit dem der Hauptkomponente identisch ist, falls keiner angegeben sein sollte). Die Dateien, die Branding-Informationen für die fiktive Anwendung "acmeweb" festlegen und definieren, sind in der folgenden Beispielverzeichnisstruktur hervorgehoben:

acmeweb/
	acmeweb.exe	(ausführbare Datei des Produkts; ruft eclipse.exe auf und gibt die Hauptkomponente an)
	eclipse/
		.eclipseproduct
		eclipse.exe
		startup.jar
		install.ini
		.config/
		platform.cfg
		jre/
		features/
			com.example.acme.acmefeature_1.0.0/    (Hauptkomponente)
				feature.xml
		plugins/
			com.example.acme.acmefeature_1.0.0/    (Plug-in für die Hauptkomponente; enthält Markenkennzeichnung).)
				plugin.xml
				about.ini
				about.html
				about.mappings
				about.properties
				acme.png
				plugin_customization.ini
				splash.jpg
				welcome.xml
			com.example.acme.acmewebsupport_1.0.0/
			...
		links/
			...

Das Branding für ein Produkt wird in dem Plug-in bestimmt, das einer Hauptkomponente zugeordnet ist.  Viele Aspekte eines Produkts können angepasst werden.  Anpassungen auf Produktebene werden in der Datei about.ini und anderen darin beschriebenen Dateien definiert.  Produkte können auch die Standardbenutzervorgaben anderer Plug-ins steuern.  Hierfür wird die Datei plugin_customization.ini verwendet.

Unter Bezugnahme auf das Hauptkomponenten-Plug-in des bereits vorgestellten Beispielprodukts soll an dieser Stelle die Anpassung des Produkts genauer untersucht werden.

com.example.acme.acmefeature_1.0.0/
		plugin.xml
		about.ini
		about.html
		about.mappings
		about.properties
		acme.png
		plugin_customization.ini
		plugin_customization.properties
		splash.bmp
		welcome.xml

Im Folgenden werden die gleichen Anpassungsmöglichkeiten betrachtet, die auch schon für den Produktergänzungspunkt unter die Lupe genommen wurden. Hierbei wird genauer darauf eingegangen, wie sich die Spezifikation unterscheidet, wenn der Mechanismus einer Hauptkomponente verwendet wird.

Dialoge "Info über"

Wie bereits bei der Betrachtung der Anpassung auf Produktebene gesehen, sollten alle Komponenten und Plug-ins eine Datei about.html ergänzen, die Informationen über das jeweilige Plug-in enthält.

Die Hauptkomponente liefert außerdem die Informationen und Grafikobjekte für das Gesamtprodukt.  Zur Angabe dieser Informationen werden zusätzliche Dateien eingesetzt.

Fensterimages

Ein farbiges Image mit 16x16 Bildpunkten kann zum Kennzeichnen von Seiten verwendet werden, die von diesem Produkt erstellt wurden.  Es erscheint in der oberen linken Ecke aller Produktfenster.  Es wird im Attribut windowImage der Datei about.ini angegeben.  Der Pfad sollte als relativer Pfad angegeben werden, der sich auf das Plug-in bezieht.  Für die oben dargestellte Verzeichnisstruktur wäre beispielsweise die folgende Pfadangabe korrekt:

windowImage=acme.png

Seite 'Willkommen'

Plug-ins, die den Startseitenmechanismus von Eclipse 2.1 verwenden, sollten die Startseitendatei im Attribut 'welcomePage' der Datei 'about.ini' angeben. Der Pfad sollte als relativer Pfad angegeben werden, der sich auf das Plug-in bezieht.  Für die oben dargestellte Verzeichnisstruktur wäre beispielsweise die folgende Pfadangabe korrekt:

welcomePage=welcome.xml

Sie können auch eine Landessprachensuche für die Datei angeben.  (Weitere Details finden Sie unter Spezifische Dateien für Ländereinstellung.)

welcomePage=$nl$/welcome.xml

Eingangsanzeigen

Die Eingangsanzeige eines Produkts wird in einer Datei splash.bmp bereitgestellt, die sich im Verzeichnis des Hauptkomponenten-Plugs-in befindet.  Das Image sollte im 24-Bit-BMP-Farbformat (RGB-Format) vorliegen und ca. 500 x 330 Pixel groß sein.  Wenn Eingangsanzeigen für unterschiedliche Ländereinstellungen angepasst werden müssen, können sie in ein Fragment des Plug-ins für die Hauptkomponente gestellt werden.

Standardwerte für Benutzervorgaben

Mit der Datei plugin_customization.ini werden die Standardwerte für Benutzervorgaben festgelegt, die durch andere Plug-ins definiert sind.  Bei dieser Datei handelt es sich um eine Formatdatei des Typs java.io.Properties. Normalerweise werden in dieser Datei Werte für Benutzervorgaben definiert, die als Teil der öffentlichen API eines Plug-ins publiziert werden.   Dies bedeutet also, dass es riskant ist, auf Benutzervorgaben zu verweisen, die durch Plug-ins verwendet werden, jedoch nicht in der API formal definiert sind.   

Eine häufig vorgenommene Anpassung ist die Festlegung der Standardperspektive für die Workbench.  Diese Benutzervorgabe ist im Plug-in org.eclipse.ui definiert.   Das folgende Beispiel geht davon aus, dass beim Starten des Produkts die Perspektive "Ressourcen" als Standardperspektive verwendet werden soll.

org.eclipse.ui/defaultPerspectiveId=org.eclipse.ui.resourcePerspective

Sollten Sie feststellen, dass Sie den Standardwert für die Benutzervorgaben eines anderen Plug-ins ändern müssen, sehen Sie in der API-Dokumentation für dieses Plug-in nach, ob die Benutzervorgabe als öffentlich (public) eingestuft ist.

Die Datei plugin_customization.properties enthält übersetzte Zeichenfolgen für die Datei plugin_customization.ini.