Extensão do Item da Folha de Dicas
Identificador:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
Desde:
3.0
Descrição:
Esse ponto de extensão deve ser utilizado quando um botão adicional precisar ser
incluído em uma etapa na folha de dicas. Você pode colocar um novo atributo na
tag "item" no arquivo de conteúdo da folha de dicas e quando o valor for lido pela
estrutura da folha de dicas, ela verificará se existe uma classe registrada
ao longo do ponto de extensão que manipule esse atributo. O nome do atributo localizado
no arquivo de conteúdo da folha de dicas
é combinada a todos os valores localizados no atributo "itemAttribute" de todas as
implementações registradas do ponto cheatsheetItemExtension. Se houver um acerto, a
classe especificada para manipular o atributo desse item será carregada pela
estrutura da folha de dicas e será chamada para manipular o atributo
especificado no arquivo de conteúdo da folha de dicas. Depois de ter analisado
o valor do atributo do item, a classe permanecerá disponível para a estrutura das folhas de
dicas. Quando o item for processado para a visualização das folhas de
dicas, a classe será mais uma vez chamada para manipular a adição de componentes
para um Composto. Os itens incluídos nesse composto são exibidos na etapa de
folha de dicas (atualmente, perto do ícone de ajuda). Isso é exibido apenas
para a etapa descrita pela tag "item" cujo atributo apareceu no arquivo de conteúdo da
folha de dicas. É sugerido que esse ponto de extensão seja utilizado por meio da inclusão
de um pequeno botão (16x16) com um gráfico que abre uma caixa de diálogo quando pressionado.
Marcação da Configuração:
<!ELEMENT extension (itemExtension)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - um identificador completo 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 essa extensão de item para incluir elementos nas etapas da folha de dicas. Você
pode utilizar esse ponto de extensão para incluir ícones e botões (atualmente, perto do
ícone de ajuda) para uma etapa na folha de dicas.
Especifique o nome de um atributo que você colocará na tag do item da folha de dicas.
Especifique também uma classe que manipulará a análise do valor do atributo do arquivo
de conteúdo da folha de dicas quando a folha de dicas for carregada.
O valor de atributo deve ser uma cadeia. A classe especificada deve ser uma subclasse
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
. Depois que o
arquivo de conteúdo da folha de dicas
for analisado e carregado, a classe especificada no ponto de extensão será chamada
novamente por meio da interface para incluir gráficos ou botões para a etapa
na folha de dicas (atualmente, junto ao botão de ajuda).
- itemAttribute - Esse valor de atributo deve ser o valor de cadeia de um nome
de atributo que é colocado em uma tag de item no arquivo de conteúdo da folha de
dicas. Se essa cadeia de atributo corresponder a um atributo analisado a partir da
tag de item no arquivo de conteúdo da folha de dicas, a classe especificada será
carregada e chamada para analisar o valor completo do atributo,
utilizando a especificação w3 DOM. Posteriormente, ela será chamada para incluir
controles em um Composto e os componentes incluídos (geralmente gráficos e botões)
aparecerão na etapa da folha de dicas para o item especificado
(atualmente, ao lado do ícone de ajuda para essa etapa).
- class - O nome de classe completo da classe que subclassifica
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
para manipular
atributos desconhecidos no arquivo de conteúdo da folha de dicas
e estender as etapas na folha de dicas. A classe deve ser pública e ter um
construtor público de 1 argumento que aceita o nome do atributo
(String
).
Exemplos:
A seguir está um exemplo de implementação desse ponto de extensão:
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
E a seguir está o atributo de item para essa extensão:
<item title=
"XYZ Title"
xyzButton=
"/icon/button.gif"
/>
Observe que o valor do atributo na tag item pode ser QUALQUER COISA. Pode ser qualquer
coisa porque a classe que analisa esse atributo é a classe HandleParsingAndAddButton,
que nesse exemplo analisa a cadeia /icon/button.gif a partir do atributo. Posteriormente,
ela utilizará essas informações para carregar o gif e utilizá-lo como ícone para um
novo botão.
Informações sobre a API:
Consulte as
informações Javadoc para org.eclipse.ui.cheatsheets.AbstractItemExtensionElement para
obter detalhes da API.
Implementação Fornecida:
Não há
implementação fornecida nesse momento.
Direitos Autorais (c) 2004 IBM Corporation e outros.
Todos os direitos reservados.
Este programa e os materiais que o acompanham são disponibilizados
sob os termos da Eclipse Public License v1.0 que acompanha esta
distribuição e estão disponíveis no endereço http://www.eclipse.org/legal/epl-v10.html