Comandos
Identificador: org.eclipse.ui.commands
Desde:
2.1
Descrição:
O ponto de extensão org.eclipse.ui.commands
é utilizado para declarar comandos e categorias de comandos usando os elementos command
e category
. Através desse ponto de extensão, também é possível atribuir seqüências de teclas para comandos utilizando o elemento keyBinding
. As seqüências de teclas são ligadas aos comandos com base nas configurações de teclas e nos escopos declarados neste documento, bem como através da utilização dos elementos keyConfiguration
e scope
.
Marcação da Configuração:
<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , scope)>
<!ATTLIST extension
id CDATA #IMPLIED
name CDATA #IMPLIED
point CDATA #REQUIRED
>
- id - um identificador opcional da instância de extensão.
- name - um nome opcional da instância de extensão.
- point - um identificador completo do ponto de extensão de destino.
<!ELEMENT activeKeyConfiguration EMPTY>
Este elemento é utilizado para definir a configuração de teclas inicialmente ativa para Eclipse. Se houver mais de um desses elementos, apenas o último elemento declarado (na ordem de leitura do registro de plug-in) será considerado válido.
<!ATTLIST activeKeyConfiguration
value CDATA #IMPLIED
>
- value - o id exclusivo (atributo
id
) do elemento keyConfiguration que será ativado inicialmente.
<!ELEMENT category EMPTY>
Na UI, os comandos são normalmente organizados por categoria para facilitar o gerenciamento. Este elemento é utilizado para definir essas categorias. Os comandos podem se auto-incluir em, no máximo, uma categoria. Se houver mais de um desses elementos com o mesmo atributo id
, apenas o último elemento declarado (na ordem de leitura do registro de plug-in) será considerado válido.
<!ATTLIST category
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
>
- description - uma breve descrição traduzível desta categoria para exibição na UI.
- id - o identificador exclusivo desta categoria.
- name - o nome traduzível desta categoria para exibição na UI.
<!ELEMENT command EMPTY>
Este elemento é utilizado para definir comandos. Um comando representa um pedido do usuário que pode ser identificado por uma ação e que deve ser semanticamente exclusivo dentre outros comandos. Não defina um comando se já houver outro definido com o mesmo significado. Se houver mais de um desses elementos com o mesmo atributo id
, apenas o último elemento declarado (na ordem de leitura do registro de plug-in) será considerado válido. Consulte os pontos de extensão org.eclipse.ui.actionSets e org.eclipse.ui.editorActions para compreender como as ações estão conectadas aos comandos.
<!ATTLIST command
category CDATA #IMPLIED
description CDATA #IMPLIED
icon CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
>
- category - o id exclusivo da categoria para este comando. Se esse comando não especificar uma categoria, ele ainda aparecerá em todas as UIs, ao lado de outros comandos categorizados de forma especial.
- description - uma breve descrição traduzível deste comando para exibição na UI.
- icon -
- id - o identificador exclusivo deste comando.
- name - o nome traduzível deste comando para exibição na UI. Os comandos são normalmente nomeados com um verbo no imperativo.
<!ELEMENT keyBinding EMPTY>
Este elemento permite a atribuição de seqüências de teclas para comandos.
<!ATTLIST keyBinding
configuration CDATA #REQUIRED
command CDATA #IMPLIED
locale CDATA #IMPLIED
platform CDATA #IMPLIED
scope CDATA #REQUIRED
string CDATA #REQUIRED
>
- configuration - o id exclusivo da configuração de teclas desta ligação de teclas.
- command - o identificador exclusivo do comando para o qual a seqüência de teclas especificada por essa ligação de teclas é atribuída. Se o valor desse atributo for uma cadeia vazia, a seqüência de teclas será atribuída para um comando interno 'no operation'. Isso é útil para a 'não-definição' de ligações de teclas em configurações de teclas e escopos específicos que podem ter sido emprestados de seus pais.
- locale - um atributo opcional que indica que a ligação de teclas está definida apenas para o locale especificado. Os locales são especificados de acordo com o formato declarado em
java.util.Locale
.
- platform - um atributo opcional que indica que a ligação de teclas está definida apenas para a plataforma especificada. Os valores possíveis do atributo
platform
são o conjunto de valores possíveis retornados por org.eclipse.swt.SWT.getPlatform()
.
- scope - o id exclusivo do escopo desta ligação de teclas.
- string - a seqüência de teclas para a atribuição do comando. As seqüências de teclas consistem em um ou mais pressionamentos de tecla, em que um pressionamento de tecla consiste em uma tecla do teclado, opcionalmente pressionada em conjunto com um ou mais dos seguintes modificadores: Ctrl, Alt, Shift e Command. Os pressionamentos de tecla são separados por espaços e os modificadores são separados pelos caracteres '+'.
<!ELEMENT keyConfiguration EMPTY>
Este elemento é utilizado para definir configurações de teclas. Se houver mais de um desses elementos com o mesmo atributo id
, apenas o último elemento declarado (na ordem de leitura do registro de plug-in) será considerado válido.
<!ATTLIST keyConfiguration
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED
>
- description - uma breve descrição traduzível desta configuração de teclas para exibição na UI.
- id - o identificador exclusivo desta configuração de teclas.
- name - o nome traduzível desta configuração de teclas para exibição na UI. Se essa configuração de teclas tiver um pai, não será necessário incluir "(extensões ...)" no nome. Quando necessário, será automaticamente incluído pela UI.
- parent - o id exclusivo da configuração de teclas pai. Se essa configuração de teclas tiver um pai, todas as ligações de teclas serão emprestadas desse pai, além das ligações de teclas definidas em sua própria configuração de teclas.
<!ELEMENT scope EMPTY>
Este elemento é utilizado para definir escopos. Se houver mais de um desses elementos com o mesmo atributo id
, apenas o último elemento declarado (na ordem de leitura do registro de plug-in) será considerado válido.
<!ATTLIST scope
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED
>
- description - uma breve descrição traduzível deste escopo para exibição na UI.
- id - o identificador exclusivo deste escopo.
- name - o nome traduzível deste escopo para exibição na UI. Se esse escopo tiver um pai, não será necessário incluir "(extends parent)" no nome. Quando necessário, será automaticamente incluído pela UI.
- parent - o id exclusivo do escopo pai. Se esse escopo tiver um pai, todas as ligações de teclas serão emprestadas desse pai, além das ligações de teclas definidas em seu próprio escopo.
Exemplos:
O arquivo plugin.xml
no plug-in org.eclipse.ui
torna extensivo o uso do ponto de extensão org.eclipse.ui.commands
.
Informações de API:
Esta não é nenhuma API pública para a declaração de comandos, categorias, ligações de teclas, configurações de teclas ou escopos diferentes deste ponto de extensão. A API pública para consultas e para a definição de escopos, bem como para o registro de ações para a identificação de comandos específicos pode ser encontrada em org.eclipse.ui.IKeyBindingService
.
Copyright (c) 2000, 2003 IBM Corporation e outros.
Todos os direitos reservados.
Este programa e os materiais que o acompanham são disponibilizados sob os termos da Common Public License v1.0 que acompanha esta distribuição e estão disponíveis no endereço http://www.eclipse.org/legal/cpl-v10.html