Produtor de Conteúdo da Ajuda
Identificador:
org.eclipse.help.contentProducer
Desde:
3.0
Descrição:
Para fornecer conteúdo de ajuda dinâmico, gerado no tempo de execução. Produtores de
conteúdo são registrador por plug-in e só funcionam no escopo de plug-in. Para reutilizar
um produtor de conteúdo em outro plug-in, o elemento ligação
deve ser
utilizado. Essa estratégia evita que os plug-ins interceptem a produção de conteúdo para
todos os plug-ins. Ligando um produtor de conteúdo, um plug-in oferece a ele permissão
para controlar a produção de conteúdo para todos os documentos no plug-in de concessão.
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 para o produtor de conteúdo de ajuda. Essa classe deve implementar a interface org.eclipse.help.IHelpContentProducer. Esse atributo pode ser omitido e o elemento producer aninhado pode ser fornecido em seu lugar.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - a classe de implementação para o produtor de conteúdo de ajuda. Essa classe deve implementar a interface org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - nome de um parâmetro transmitido à classe de implementação
- value - valor de um parâmetro transmitido para a classe de implementação
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - um nome exclusivo de um produtor de conteúdo definido em outro
local utilizando o elemento contentProducer. A ligação permite a um plug-in
reutilizar um produtor de conteúdo registrado em outro plug-in em vez de definir o
seu próprio.
Exemplos:
Segue uma amostra do uso do ponto
de extensão de produtor de conteúdo:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"My Dynamic Help Content"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
Informações da API:
A classe do produtor de conteúdo fornecido deve implementar a interface org.eclipse.help.IHelpContentProducer.
O produtor é responsável por fornecer o conteúdo para recursos de ajuda dinâmicos a partir de um plug-in. O método do produtor de conteúdo é chamado pela ajuda para cada recurso de ajuda obtido a partir do plug-in.
Implementações Fornecidas:
Nenhum(a).
Se um plug-in de documentação não fornece a produtor de conteúdo de ajuda ou uma chamada a ele resulta em nulo, o sistema de ajuda procura doc.zip e o sistema de arquivo no local de instalação do plug-in para um documento estático e exibe seu conteúdo.
Direitos Autorais (c) 2000, 2006 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais fornecidos com ele são
disponibilizados sob os termos da Licença Pública do Eclipse v1.0 que acompanha
esta distribuição e está disponível em
http://www.eclipse.org/legal/epl-v10.html