Parancsok

org.eclipse.ui.commands

2.1

Az org.eclipse.ui.commands kiterjesztési pont a command és category elem segítségével parancsokat és parancskategóriákat ad meg. A parancs valamilyen szemantikai viselkedés ábrázolása, de nem a tényleges megvalósítása. Ez lehetővé teszi a különböző fejlesztők számára az egyéni részeik számára bizonyos viselkedés hozzáadását. Például lehet egy megvalósítással rendelkező "beillesztés" parancs egy szerkesztőben és egy másik megvalósítás egy felfedező felületi elemben. Ezen megvalósítások a kezelők. A parancsok tekinthetők deklarációs függvénymutatókként vagy jelzéskezelőkként is.

<!ELEMENT extension (category* , command* , commandParameterType* , keyBinding* , keyConfiguration* , context* , scope* , activeKeyConfiguration?)>

<!ATTLIST extension

id    CDATA #IMPLIED

name  CDATA #IMPLIED

point CDATA #REQUIRED>


<!ELEMENT command (defaultHandler? , state* , commandParameter*)>

<!ATTLIST command

category       CDATA #IMPLIED

description    CDATA #IMPLIED

id             CDATA #REQUIRED

name           CDATA #REQUIRED

categoryId     CDATA #IMPLIED

defaultHandler CDATA #IMPLIED

returnTypeId   CDATA #IMPLIED

helpContextId  CDATA #IMPLIED>

Ez az elem parancsokat ad meg. A parancs egy felhasználói kérést ábrázol, amelyet egy tevékenység kezelhet, és szemantikailag egyedinek kell lennie a többi parancs között. Ne adjon meg parancsot, ha ugyanezzel a jelentéssel már van egy megadva. Ha több ilyen elem létezik ugyanabban az id attribútumban, akkor csak az utolsó megadott elem (a bedolgozó-nyilvántartás olvasása érdekében) érvényes. Annak megértéséhez, hogy a tevékenységek hogyan vannak parancsokhoz csatlakoztatva, tekintse meg az org.eclipse.ui.actionSets és org.eclipse.ui.editorActions kiterjesztési pontot.



<!ELEMENT category EMPTY>

<!ATTLIST category

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED>

A felhasználói felületen a parancsok az egyszerűbb kezelhetőség érdekében gyakran kategóriákba vannak szervezve. Ez az elem megadja ezeket a kategóriákat. A parancsok legfeljebb egy kategóriához adhatók hozzá. Ha több ilyen elem létezik ugyanabban az id attribútumban, akkor csak az utolsó megadott elem (a bedolgozó-nyilvántartás olvasása érdekében) érvényes.



<!ELEMENT commandParameter (values?)>

<!ATTLIST commandParameter

id       CDATA #REQUIRED

name     CDATA #REQUIRED

values   CDATA #IMPLIED

typeId   CDATA #IMPLIED

optional (true | false) "true">

Egy olyan paramétert határoz meg, amelyet egy parancsnak meg kell értenie. A paraméter az információk kezelő számára a végrehajtás időpontjában biztosításának egyik módja. Például egy "nézet megjelenítése" parancs elfogadhat egy nézetet paraméterként. A kezelőknek meg kell érteniük ezen paramétereket ahhoz, hogy API-kként legyenek kezelve.

Minimális verziószám: 3.1



<!ELEMENT commandParameterType EMPTY>

<!ATTLIST commandParameterType

id        CDATA #REQUIRED

type      CDATA #IMPLIED

converter CDATA #IMPLIED>

Meghatározza egy commandParameter elem objektumtípusát és megadhat egy org.eclipse.core.commands.AbstractParameterValueConverter alosztályt karaktersorozat-paraméter értékek és objektumok közti átalakításhoz.

Minimális verziószám: 3.2



<!ELEMENT values (parameter*)>

<!ATTLIST values

class CDATA #REQUIRED>

A values attribútum részletesebb változata a commandParameter esetén.

Minimális verziószám: 3.1



<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>

A paraméter egy lehetséges értéke.

Minimális verziószám: 3.1



<!ELEMENT defaultHandler (parameter)>

<!ATTLIST defaultHandler

class CDATA #REQUIRED>

A parancs alapértelmezett kezelője. Ha nincs más aktív kezelő, akkor ez a kezelő lesz aktív. Ez a kezelő ütközni fog az olyan kezelőmeghatározásokkal, amelyek nem adnak meg activeWhen feltételeket. Ha nem egy IExecutableExtension felületet hoz létre, akkor a defaultHandler attribútumot használja inkább.

Minimális verziószám: 3.1



<!ELEMENT state (class?)>

<!ATTLIST state

class CDATA #IMPLIED

id    CDATA #REQUIRED>

Az állapotinformációk megosztottak az összes kezelő között és lehetséges a megőrzésük a munkamenetek között. Ez általában hasonló egy jelölőnégyzet állapotához vagy egy kezelő címkéjéhez. Az állapot egyszerűen egy osztály, amely az állapotról gondoskodás érdekében kerül betöltésre. További információkat az API információkban talál.

Minimális verziószám: 3.2



<!ELEMENT class (parameter*)>

<!ATTLIST class

class CDATA #REQUIRED>

A parancs állapotának tárolása érdekében betölthető osztály. Ez az elem akkor kerül felhasználásra, ha több paramétert kíván átadni egy org.eclipse.core.runtime.IExecutableExtension elemnek.

Minimális verziószám: 3.2



A keyConfiguration elem elavult

<!ELEMENT keyConfiguration EMPTY>

<!ATTLIST keyConfiguration

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Ez az elem billentyűkonfigurációkat ad meg. Ha több ilyen elem létezik ugyanabban az id attribútumban, akkor csak az utolsó megadott elem (a bedolgozó-nyilvántartás olvasása érdekében) érvényes. Használja inkább az "org.eclipse.ui.bindings" kiterjesztési pontot.



A context elem elavult.

<!ELEMENT context EMPTY>

<!ATTLIST context

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Az elem kontextusokat ad meg. Ha több ilyen elem létezik ugyanabban az id attribútumban, akkor csak az utolsó megadott elem (a bedolgozó-nyilvántartás olvasása érdekében) érvényes. Inkább az org.eclipse.ui.contexts kiterjesztési pontot használja.



A scope elem elavult.

<!ELEMENT scope EMPTY>

<!ATTLIST scope

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED>

Ez az elem hatóköröket ad meg. Ha több ilyen elem létezik ugyanabban az id attribútumban, akkor csak az utolsó megadott elem (a bedolgozó-nyilvántartás olvasása érdekében) érvényes. @elavult Használja inkább az "org.eclipse.ui.contexts" kiterjesztési pontot.



Az activeKeyConfiguration elem elavult.

<!ELEMENT activeKeyConfiguration EMPTY>

<!ATTLIST activeKeyConfiguration

value              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED>

Ez az elem megadja a kezdeti aktív billentyűkonfigurációt az Eclipse-hez. Ha több ilyen elem létezik, akkor csak az utolsó megadott elem (a bedolgozónyilvántartás olvasása érdekében) érvényes.

Ez az elem kicserélésre került egy beállítással. Ha az alkalmazásnak módosítania kell az alapértelmezett billentyűbeállítást, akkor adja meg a következőt a plugin_customization.ini fájlban: org.eclipse.ui/KEY_CONFIGURATION_ID=your.default.key.configuration.id.



A keyBinding elem elavult.

<!ELEMENT keyBinding EMPTY>

<!ATTLIST keyBinding

configuration      CDATA #IMPLIED

command            CDATA #IMPLIED

locale             CDATA #IMPLIED

platform           CDATA #IMPLIED

contextId          CDATA #IMPLIED

string             CDATA #IMPLIED

scope              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED

commandId          CDATA #IMPLIED

keySequence        CDATA #IMPLIED>

Az elem lehetővé teszi billentyűkombinációk parancsokhoz rendelését. Inkább a key elemet használja az "org.eclipse.ui.bindings" kiterjesztési pontban.



Az org.eclipse.ui bedolgozóban lévő plugin.xml fájl átfogóan használja az org.eclipse.ui.commands kiterjesztési pontot.

A kezelők a parancsokkal az org.eclipse.ui.handlers.IHandlerService használatával regisztrálhatók. Ez különböző munkaterület-összetevőkből (például munkaterület, munkaterület-ablak, részhely, stb.) a getService(IHandlerService.class) hívásával kérhető le.

Általánosságban az összes parancs statikus meghatározása részesítendő előnyben (a plugin.xml fájlban). Így a felhasználók billentyűkombinációkat rendelhetnek a parancsokhoz. Mindazonáltal lehetséges parancsok futás közbeni meghatározása. Ehhez kérje le egy munkaterület-összetevőből az org.eclipse.ui.commands.ICommandService elemet, hívja meg a getCommand(yourCommandID), majd a következő metódust: Command.define(...).

A kezelőállapotoknak létezik néhány alapértelmezett megvalósítása, amelyek hasznosak lehetnek ezen kiterjesztési pont felhasználói számára: