Exemplo - Ferramenta Leia me
Introdução
O editor Leia me mostra como definir seus próprios pontos de extensão para usar
outros plug-ins. Também mostra como criar extensões para entradas de menu pop-up
de recurso, novos assistentes de recursos, editores de arquivos para uma extensão (.readme),
uma exibição personalizada e páginas de propriedade.
Executando o exemplo
Para começar a usar esse exemplo, crie um arquivos com extensão .readme usando um assistente de
criação de arquivo ou crie um usando o assistente de criação de exemplo.
A exibição adicional forneceu por esse exemplo pode ser vista selecionando-se
Perspectivas > Mostrar Exibição > Outros e expandindo a seção Leia me. A ação da
exibição pode ser vista clicando-se no ícone leia me Exibição do Navegador.
Criando um novo arquivo leia me
Criar um novo arquivo com extensão .readme. No menu Arquivo, selecione,
Novo e depois selecione Outro... a partir do submenu. Clique em Simples
no assistente e selecione Arquivo na lista à esquerda. Clique em Avançar
para fornecer o nome do arquivo (certifique-se de que a extensão seja .readme)
e a pasta que deverá conter o arquivo.
Exemplo de assistentes de criação
No menu Arquivo, selecione Novo e a partir do submenu selecione Outro...
Agora selecione Exemplo de Assistentes de Criação. Selecione o Arquivo Readme. Clique em Avançar. Selecione
a pasta em que o arquivo será criado. Digite o nome do arquivo
com extensão .readme. Clique em Concluir.
Ação de extensão de exibição leia me
Na exibição do Navegador, selecione um arquivo com extensão .readme. Se não houver,
crie um com essa extensão. Na barra de ferramentas local da Exibição do
Navegador, você verá um botão cuja ajuda instantânea diz Executar Extensão de Exibição do Leia me.
Clique nesse botão. Um diálogo surgirá dizendo Exibir a Ação Executada.
Menus Popup
Na exibição do Navegador, selecione um arquivo com extensão .readme. Se não houver,
crie um arquivo com essa extensão. Selecione o arquivo para tornar
visível o menu pop-up. Observe que há um item de menu que diz Mostrar Ação Leia me
no menu pop-up. Escolha esse item de menu para abrir um diálogo que diz
Ação do Menu Popup Executada.
Página de Preferência
No menu Janela, selecione Preferências. Clique na página chamada
Exemplo Leia me. Isso mostra um exemplo da página de preferência.
Página de Propriedade
Na Exibição Navegador, selecione um arquivo com extensão .readme. Se não houver,
crie um arquivo com essa extensão. Selecione o arquivo para tornar visível
o menu pop-up e selecione o item de menu Propriedades. Clique na página
chamada Ferramenta de Leia me para ver um exemplo de uma página de propriedade.
Editor de Arquivo Leia me
O Editor de Arquivo Leia me é o editor padrão para os arquivos do tipo *.readme.
Crie um arquivo com extensão .readme e abra-o com um clique duplo ou tornando o menu pop-up visível, selecionando Abrir Com e do submenu
selecione Editor de Arquivo Leia me. Observe que o editor
tem um ícone com uma caneta. Esse é o editor que a ferramenta de leia me
usa como padrão para arquivos do tipo *.readme.
Ações do Editor Leia me
Isso mostra um exemplo de ações que são aplicáveis somente a um editor
particular. Quando o editor de arquivo leia me tem um foco, observe 4 botões da barra de
ferramentas adicionais - Executar Extensão do Editor Leia me, Ação 1 do Editor Leia me,
Ação 2 do Editor Leia me, Ação 2 do Editor Leia me.
Um menu de opções chamado Leia me aparece quando o editor de arquivo leia me tem um
foco. Ele contém as ações previamente descritas: Ação 1 do Editor Leia me,
Ação 2 do Editor Leia me, Ação 3 do Editor Leia me.
Exibição das Seções Leia me
Para ver a exibição das Seções Leia me, do menu Perspectiva selecione Mostrar Exibição,
do submenu selecione Outro.... Expanda o item Leia me e selecione Seções
Leia me. Isso irá mostrar uma lista das seções no arquivo *.readme quando um arquivo .readme estiver selecionado na
Exibição Navegador. É possível ver também a estrutura do arquivo *.readme na exibição Contorno.
Um arquivo com extensão .readme pode ser quebrado em seções quando cada uma delas
começar com um número. Por exemplo, se o seguinte texto foi digitado
em um editor de arquivos leia me, a ferramenta leia me detectará duas
seções. Para ver como as seções são detectadas na ferramenta leia me,
digite algum texto no editor de arquivo leia me, salve o arquivo pressionando
CTRL-S ou selecionando Arquivo->Salvar. Abra a exibição Seções Leia me e
selecione o arquivo .readme na exibição do Navegador.
Texto de Exemplo:
99.1 Essa é minha primeira seção.
Existe algums texto na minha primeira seção.
99.1.1 Essa é uma subseção
Há algum texto na minha subseção.
Arrastar e Soltar
A funcionalidade arrastar e soltar pode ser vista selecionando a seção na
Exibição Contorno e arrastando a seleção para cima a parte superior do arquivo de texto. O conteúdo da
da seleção será anexado ao arquivo.
Contribuição da Ajuda
O exemplo da ferramenta leia me também mostra como usar e implementar a ajuda de
contexto a todas as extensões fornecidas - uma exibição, várias ações e uma página de
assistente. Para obter uma ajuda de contexto na ação, suspenda sobre o item de menu,
mas não o selecione, e pressione a tecla F1. É possível também obter ajuda de contexto
(F1) na exibição Seções Leia me e na página Assistentes de Criação de Exemplo (no assistente Novo).
Detalhes
O exemplo de Ferramentas Leia me declara um ponto de extensão e fornece várias
extensão. As extensões fornecidas são facilmente compreendida no que se
refere às funções do workbench, como ele utiliza vários outros pontos de extensão mais
interessantes declarados pelo workbench. As extensões incluídas nesse exemplo
são exibições e ações de exibição, página de preferências, páginas de propriedades,
assistentes, editores e ações de editores, menus pop-up, conjunto de ações, contribuições de ajuda,
contextos de ajuda e ações de soltar.
Esses exemplos também fornecer um ponto de extensão declarado no plug-in.
A classe IReadmeFileParser é necessário para qualquer plug-in que use a extensão org.eclipse.ui.examples.readmetool.sectionParser
definida no exemplo. A classe DefaultSectionParser é
uma implementação do exemplo de IReadmeFileParser.
A classe ReadmeEditor implementa o IEditorPart e é definida como um editor de
arquivos com extensão .readme no plugin.xml usando o ponto de extensão org.eclipse.ui.editors.
A classe ReadmeSectionsView implementa o IViewPart e é definida
como uma exibição usando o ponto de extensão org.eclipse.ui.views. Esse
ponto de extensão também define a categoria para a exibição a ser usada na seleção da exibição.
Dois tipos de configurações de referência são definidos nesse exemplo: preferências do workbench
e propriedades de recursos. A primeira é definida na
classe ReadmePreferencePage que implementa IWorkbenchPreferencePage,
então ela será incluída no diálogo Workbench->Preferências. A classe é definida no
ponto de extensão org.eclipse.ui.preferencePages em plugin.xml.
As duas páginas de propriedades de recursos são ReadmeFilePropertyPage
e ReadmeFilePropertyPage2 e ambas implementam IWorkbenchPropertyPage.
Eles estão definidos para serem chamados no tipo IFile pela marcação objectClass
em plugin.xml no ponto de extensão org.eclipse.ui.propertyPages.
A classe ReadmeCreationWizard implementa INewWizard e é definida no ponto de
extensão org.eclipse.ui.newWizards em plugin.xml. Esse ponto de
extensão também define a categoria em que o assistente é mostrado
quando o usuário seleciona Arquivo->Novo->Outro....
Muitos stubs de ações são incluídos nesse exemplo. O conjunto de ações declara que
o menu chamado Editor de Arquivo Leia me para ser incluído na barra de menus da janela do workbench
usando o ponto de extensão org.eclipse.ui.actionSets. Ele também define uma ação
para a barra de ferramenta e para a barra de menus usando as marcações
toolbarPath menubarPath. Ele usa a classe WindowActionDelegate
que implemente IWorkbenchWindowActionDelegate para implementar a ação.
A ação para o menu pop-up é definida com um objectContribution pela
classe PopupMenuActionDelegate no ponto de extensão org.eclipse.ui.popupMenus.
PopupMenuActionDelegate implementa IObjectActionDelegate e usa o IWorkbenchPart
fornecido para abrir o diálogo de mensagem. A ação da exibição ViewActionDelegate é
definida no ponto de extensão org.eclipse.ui.viewActions e implementa
IViewActionDelegate. A Exibição que aparece é definida pela marcação de ID de destino
o que nesse exemplo é org.eclipse.ui.views.ResourceNavigator. A ações do editor
é definida pela classe EditorActionDelegate que implementa IEditorActionDelegate
e é incluída usando o ponto de extensão org.eclipse.ui.editorActions. O editor aplicado
é definido pela marcação de ID de destino que nesse exemplo é definido em org.eclipse.ui.examples.readmetool.ReadmeEditor.
A
classe ReadmeDropActionDelegate implementa IDropDelegate. IDropDelegates são
informadas cada vez que há uma ação de soltar no workbench . O ponto de
extensão para essa ação é org.eclipse.ui.dropActions.