Mandatos

org.eclipse.ui.commands

2.1

El punto de extensión org.eclipse.ui.commands se utiliza para declarar mandatos y categorías de mandatos, mediante los elementos command y category. Mediante este punto de extensión, también pueden asignarse secuencias de teclas a los mandatos utilizando el elemento keyBinding. Las secuencias de teclas se enlazan con los mandatos en función de contextos y configuraciones de teclas que también se declaran en este punto, mediante los elementos keyConfiguration y context.

<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , context)>

<!ATTLIST extension

id    CDATA #IMPLIED

name  CDATA #IMPLIED

point CDATA #REQUIRED>


<!ELEMENT activeKeyConfiguration EMPTY>

<!ATTLIST activeKeyConfiguration

value              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED>

Este elemento se utiliza para definir la configuración de teclas activa inicial de Eclipse. Si existe más de uno de estos elementos, sólo se considera válido el último elemento declarado (por orden de lectura del registro de conectores).



<!ELEMENT category EMPTY>

<!ATTLIST category

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED>

En la UI, los mandatos están organizados frecuentemente por categorías para facilitar su gestión. Este elemento se utiliza para definir estas categorías. Los mandatos pueden añadirse a sí mismos a una categoría como máximo. Si existe más de uno de estos elementos con el mismo atributo id, sólo se considera válido el último elemento declarado (por orden de lectura del registro de conectores).



<!ELEMENT command EMPTY>

<!ATTLIST command

category    CDATA #IMPLIED

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

categoryId  CDATA #IMPLIED>

Este elemento se utiliza para definir mandatos. Un mandato representa una petición del usuario que puede manejarse mediante una acción, y debe ser semánticamente exclusivo con respecto a otros mandatos. No defina un mandato si ya existe uno definido con el mismo significado. Si existe más de uno de estos elementos con el mismo atributo id, sólo se considera válido el último elemento declarado (por orden de lectura del registro de conectores). Consulte los puntos de extensión org.eclipse.ui.actionSets y org.eclipse.ui.editorActions para saber cómo se conectan las acciones a los mandatos.



<!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>

Este elemento permite asignar secuencias de teclas a los mandatos.



<!ELEMENT keyConfiguration EMPTY>

<!ATTLIST keyConfiguration

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Este elemento se utiliza para definir configuraciones de teclas. Si existe más de uno de estos elementos con el mismo atributo id, sólo se considera válido el último elemento declarado (por orden de lectura del registro de conectores).



<!ELEMENT context EMPTY>

<!ATTLIST context

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

Este elemento se utiliza para definir contextos. Si existe más de uno de estos elementos con el mismo atributo id, sólo se considera válido el último elemento declarado (por orden de lectura del registro de conectores).



<!ELEMENT handlerSubmission EMPTY>

<!ATTLIST handlerSubmission

commandId CDATA #REQUIRED

handler   CDATA #REQUIRED>

Este elemento declara un manejador para un mandato. A continuación, este manejador se asocia con el mandato con las restricciones especificadas. Esta asociación se realiza durante el inicio. El hecho de asociar un manejador no significa que éste siempre sea el elegido por el entorno de trabajo; la selección real se efectúa examinando el estado del entorno de trabajo y comparándolo con los diversos sometimientos de manejador.

Esta API en concreto aún debe considerarse experimental. Aunque puede utilizarla, debe tener en cuenta que esta API puede cambiar radicalmente o eliminarse por completo en el futuro. Apreciaremos el envío de comentarios relativos a esta API a platform-ui-dev@eclipse.org.



<!ELEMENT scope EMPTY>

<!ATTLIST scope

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED>

Este elemento se utiliza para definir ámbitos. Si existe más de uno de estos elementos con el mismo atributo id, sólo se considera válido el último elemento declarado (por orden de lectura del registro de conectores). @obsoleto; en su lugar, utilice el punto de extensión "org.eclipse.ui.contexts".



El archivo plugin.xml del conector org.eclipse.ui utiliza ampliamente el punto de extensión org.eclipse.ui.commands.

No existe una API de uso público para declarar mandatos, categorías, enlaces de teclas, configuraciones de teclas o contextos aparte de este punto de extensión. La API de uso público destinada a consultar y establecer contextos, así como para registrar acciones para manejar mandatos específicos, puede encontrarse en org.eclipse.ui.IKeyBindingService.