Nabídky, panely nástrojů a akce editorů

org.eclipse.ui.editorActions

Tento bod rozšíření se používá pro přidávání akcí do nabídky a panelu nástrojů editorů registrovaných jinými moduly plug-in.

Počáteční sada příspěvků pro editor je definována jiným bodem rozšíření (org.eclipse.ui.editors). Jedna sada akcí je vytvořena a sdílena všemi instancemi stejného typu editoru. Při jejich vyvolání působí tyto akce na aktivní editor. Tento bod rozšíření následuje stejný vzorek. Každé rozšíření akce je vytvořeno a sdíleno všemi instancemi stejného typu editoru. Třída akce musí implementovat org.eclipse.ui.IEditorActionDelegate. Aktivní editor je předán delegátovi vyvoláním IEditorActionDelegate.setActiveEditor.

Zpřístupnění nebo viditelnost zvolené akce lze nastavit pomocí příslušného prvku enablement nebo visibility. Tyto dva prvky obsahují logický výraz, který je vyhodnocen pro stanovení zpřístupnění (enablement) anebo viditelnosti (visibility).

Syntaxe je stejná jak pro prvek enablement, tak i pro prvek visibility. Oba obsahují pouze jeden dílčí prvek logického výrazu. V nejjednodušším případě to bude prvek objectClass, objectState, pluginState nebo systemProperty. V komplexnějších případech mohou být kombinovány prvky and, or a not pro vytvoření logického výrazu. Prvky and a or musí obsahovat 2 dílčí prvky. Prvek not musí obsahovat pouze 1 dílčí prvek.

<!ELEMENT extension (editorContribution+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT editorContribution (menu* , action*)>

<!ATTLIST editorContribution

id       CDATA #REQUIRED

targetID CDATA #REQUIRED>

Tento prvek se používá k definování skupiny akcí anebo nabídek editoru.



<!ELEMENT action (selection* | enablement?)>

<!ATTLIST action

id            CDATA #REQUIRED

label         CDATA #REQUIRED

accelerator   CDATA #IMPLIED

definitionId  CDATA #IMPLIED

menubarPath   CDATA #IMPLIED

toolbarPath   CDATA #IMPLIED

icon          CDATA #IMPLIED

disabledIcon  CDATA #IMPLIED

hoverIcon     CDATA #IMPLIED

tooltip       CDATA #IMPLIED

helpContextId CDATA #IMPLIED

style         (push|radio|toggle) "push"

state         (true | false)

class         CDATA #REQUIRED

enablesFor    CDATA #IMPLIED

actionID      CDATA #IMPLIED>

Tento prvek definuje akci, kterou může uživatel vyvolat v uživatelském rozhraní.



<!ELEMENT menu (separator+ , groupMarker*)>

<!ATTLIST menu

id    CDATA #REQUIRED

label CDATA #REQUIRED

path  CDATA #IMPLIED>

Tento prvek se používá pro definování nové nabídky.



<!ELEMENT separator EMPTY>

<!ATTLIST separator

name CDATA #REQUIRED>

Tento prvek se používá pro vytváření oddělovače nabídky v nové nabídce.



<!ELEMENT groupMarker EMPTY>

<!ATTLIST groupMarker

name CDATA #REQUIRED>

Tento prvek se používá pro vytváření pojmenované skupiny v nové nabídce. Na rozdíl od prvku separator nemá žádné vizuální znázornění v nové nabídce.



<!ELEMENT selection EMPTY>

<!ATTLIST selection

class CDATA #REQUIRED

name  CDATA #IMPLIED>

Tento prvek se používá pro usnadnění zjištění, zda je akce zpřístupněna na základě aktuálního výběru. Prvek je ignorován, pokud je zadán prvek enablement.



<!ELEMENT enablement (and | or | not | objectClass | objectState | pluginState | systemProperty)>

Tento prvek se používá k definování zpřístupnění pro rozšíření.



<!ELEMENT visibility (and | or | not | objectClass | objectState | pluginState | systemProperty)>

Tento prvek se používá k definování viditelnosti pro rozšíření.



<!ELEMENT and (and | or | not | objectClass | objectState | pluginState | systemProperty)>

Tento prvek představuje logickou operaci AND na výsledku vyhodnocení dvou výrazů jeho dílčích prvků.



<!ELEMENT or (and | or | not | objectClass | objectState | pluginState | systemProperty)>

Tento prvek představuje logickou operaci OR na výsledku vyhodnocení dvou výrazů jeho dílčích prvků.



<!ELEMENT not (and | or | not | objectClass | objectState | pluginState | systemProperty)>

Tento prvek představuje logickou operaci NOT na výsledku vyhodnocení výrazů jeho dílčích prvků.



<!ELEMENT objectClass EMPTY>

<!ATTLIST objectClass

name CDATA #REQUIRED>

Tento prvek se používá pro vyhodnocení třídy nebo rozhraní každého objektu v aktuálním výběru. Pokud každý objekt ve výběru implementuje zadanou třídu nebo rozhraní, je výraz vyhodnocen jako true.



<!ELEMENT objectState EMPTY>

<!ATTLIST objectState

name  CDATA #REQUIRED

value CDATA #REQUIRED>

Tento prvek se používá pro vyhodnocení stavu atributu každého objektu v aktuálním výběru. Pokud má každý objekt ve výběru zadaný stav atributu, je výraz vyhodnocen jako pravdivý (true). Aby bylo možné vyhodnotit tento typ výrazu, musí se každý objekt ve výběru implementovat nebo přizpůsobit rozhraní org.eclipse.ui.IActionFilter.



<!ELEMENT pluginState EMPTY>

<!ATTLIST pluginState

id    CDATA #REQUIRED

value (installed|activated) "installed">

Tento prvek se používá pro vyhodnocení stavu modulu plug-in. Stav modulu plug-in může být jeden z následujících: instalován (ekvivalentní stavu "vyřešený" v rámci konceptu OSGi) nebo aktivován (ekvivalentní stavu "aktivní" v rámci konceptu OSGi).



<!ELEMENT systemProperty EMPTY>

<!ATTLIST systemProperty

name  CDATA #REQUIRED

value CDATA #REQUIRED>

Tento prvek se používá pro vyhodnocení stavu některé vlastnosti systému. Hodnota vlastnosti je získána z java.lang.System.



Dále je uveden příklad rozšíření akce editoru:

   

<extension point=

"org.eclipse.ui.editorActions"

>

<editorContribution id=

"com.xyz.xyzContribution"

targetID=

"com.ibm.XMLEditor"

>

<menu id=

"XYZ"

label=

"&amp;XYZ Menu"

>

<separator name=

"group1"

/>

</menu>

<action id=

"com.xyz.runXYZ"

label=

"&amp;Run XYZ Tool"

menubarPath=

"XYZ/group1"

toolbarPath=

"Normal/additions"

style=

"toggle"

state=

"true"

icon=

"icons/runXYZ.gif"

tooltip=

"Run XYZ Tool"

helpContextId=

"com.xyz.run_action_context"

class=

"com.xyz.actions.RunXYZ"

>

<selection class=

"org.eclipse.core.resources.IFile"

name=

"*.java"

/>

</action>

</editorContribution>

</extension>

Ve výše uvedeném příkladu se uvedená akce zobrazí jako zaškrtávací políčko v nové nabídce nejvyšší úrovně nazvané "Nabídka XYZ" a jako přepínací tlačítko v panelu nástrojů. Akce bude zpřístupněna, pokud výběr obsahuje pouze prostředky souboru Java.

Dále je uveden jiný příklad rozšíření akce editoru:

   

<extension point=

"org.eclipse.ui.editorActions"

>

<editorContribution id=

"com.xyz.xyz2Contribution"

targetID=

"com.ibm.XMLEditor"

>

<menu id=

"XYZ2"

label=

"&amp;XYZ2 Menu"

path=

"edit/additions"

>

<separator name=

"group1"

/>

</menu>

<action id=

"com.xyz.runXYZ2"

label=

"&amp;Run XYZ2 Tool"

menubarPath=

"edit/XYZ2/group1"

style=

"push"

icon=

"icons/runXYZ2.gif"

tooltip=

"Run XYZ2 Tool"

helpContextId=

"com.xyz.run_action_context2"

class=

"com.xyz.actions.RunXYZ2"

>

<enablement>

<and>

<objectClass name=

"org.eclipse.core.resources.IFile"

/>

<not>

<objectState name=

"extension"

value=

"java"

/>

</not>

</and>

</enablement>

</action>

</editorContribution>

</extension>

Ve výše uvedeném příkladu se uvedená akce zobrazí jako položka nabídky v podnabídce nazvané "Nabídka XYZ2" v nabídce "Upravit" nejvyšší úrovně. Akce bude zpřístupněna, pokud výběr neobsahuje žádné prostředky souboru Java.

Hodnota atributu třídy musí být plně kvalifikovaný název třídy Java implementující org.eclipse.ui.IEditorActionDelegate. Tato třída bude načtena co možná nejpozději, aby se zabránilo načtení celého modulu plug-in, dokud není skutečně potřebný. Metoda setActiveEditor bude vyvolána pokaždé, když dojde k aktivaci editoru zadaného typu. Bude vytvořena pouze jedna sada akcí a nabídek pro všechny instance zadaného typu editoru, bez ohledu na počet instancí editoru aktuálně otevřených na pracovní ploše.

Tento bod rozšíření lze použít k přispívání akcí do nabídek, které byly již dříve vytvořeny cílovým editorem. Nabídky a akce mohou být navíc přispívány do okna pracovní plochy. Identifikátory pro akce a hlavní skupiny v rámci okna pracovní plochy jsou definovány v org.eclipse.ui.IWorkbenchActionConstants. Ty by měly být používány jako referenční místo pro přidávání nových akcí. Nabídky nejvyšší úrovně jsou vytvářeny použitím následujících hodnot atributu cesty (path):

Pokud není atribut cesty (path) zadán, bude nová nabídka přidána do skupiny pruhu nabídky přidání.

Akce a nabídky přidané do těchto cest budou zobrazeny pouze po dobu, kdy je odpovídající editor aktivní. Po zavření editoru budou nabídky a akce odebrány.

Kritérium zpřístupnění rozšíření akce je zpočátku definováno parametrem enablesFor, a rovněž buď parametrem selection, nebo enablement. Jakmile je ovšem konkretizován delegát akce, může tento delegát řídit stav zpřístupnění akce přímo v rámci své metody selectionChanged.

Štítky akcí a nabídek mohou obsahovat speciální znaky se zakódovanou mnemotechnikou, pomocí následujících pravidel:

  1. Mnemotechnické informace jsou specifikovány pomocí znaku ampersand ('&') před vybraným znakem v přeloženém textu. Jelikož znak ampersand není v řetězcích XML povolen, použijte znakovou entitu &amp;.
Pokud jedno rozšíření přispívá do nabídky nebo do panelu nástrojů dvěma nebo více akcemi, budou tyto akce zobrazeny v opačném pořadí, než v jakém jsou uvedeny v souboru plugin.xml. Toto chování je takto navrženo. Nicméně bylo objeveno až po zafixování rozhraní API platformy Eclipse. Změna tohoto chování by tuto chvíli narušila všechny moduly plug-in, které jsou závislé na současném chování.

Prvky selection a enablement se navzájem vylučují. Prvek enablement může nahradit prvek selection pomocí dílčích prvků objectClass a objectState. Například následující:

 

<selection class=

"org.eclipse.core.resources.IFile"

name=

"*.java"

>

</selection>

lze vyjádřit pomocí:
 

<enablement>

<and>

<objectClass name=

"org.eclipse.core.resources.IFile"

/>

<objectState name=

"extension"

value=

"java"

/>

</and>

</enablement>

Pracovní plocha poskytuje vestavěný editor "Default Text Editor". Moduly plug-in mohou přispívat do tohoto výchozího editoru nebo editorů poskytovaných ostatními moduly plug-in.