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
contextos declarados neste documento, bem como através da utilização dos elementos
keyConfiguration
e context
.
Marcação da Configuração:
<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , context)>
<!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>
<!ATTLIST activeKeyConfiguration
value CDATA #IMPLIED
keyConfigurationId CDATA #IMPLIED>
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.
- value - o id exclusivo (atributo
id
) do elemento keyConfiguration que será ativado inicialmente.
- keyConfigurationId - o id exclusivo (atributo
id
) do elemento
keyConfiguration que será ativado inicialmente.
<!ELEMENT category EMPTY>
<!ATTLIST category
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED>
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.
- description - uma breve descrição traduzível dessa categoria para exibição na UI.
- id - o identificador exclusivo desta categoria.
- name - o nome traduzível dessa categoria para exibição na UI.
<!ELEMENT command EMPTY>
<!ATTLIST command
category CDATA #IMPLIED
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
categoryId CDATA #IMPLIED>
Esse elemento é utilizado para definir os 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.
- 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.@deprecated
Utilize "categoryId" em substituição.
- description - uma breve descrição traduzível deste comando para exibição na UI.
- 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.
- categoryId - 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.
<!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>
Esse elemento permite designar seqüências de teclas para comandos.
- configuration - o ID exclusivo da configuração de teclas desta ligação de teclas.@deprecated
Utilize keyConfigurationId em substituição.
- 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 contextos específicos que possam ter sido emprestados de seus pais. @deprecate Utilize "commandId"
em substituição.
- 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()
.
- contextId - o ID exclusivo do contexto dessa 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 '+'.@deprecate
Utilize "keySequence" em substituição.
- scope - o ID exclusivo do contexto dessa ligação de teclas.
@deprecated Utilize "contextId" em substituição.
- keyConfigurationId - o ID exclusivo da configuração de teclas desta ligação de
teclas.
- commandId - 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
contextos específicos que possam ter sido emprestados de seus pais.
- keySequence - a seqüência de teclas a ser designada ao 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>
<!ATTLIST keyConfiguration
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED
parentId CDATA #IMPLIED>
Esse 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.
- 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.
- parentId - 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 context EMPTY>
<!ATTLIST context
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED
parentId CDATA #IMPLIED>
Esse elemento é utilizado para definir os contextos. 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.
- description - uma breve descrição traduzível deste contexto para exibição na
UI.
- id - o identificador exclusivo deste contexto.
- name - o nome traduzível deste contexto para exibição na UI. Se esse
contexto 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 contexto pai. Se esse contexto 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 contexto. @deprecated Utilize "parentId" em substituição.
- parentId - o ID exclusivo do contexto pai. Se esse contexto 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 contexto.
<!ELEMENT handlerSubmission EMPTY>
<!ATTLIST handlerSubmission
commandId CDATA #REQUIRED
handler CDATA #REQUIRED>
Esse elemento declara uma rotina de tratamento para um comando. Essa rotina de
tratamento é então associada ao comando com as restrições determinadas. Essa associação
é feita na inicialização. Associar uma rotina de tratamento não significa que
essa rotina de tratamento sempre será a escolhida pelo workbench; a real opção é
feita examinando o estado do workbench e comparando com diversas submissões da rotina de
tratamento.
Essa API específica ainda deve ser considerada experimental. Embora seja possível
utilizá-la, você deve saber aceitar que essa API pode ser radicalmente alterada ou pode
ser inteiramente removida em algum ponto no futuro. Agradecemos o feedback sobre essa
API para platform-ui-dev@eclipse.org.
- commandId - o identificador de comando ao qual essa rotina de tratamento deve
estar associada.
- handler - o nome da classe da rotina de tratamento. Se a classe for uma
implementação de IExecutableExtension, será possível transmitir os dados no objeto. Essa
rotina de tratamento estará em proxy até que sejam consultadas informações na rotina de
tratamento -- nesse ponto a classe estará carregada e será criada uma instância.
<!ELEMENT scope EMPTY>
<!ATTLIST scope
description CDATA #IMPLIED
id CDATA #REQUIRED
name CDATA #REQUIRED
parent CDATA #IMPLIED>
Esse elemento é utilizado para definir os 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.
@deprecated Utilize o ponto de extensão "org.eclipse.ui.contexts" em substituição.
- description - uma breve descrição traduzível deste escopo para exibição na UI.
@deprecated Utilize o ponto de extensão "org.eclipse.ui.contexts" em substituição.
- id - o identificador exclusivo deste escopo.
@deprecated Utilize o ponto de extensão "org.eclipse.ui.contexts" em substituição.
- 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.
@deprecated Utilize o ponto de extensão "org.eclipse.ui.contexts" em substituição.
- 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.
@deprecated Utilize o ponto de extensão "org.eclipse.ui.contexts" em substituição.
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 sobre a API:
Essa não é nenhuma API pública para a declaração de comandos, categorias, ligações de
teclas, configurações de teclas ou contextos diferentes deste ponto de extensão. A API
pública para consultas e para a definição de contextos, bem como para o registro de ações
para manipular comandos específicos, pode ser encontrada em
org.eclipse.ui.IKeyBindingService
.
Copyright (c) 2000, 2004 IBM Corporation e outros.
Todos os direitos reservados.
Este programa e os materiais que o acompanham tornam-se disponíveis 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