Produtor de Conteúdo de Ajuda
Identificador:
org.eclipse.help.contentProducer
A partir de:
3.0
Descrição:
Destina-se a facultar conteúdo de ajuda dinâmico, gerado no tempo de execução.
Os produtores de conteúdo estão registados por plug-in e funcionam apenas no âmbito do plug-in.
Para reutilizar um produtor de conteúdo noutro plug-in, o elemento
binding
deverá ser utilizado. Esta estratégia impede os plug-ins
do conteúdo highjacking que produz para todos os plug-ins.
Ao associar-se a um produtor de conteúdo, um plug-in dá permissão ao conteúdo
do controlo que produz para todos os documentos no plug-in concedido.
Marcação da Configuração:
<!ELEMENT extension
(contentProducer |
binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - a classe de implementação do produtor de conteúdo de ajuda. Esta classe tem de implementar a interface org.eclipse.help.IHelpContentProducer.Este atributo pode ser omitido e pode facultar-se, em seu lugar, o elemento producer imbricado.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - a classe de implementação do produtor de conteúdo de ajuda. Esta classe tem de implementar a interface org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - o nome de um parâmetro transmitido à classe de implementação
- value - o valor de um parâmetro transmitido à classe de implementação
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - um nome único de um produtor de conteúdo definido
noutro lugar através da utilização do elemento contentProducer. A
associação permite que um plug-in reutilize um produtor de conteúdo
registado noutro plug-in, em vez de definir um.
Exemplos:
De seguida é apresentado
um exemplo do ponto de extensão do produtor de conteúdo:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"O Meu Conteúdo de Ajuda Dinâmico"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
Informações de API:
A classe do produtor de conteúdo facultada tem de implementar a interface org.eclipse.help.IHelpContentProducer.
O produtor é responsável por facultar conteúdo aos recursos de ajuda dinâmicos de um plug-in. O método do produtor de conteúdos é chamado pela ajuda para cada recurso de ajuda obtido do plug-in.
Implementação Facultada:
Nenhuma. Caso um plug-in de documentação não faculte um produtor de conteúdo de ajuda ou caso uma chamada dos seus resultados seja nula, o sistema de ajuda pesquisa no ficheiro doc.zip e no sistema de ficheiros do local de instalação do plug-in um documento estático e apresenta o seu conteúdo.
Copyright (c) 2000, 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