FeaturesPluginsDocs & SupportCommunityPartners

Tutorial de início rápido do módulo do NetBeans

Este documento demonstra como criar um módulo que adicione uma barra de ferramentas do Google Search ao IDE ou a qualquer outra aplicação baseada na Plataforma NetBeans. Ele é semelhante ao seguinte:

Barra de ferramentas do Google mostrando a string de pesquisa de amostra

Para fazê-lo, use as APIs do NetBeans para aprimorar o conjunto de recursos da aplicação. Especificamente, crie uma ação que seja chamada por um botão na barra de ferramentas. Em seguida, crie um Swing JPanel contendo JLabel e JTextField como componentes de GUI. Finalmente, substitua o método getToolbarPresenter() da ação para retornar o JPanel de forma que ele seja exibido na barra de ferramentas, em vez do botão. Quando o módulo é instalado, o usuário digita uma string de pesquisa no JTextField e pressiona Enter, nesse ponto a classe URLDisplayer é usada para enviar a string para o navegador padrão do IDE. O navegador abre e exibe os resultados do Google da string de pesquisa do usuário.

Conteúdo

 O conteúdo desta página se aplica ao IDE NetBeans 6.0

Para obter mais informações sobre como trabalhar com módulos, consulte NetBeans Module and Rich Client Application Development no site do NetBeans. Se você tiver dúvidas, visite as Perguntas freqüentes do desenvolvedor do NetBeans ou use o link de comentários na parte inferior deste documento.


Instalando o software

Antes de começar, você deve instalar o seguinte software no seu computador:

Instalando a amostra

Para ver o resultado final deste tutorial, instale o módulo de amostra e teste a barra de ferramentas do Google no IDE:

  1. Baixe e descompacte o arquivo anexado.
  2. No IDE, escolha Arquivo > Abrir projeto (Ctrl+Shift+O) e navegue para a localização do arquivo descompactado. Selecione o projeto do módulo e clique em Abrir pasta do projeto. O projeto de módulo se abre no IDE e você deve ver o seguinte na janela Projetos (expanda os nós, se necessário):

    Arquivos de código-fonte exibidos na janela Projetos
  3. Clique com o botão direito do mouse no nó do projeto e escolha Instalar/Recarregar na plataforma de destino. Por padrão, a plataforma de destino é o IDE no qual está sendo desenvolvido o projeto de módulo. A plataforma de destino se abre e o módulo é instalado.
  4. Verifique se o módulo está corretamente instalado, testando sua funcionalidade, como descrito abaixo em Usando o módulo.

Agora que você sabe qual será o resultado final, crie o módulo do zero e aprenda sobre cada parte enquanto a está criando.


Configurando o projeto de módulo

Ao desenvolver o módulo, verifique se a estrutura do projeto está configurada corretamente. O NetBeans IDE oferece um assistente para Projeto de módulo que configura todos os arquivos básicos necessários para um módulo.

  1. Escolha Arquivo > Novo projeto (Ctrl-Shift-N). Em Categorias, selecione Módulos de plug-in do NetBeans. Em Projetos, selecione Projeto de módulo. Clique em Próximo.
  2. No painel Nome e localização, digite GoogleToolbar no campo Nome do projeto. Altere Local do projeto para qualquer diretório no computador. Deixe marcadas a opção Módulo independente e a caixa de verificação Definir como projeto principal. Clique em Próximo.
  3. No painel Configuração básica de módulos, substitua yourorghere em Nome base de código por myorg, de maneira que o nome base de código inteiro seja org.myorg.myfirstmodule. Deixe as localizações do conjunto de localizações e a camada XML, de modo que sejam armazenados em um pacote com o nome org/myorg/googletoolbar. Clique em Terminar.

O IDE cria o projeto GoogleToolbar. O projeto contém todos os metadados de projeto e fontes, como o script de construção Ant do projeto. O projeto se abre no IDE. Você pode visualizar a estrutura lógica na janela Projetos (Ctrl+1) e a estrutura de arquivos na janela Arquivos (Ctrl+2). Por exemplo, a janela Projetos agora deve ter esta aparência:

estrutura lógica exibida na janela Projetos.


Codificando o módulo

Para codificar o módulo, você precisa completar as seguintes etapas:

Criando a ação

  1. Clique com o botão direito do mouse no nó do projeto e escolha Nova > Ação (se Ação não estiver exibida, acesse-a escolhendo Outra, em seguida, no assistente para Novo arquivo em Categorias, selecione Desenvolvimento de módulo do NetBeans). Clique em Próximo.
  2. No painel Tipo de ação, mantenha a configuração padrão, que permitirá que o IDE crie uma ação que subclassifique CallableSystemAction, como mostrado abaixo:

    Etapa 1 do assustente para Nova ação

    Clique em Próximo.
  3. No painel Registro com GUI, selecione Editar na lista suspensa Categoria. A lista suspensa Categoria controla onde uma ação é mostrada no editor de atalhos de teclado no IDE. Em seguida, desmarque Item de menu global e selecione Botão da barra de ferramentas global. Na lista suspensa Barra de ferramentas, selecione Editar, em seguida, na lista suspensa Posição, selecione Localizar... - AQUI, como mostrado abaixo:

    Etapa 2 do assistente para Nova ação

    Clique em Próximo.
  4. No painel Novo e localização, digite GoogleAction como o Nome da classe e Google Action como o Nome de exibição. Vá para um ícone que tenha uma dimensão de 16x16 pixels. Na verdade, você não verá o ícone - em vez disso, exibirá o formulário JPanel que criará na próxima seção. Entretanto, o assistente para Nova ação requer que você especifique um ícone. Portanto, o ícone poderia ser de qualquer dimensão, já que você não o usará. Clique em Terminar. Observe que GoogleAction.java é adicionado ao pacote org.myorg.googletoolbar na janela Projetos.

Criando o JPanel

  1. Clique com o botão direito do mouse no nó do projeto e escolha Novo > Outro. Em Categorias, selecione Formulários GUI Java. Em Projetos, selecione Formulário JPanel. Clique em Próximo.
  2. No painel Nome e localização, digite GooglePanel como o Nome da classe e selecione o painel na lista suspensa. Clique em Terminar. GooglePanel.java é adicionado ao pacote e é aberto na visualização Design no Editor de código-fonte.
  3. Coloque o cursor no canto inferior direito do JPanel, em seguida, selecione o JPanel e arraste o cursor para redimensioná-lo, de forma que sua largura e cumprimento fiquem parecidos com os de uma barra de ferramentas, como mostrado abaixo:

    JPanel redimensionado
  4. Arraste um item JTextField e um item JLabel da Paleta (Ctrl+Shift+8) diretamente para o JPanel, em seguida, redimensione o JPanel e os outros dois itens, para que eles se encaixem. Finalmente, clique no JLabel e altere seu texto para Google:, em seguida, exclua o texto padrão no JTextField. Seu JPanel agora deve se parecer com a imagem mostrada abaixo:

    JTextField e JLabel incluídos no JPanel
  5. Verifique se o Inspetor de propriedades está aberto (Janela > Navegação > Inspetor), em seguida, clique com o botão direito do mouse em JTextField e escolha Eventos > Tecla > keyTyped. Isso gera um método jTextField1KeyTyped() no código-fonte GooglePanel.java, que é exibido no Editor de código-fonte, como mostrado abaixo:

    Método JTextField1KeyTyped() gerado no código-fonte
  6. No Editor de código-fonte, na visualização Código-fonte do GooglePanel.java, preencha o método jTextField1KeyTyped(), da seguinte forma (texto inserido mostrado em negrito):
        
    private void jTextField1KeyTyped(java.awt.event.KeyEvent evt) {
        int i = evt.getKeyChar();
        if (i==10){//The ENTER KEY
            // exibimos a url do googlel.
            try{
                URLDisplayer.getDefault().showURL
                        (new URL("http://www.google.com/search?hl=en&q="+jTextField1.getText()+"&btnG=Google+Search"));
            } catch (Exception eee){
                return;//nothing much to do
            }
        }
    }

Se precisar, clique com o botão direito do mouse no Editor de código-fonte e escolha Formatar (Alt+Shift+F).

Resolvendo erros

Observe que várias linhas de código são sublinhadas em vermelho, indicando erros. Isso acontece porque pacotes necessários ainda não foram importados. Coloque o cursor sobre o ícone da lâmpada exibido na coluna imediatamente à esquerda da linha vermelha de URLDisplayer. É exibida uma dica de ferramenta, indicando o motivo do erro:

dica de ferramenta do erro URLDisplayer no Editor de código-fonte

Para resolver isso, você precisa disponibilizar a classe HtmlBrowser.URLDisplayer, incluída no pacote org.openide.awt, para o seu projeto. Para isso, execute as seguintes etapas:

  1. Clique com o botão direito do mouse no nó do projeto na janela Projetos e escolha Propriedades. Na caixa de diálogo Propriedades do projeto, selecione Bibliotecas sob o título Categorias. Em seguida, em Dependências de módulo, clique no botão Adicionar. A caixa de diálogo Adicionar dependência de módulo é exibida.
  2. Na caixa de texto do filtro exibida na parte inferior da caixa de diálogo Adicionar dependência de módulo, comece a digitar URLDisplayer e observe que a seleção dos módulos retornados se estreita até que somente a listagem restante seja a API de utilitários de IU:

    Caixa de diálogo Adicionar dependência de módulo exibindo a API de utilitários de IU

    Clique em OK, em seguida, clique em OK novamente para sair da caixa de diálogo Propriedades do projeto.
  3. Clique com o botão direito do mouse no Editor de código-fonte e escolha Corrigir importações (Alt+Shift+F). A caixa de diálogo Corrigir todas as importações é exibida, listando os caminhos sugeridos para classes não reconhecidas:

    Caixa de diálogo Corrigir todas as importações contendo caminhos sugeridos para classes não reconhecidas

    Clique em OK. O IDE cria as instruções de importação seguintes para GooglePanel.java:
    import java.net.URL;
    import org.openide.awt.HtmlBrowser.URLDisplayer;               
                
    Observe também que todos os erros desaparecem do Editor de código-fonte.

Substituindo getToolbarPresenter()

Como o JPanel que você criou é o componente real que exibirá a barra de ferramentas do Google, é preciso substituir o método getToolbarPresenter() na classe da ação. Em GoogleAction.java, faça o seguinte:

  1. Abaixo da declaração da classe, declare e defina a variável seguinte:
    GooglePanel retValue = new GooglePanel();
                
  2. Defina o método getToolbarPresenter() para retornar a variável retValue:
    public java.awt.Component getToolbarPresenter() {
        return retValue;
    }
                

Compilando, instalando e usando o módulo

O NetBeans IDE usa um script de construção Ant para compilar e instalar seu módulo no IDE. O script de construção foi criado para você quando o projeto do módulo foi criado em Configurando o projeto de módulo acima. Agora que o módulo está pronto para ser compilado e adicionado ao IDE, você pode usar o suporte a Ant do NetBeans IDE a fim fazê-lo:

  1. Na janela Projetos, clique com o botão direito do mouse no nó do projeto GoogleToolbar e escolha Instalar/Recarregar na plataforma de destino. O módulo é construído e instalado em uma nova instância do IDE (ou seja, a plataforma de destino). Por padrão, a plataforma de destino padrão é a versão do IDE em que você está trabalhando no momento. A plataforma de destino se abre, de modo que você possa experimentar o novo módulo.
  2. Quando ele é instalado com êxito, o módulo adiciona um novo botão na barra de ferramentas Editar do IDE. Entretanto, observe que o botão da barra de ferramentas não é exibido como um ícone. Em vez disso, ele exibe o JPanel que você criou em Criando o JPanel acima:

    Barra de ferramentas do Google incorporada na barra de ferramentas Editar do IDE
  3. Digite uma string de pesquisa no campo de texto:

    Barra de ferramentas do Google mostrando a string de pesquisa de amostra
  4. Pressione Enter. O navegador padrão do IDE é iniciado. A URL do Google e a sua string de pesquisa são enviadas para o navegador e uma pesquisa é realizada. Quando os resultados da pesquisa são retornados, você pode visualizá-los no navegador.

Compartilhando o módulo

Agora que você construiu um módulo de trabalho que aprimora o IDE, por que não compartilhá-lo com outros desenvolvedores? O NetBeans IDE oferece uma forma fácil de criar um arquivo de módulo binário do NetBeans (.nbm), que é um meio universal de permitir que outros o experimentem em suas próprias versões do IDE (na verdade, isso é o que você fez em Instalando a amostra acima. Para criar um binário do módulo, faça o seguinte:

Na janela Projetos, clique com o botão direito do mouse no nó do projeto GoogleToolbar e escolha Criar NBM. O novo arquivo NBM é criado e você pode visualizá-lo na janela Arquivos (Ctrl+2):

novo arquivo NBM exibido na janela Arquivos

Próximas etapas

Isso conclui o tutorial Módulo da barra de ferramentas do Google do NetBeans. Este documento descreveu como criar um módulo que adiciona uma barra de ferramentas Google Search ao IDE. Para obter mais informações sobre a criação e o desenvolvimento de módulos, consulte os seguintes recursos:



Companion
Projects:
MySQL Database Server   Open JDK: an Open SourceJDK   GlassFish Community: an Open Source Application Server    Mobile & Embedded Community    Open Solaris   java.net - The Source for Java Technology Collaboration   Open ESB - The Open Enterprise Service Bus Powered by