Extensão de Artigo de Folha de Apontamentos
Identificador:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
A partir de:
3.0
Descrição:
Este ponto de extensão deve ser utilizado quando for preciso adicionar um botão a um passo da folha de apontamentos.
É possível colocar um novo atributo no identificador "item", no ficheiro de conteúdo de folha de apontamentos, para que, quando esse valor seja lido pela estrutura de folha de apontamentos, este verifique se existe uma classe registada através deste ponto de extensão, que irá processar este atributo. O nome de atributo existente no ficheiro de conteúdo de folha de apontamentos é comparado com todos os valores existentes no atributo "itemAttribute", de todas as implementações do ponto registado cheatsheetItemExtension. Caso haja correspondência, a classe especificada para processar este atributo de artigo é carregada pela estrutura de folha de apontamentos e é chamada para processar o atributo especificado no ficheiro de conteúdo de folha de apontamentos.
Após interpretar o valor do atributo de artigo, a classe continua disponível para a estrutura de folhas de anotações. Quando o artigo é representado na vista de folhas de anotações, a classe é novamente chamada para processar componentes adicionados a Composto. Os artigos adicionados a este composto são apresentados no passo de folha de apontamentos (actualmente, ao lado do ícone de ajuda). Só são apresentados para o passo descrito pelo identificador "item", que o atributo apresenta no ficheiro de conteúdo de folha de apontamentos.
A utilização sugerida deste ponto de extensão consiste em adicionar um botão pequeno (16x16) com um gráfico que abre uma caixa de diálogo quando premido.
Marcação da Configuração:
<!ELEMENT extension (itemExtension)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - um identificador totalmente qualificado do ponto de extensão de destino
- id - um identificador opcional da instância de extensão
- name - um nome opcional da instância de extensão
<!ELEMENT itemExtension EMPTY>
<!ATTLIST itemExtension
itemAttribute CDATA #REQUIRED
class CDATA #REQUIRED>
Utilize esta extensão de artigos para adicionar elementos a passos de folha de apontamentos. Pode utilizar este ponto de extensão para adicionar ícones e botões (actualmente ao lado do ícone de ajuda) a um passo da folha de apontamentos.
Especifica o nome de um atributo que irá colocar no identificador item da folha de apontamentos. Também especifica uma classe que irá processar a interpretação de um valor de atributo do ficheiro de conteúdo de folha de apontamentos quando a folha de apontamentos é carregada. O valor do atributo tem de ser uma cadeia. A classe especifica tem de criar uma subclasse de org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
. Após interpretar e carregar o ficheiro de conteúdo de folha de apontamentos, a classe especificada no ponto de extensão é novamente chamada, através da interface, para adicionar gráficos ou botões ao passo da folha de apontamentos (actualmente junto ao botão de ajuda).
- itemAttribute - Este valor de atributo tem de ser um valor de cadeia
de um nome de atributo que é colocado num identificador item do ficheiro de
conteúdo de folha de apontamentos. Caso esta cadeia de atributo corresponda a um atributo interpretado do identificador item no ficheiro de conteúdo de folha de apontamentos, a classe especificada será carregada e será chamada a interpretar o valor completo do atributo, utilizando a especificação w3 DOM. Posteriormente será chamada para adicionar controlos a um Composto e os componentes adicionais (normalmente gráficos ou botões) aparecerão no passo da folha de apontamentos do artigo especificado (actualmente ao lado do ícone de ajuda desse passo).
- class - O nome de classe totalmente qualificado que cria uma subclasse de
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
para processar atributos desconhecidos do ficheiro de conteúdo de folha de apontamentos e para expandir os passos na folha de apontamentos. A classe tem de ser pública e tem de ter um construtor de 1 argumento que aceite o nome de atributo (String
).
Exemplos:
A seguir encontra-se um exemplo da implementação deste ponto de extensão.
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
E o atributo de artigo desta extensão é:
<item title=
"Título XYZ"
xyzButton=
"/icon/button.gif"
/>
Tenha em atenção que o valor do atributo do identificador item pode ser QUALQUER COISA. Pode ser qualquer coisa porque a classe que interpreta esse atributo é a HandleParsingAndAddButton, que, neste exemplo, interpreta uma cadeia /icon/button.gif do atributo. Posteriormente utilizará essas informações para carregar o gif e utilizá-lo como ícone do novo botão.
Informações de API:
Consulte as informações do ficheiro Javadoc de org.eclipse.ui.cheatsheets.AbstractItemExtensionElement para obter detalhes relativos à API.
Implementação Facultada:
Não existe qualquer implementação facultada nesta altura.
Copyright (c) 2004, 2006 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais que o acompanham estão disponíveis sob os termos da Eclipse Public License v1.0, que acompanha esta distribuição e estão disponíveis em http://www.eclipse.org/legal/epl-v10.html