Suchseiten
Kennung:
org.eclipse.search.searchPages
Beschreibung:
Über diesen Erweiterungspunkt kann ein
Plug-in Suchseiten für spezielle Suchvorgänge registrieren. Wenn die Suchaktion für eine Ressource ausgeführt wird, lokalisiert die Suchinfrastruktur die am meisten spezifische Suchseite, die für die Ressource registriert ist.
Konfigurationsbefehle:
<!ELEMENT extension (page*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - Vollständig qualifizierte ID des Zielerweiterungspunktes
- id - Optionale ID des Erweiterungsexemplars
- name - Optionaler Name des Erweiterungsexemplars
<!ELEMENT page EMPTY>
<!ATTLIST page
id CDATA #REQUIRED
label CDATA #REQUIRED
class CDATA #REQUIRED
icon CDATA #IMPLIED
sizeHint CDATA #IMPLIED
tabPosition CDATA #IMPLIED
extensions CDATA #IMPLIED
searchViewHelpContextId CDATA #IMPLIED
showScopeSection (true | false)
enabled (true | false)
canSearchEnclosingProjects (true | false) >
- id: Ein eindeutiger Name, der diese Suchseite kennzeichnet.
- label: Eine umsetzbare Bezeichnung, die auf der Registerkarte der Suchseite verwendet wird.
- class - Der Name einer Klasse, die org.eclipse.search.ui.ISearchPage implementiert. Die Aufnahme von org.eclipse.jface.dialogs.DialogPage als Unterklasse wird empfohlen.
- icon: Der relative Name des Images, das für alle Ressourcen verwendet wird, die den angegebenen Erweiterungen entsprechen.
Wenn dieses Attribut übergangen wird, enthält die Registerkarte der Suchseite lediglich einen Kennsatz.
- sizeHint: Ein Hinweis auf die Anfangsgröße der Seite. Hierbei handelt es sich um eine Zeichenfolge, die Breite und Höhe durch ein
Komma voneinander getrennt angibt (z.B. "50, 60"). Wenn dieses Attribut übergangen wird, ist die Seite nicht größer als
die übrigen Seiten.
- tabPosition: Eine ganze Zahl, die definiert, wo die Seite im Seitenbuch platziert werden soll. Dieser Wert definiert nicht die absolute Position, sondern nur die
relative Position in Bezug auf die übrigen Seiten. Die Reihenfolge der Seiten richtet sich nach den folgenden Regeln:
-
Falls keine Seite die Position der Registerkarte definiert, werden die Registerkarte alphabetisch nach ihren Bezeichnungen sortiert.
-
Falls beide Seiten die Position der Registerkarte definieren, wird zunächst die Seite mit dem niedrigeren Wert angezeigt. Wenn die Werte identisch sind, werden die Seiten so behandelt, als ob keine Werte vorhanden wären (siehe Punkt 1).
-
Wenn der Wert nur für eine Seite angegeben ist, wird diese Seite zuerst angezeigt.
- extensions: Eine durch Kommata untergliederte Liste der
Dateierweiterungen, auf die die Suchseite angewendet werden kann. Jede Erweiterung muss außerdem eine Wertigkeit enthalten (0 gibt die niedrigste Wertigkeit an), damit die Suchinfrastruktur die am besten geeignete Seite ermitteln kann. Die Wertigkeit wird von der Erweiterung durch einen Doppelpunkt
getrennt. Falls eine Suchseite alle möglichen Ressourcen suchen kann, sollte der Wert "*" verwendet werden.
- searchViewHelpContextId - Eine optionale ID des Hilfekontextes der Suchsicht, die Ergebnisse dieser Seite anzeigt. Wenn dieses Attribut fehlt, dann wird die ID des Hilfekontextes der Standardsuche (org.eclipse.search.search_view_context) verwendet.
- showScopeSection - Wenn dieses Attribut fehlt oder auf "false" gesetzt ist, wird der Abschnitt für den Bereich im Suchdialog nicht angezeigt.
Dieses Attribut muss auf "true" gesetzt sein, damit der Abschnitt für den Bereich angezeigt wird.
Plug-ins, die ihre eigene Suchseite hinzufügen und den Abschnitt für den Bereich anzeigen möchten, müssen dieses Attribut ihrer Datei "plugin.xml" hinzufügen.
- enabled - Wenn dieses Attribut fehlt oder auf "false" gesetzt ist, wird die Seite im Suchdialog zunächst nicht angezeigt.
Die Seite kann vom Benutzer über die Schaltfläche "Anpassen..." im Suchdialog aktiviert werden.
- canSearchEnclosingProjects - Wenn dieses Attribut fehlt oder auf "false" gesetzt ist, wird der Suchbereich"Enclosing Projects" nicht für den Bereich im Suchdialog angezeigt.
Wenn das Attribut "showScopeSection" fehlt oder auf "false" gesetzt ist, wird dieses Attribut ignoriert.
Beispiele:
Beispiel einer Erweiterungsdefinition für eine Suchseite:
<extension point=
"org.eclipse.search.searchPages"
>
<page
id=
"org.eclipse.search.ui.text.TextSearchPage"
label=
"Text Search"
icon=
"icons/full/obj16/tsearch_pref.gif"
sizeHint=
"250,160"
tabPosition=
"1"
extensions=
"*:1"
showScopeSection=
"true"
class=
"org.eclipse.search.ui.text.TextSearchPage"
>
</page>
</extension>
API-Information:
Die ergänzte Klasse muss org.eclipse.search.ui.ISearchPage
implementieren.
Bereitgestellte Implementierung:
Die
Suchinfrastruktur stellt eine Suchseite für die Volltextsuche zur Verfügung.
Copyright (c) 2001, 2004 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.