| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
| <html xmlns="http://www.w3.org/1999/xhtml">
|
| <head>
|
| <!-- -*- xhtml -*- -->
|
| <title>Tutorial de integração de tipo de arquivo para a plataforma NetBeans 6.5</title>
|
| <link rel="stylesheet" type="text/css" href="https://netbeans.org/netbeans.css"/>
|
| <meta name="AUDIENCE" content="NBUSER"/>
|
| <meta name="TYPE" content="ARTICLE"/>
|
| <meta name="EXPIRES" content="N"/>
|
| <meta name="developer" content="gwielenga@netbeans.org"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
| <meta name="indexed" content="y"/>
|
| <meta name="description"
|
| content="A short guide to using the DataLoader API, as well as other APIs
|
| relating to file support."/>
|
| <!-- Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved. -->
|
| <!-- Use is subject to license terms.-->
|
| </head>
|
| <body>
|
| <h1>Tutorial de integração de tipo de arquivo</h1>
|
|
|
| <p>Este tutorial mostra como gravar um módulo que permite que o IDE, ou qualquer outro aplicativo construído na Plataforma NetBeans, reconheça um novo tipo de arquivo.</p>
|
|
|
| <p><b class="notes">Nota:</b> este documento usa a versão NetBeans IDE 6.5. Se você estiver utilizando o NetBeans IDE 6.x, consulte <a href="60/nbm-filetype_pt_BR.html">a versão 6.1 deste documento</a>.</p>
|
|
|
| <p><b>Conteúdo</b></p>
|
|
|
| <p><img src="../images/articles/69/netbeans-stamp7-8-9.png" class="stamp" width="114" height="114" alt="O conteúdo desta página se aplica ao NetBeans IDE 6.5, 6.7, 6.8" title="O conteúdo desta página se aplica ao NetBeans IDE 6.5, 6.7, 6.8" /></p>
|
| <ul class="toc">
|
| <li><a href="#intro">Introdução à integração do tipo de arquivo</a></li>
|
| <li><a href="#creating">Criando o projeto do módulo </a></li>
|
| <li><a href="#recognizing">Reconhecendo arquivos Abc</a></li>
|
| <li><a href="#install">Instalando e testando a funcionalidade</a></li>
|
| <li><a href="#adding">Criando recursos para arquivos Abc</a>
|
| <ul>
|
| <li><a href="#action">Adicionando uma ação</a></li>
|
| <li><a href="#topcomponent">Abrindo o arquivo em uma janela</a></li>
|
| <li><a href="#multiview">Criando uma janela de múltiplas visualizações</a></li>
|
| </ul></li>
|
| <li><a href="#share">Criando um binário compartilhável</a></li>
|
| </ul>
|
|
|
| <p><b>Para seguir este tutorial, os softwares e recursos listados na tabela seguinte são necessários.</b></p>
|
|
|
| <table>
|
| <tbody>
|
| <tr>
|
| <th class="tblheader" scope="col">Software ou recurso</th>
|
| <th class="tblheader" scope="col">Versão necessária</th>
|
| </tr>
|
| <tr>
|
| <td class="tbltd1"><a href="https://netbeans.org/downloads/index.html">NetBeans IDE</a></td>
|
| <td class="tbltd1">versão 6.7 ou superior</td>
|
| </tr>
|
| <tr>
|
| <td class="tbltd1"><a href="http://java.sun.com/javase/downloads/index.jsp">Java Developer Kit (JDK)</a></td>
|
| <td class="tbltd1">Versão 6 ou<br/>versão 5</td>
|
| </tr>
|
| </tbody>
|
| </table>
|
|
|
|
|
|
|
|
|
| <h2 class="tutorial"><a name="intro"></a>Introdução à integração do tipo de arquivo</h2>
|
|
|
| <p>Os tipos de arquivo reconhecidos no IDE possuem seus próprios ícones, itens de menu e comportamento. Os "arquivos" mostrados são <tt>FileObjects</tt> - wrappers em torno de <tt>java.io.File</tt> ou, no caso dos arquivos de configuração, geralmente wrappers em torno dos dados armazenados de outra maneira, como em arquivos XML em módulos. O que você <i>vê</i>, na verdade, são <tt>nós</tt>, que fornecem funcionalidade como ações e nomes localizados a objetos como arquivos. Entre os <tt>nós</tt> e os <tt>FileObjects</tt> estão os <tt>DataObjects</tt>. Um <tt>DataObject</tt> é parecido com um <tt>FileObject</tt>, só que ele sabe qual tipo de arquivo está sendo mostrado e geralmente há tipos diferentes de <tt>DataObject</tt> para arquivos com extensões diferentes e arquivos XML com namespaces diferentes. Cada <tt>DataObject</tt> é fornecido por um módulo diferente, cada um implementando suporte para um ou mais tipos de arquivos. Por exemplo, o módulo Imagem permite que sejam reconhecidos e abertos arquivos <tt>.gif</tt> e <tt>.png</tt>.</p>
|
|
|
| <p>Um módulo que reconhece um tipo de arquivo instala um <tt>DataLoader</tt>: uma fábrica para um <tt>DataObject</tt> específico de um tipo de arquivo. Quando uma pasta é expandida, o IDE pergunta a cada <tt>DataLoader</tt> conhecido: "você sabe o que é isto?" O primeiro que responder "Sim" cria o <tt>DataObject</tt> para o arquivo. Para realmente exibir algo para cada arquivo, o sistema chama <tt>DataObject.getNodeDelegate()</tt> para cada <tt>DataObject</tt> e os <tt>nós</tt> são o que você realmente vê no IDE.</p>
|
|
|
| <p>Abaixo, o diagrama à esquerda mostra o que cada item mencionado acima disponibiliza:</p>
|
|
|
| <p><img src="../images/tutorials/filetype/diagram-dataobject2.png" alt="Diagrama." /></p>
|
|
|
| <p>Neste tutorial, você criará um módulo para instalar um <tt>DataLoader</tt> para arquivos "Abc" imaginários (extensão de arquivo <tt>.abc</tt>). Como padrão, um arquivo com a extensão "abc" é tratado como qualquer outro arquivo que o IDE não reconheça: ele é tratado como um arquivo de texto e, como resultado, o IDE fornece a mesma funcionalidade para os arquivos Abc que fornece para os arquivos de texto. Após ter criado o módulo, você saberá como aprimorá-lo com funcionalidades que estarão disponíveis somente para arquivos Abc. Quando você concluir o ciclo de desenvolvimento, poderá permitir facilmente que outras pessoas utilizem o seu módulo: o IDE permite a criação de um binário que pode ser enviado para outras pessoas que poderão instalá-lo através da Central de Atualizações.</p>
|
|
|
| <!-- ===================================================================================== -->
|
|
|
| <h2 class="tutorial"><a name="creating"></a>Criando o projeto do módulo </h2>
|
|
|
| <p>Nesta seção, utilizaremos um assistente para criar a estrutura de código-fonte que todo módulo NetBeans precisa. A estrutura do código-fonte consiste em determinadas pastas em locais específicos e em um conjunto de arquivos que sempre são necessários. Por exemplo, cada módulo NetBeans requer uma pasta <tt>nbproject</tt>, que contém os metadados do projeto, e um arquivo <tt>layer.xml</tt>, para registro de declaração de itens como janelas e botões da barra de ferramentas.</p>
|
|
|
| <ol>
|
|
|
| <li>Escolha Arquivo > Novo projeto (Ctrl-Shift-N). Em Categorias, selecione Módulos do NetBeans. Em Projetos, selecione Módulo e clique em Próximo.</li>
|
| <li>No painel Nome e localização, digite <tt>AbcFileType</tt> em Nome do projeto. Altere a Localização do projeto para qualquer diretório no computador, como <tt>c:\meusmodulos</tt>. Deixe o botão de opção Módulo independente selecionado. O painel agora deve ter esta aparência:
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-projectwizard1.png" alt="Etapa 1 do assistente para Nova Projeto." /></p>
|
| <p>Clique em Próximo.</p></li>
|
|
|
| <li>No painel Configuração básica de módulos, digite <tt>org.myorg.abcfiletype</tt> como o Nome base de código. Adicione espaços ao Nome de exibição do módulo sugerido, para que ele seja alterado para <tt>Tipo de arquivo Abc</tt>. Marque a caixa de verificação "Gerar camada XML" e deixe o pacote de localização e a camada XML onde estão, para que eles sejam armazenados em um pacote com o nome <tt>org/myorg/abcfiletype</tt>. O painel agora deve ter esta aparência:
|
|
|
| <p><img src="../images/tutorials/filetype/65-projectwizard2.png" alt="Etapa 2 do assistente para Novo projeto" /></p></li>
|
|
|
| <li>Clique em Terminar.</li></ol>
|
|
|
| <p> O IDE cria o projeto <tt>Tipo de arquivo Abc</tt>. O projeto contém todos os metadados de projeto e códigos-fonte, como o script de construção Ant do projeto. O projeto se abre no IDE. Você pode ver 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:</p>
|
|
|
| <p><img src="../images/tutorials/filetype/65-projectswindow1.png" alt="Janela Projetos iniciais." /></p>
|
|
|
| <!-- ===================================================================================== -->
|
| <h2><a name="recognizing"></a>Reconhecendo arquivos Abc</h2>
|
|
|
| <p>Nesta seção, utilizaremos um assistente para criar as classes necessárias para reconhecer arquivos Abc como sendo distintos de todos os outros. Conforme discutido no início deste tutorial, para fazer isso precisamos de um objeto de dados e um carregador de dados, assim como de um solucionador de tipo MIME e entradas de registro no arquivo <tt>layer.xml</tt>. O Assistente de novo tipo de arquivo criará tudo isso.</p>
|
|
|
|
|
| <ol>
|
|
|
| <li>Clique com o botão direito do mouse no nó do projeto e escolha Novo > Tipo de arquivo.</li>
|
| <li>No Painel de reconhecimento de arquivos, faça o seguinte:
|
| <ul>
|
| <li>digite <tt>text/x-abc</tt> na caixa de edição Tipo MIME.</li>
|
| <li>Digite <tt>.abc .ABC</tt> na caixa de edição por Extensão de nome de arquivo.</li>
|
| </ul>
|
| <p>O Painel de reconhecimento de arquivos agora deve ter esta aparência:</p>
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/60-filewizard1.png" alt="Etapa 1 do assistente para Novo arquivo" /></p>
|
|
|
| <p>Observe o seguinte sobre os campos no Painel de reconhecimento de arquivos:</p>
|
| <ul>
|
| <li><b>Tipo MIME.</b> Especifica o tipo MIME exclusivo do objeto de dados.</li>
|
| <li>por
|
| <ul><li><b>Extensão de nome de arquivo.</b> Especifica uma ou mais extensões que o IDE gerará reconhecer como pertencente ao tipo de MIME determinado. A extensão do arquivo pode opcionalmente ser precedida por um ponto. Os separadores são vírgulas, espaços ou ambos. Portanto, todos os exemplos a seguir são válidos:
|
| <ul><li><tt>.abc,.def</tt></li>
|
| <li><tt>.abc .def</tt></li>
|
| <li><tt>abc def</tt></li>
|
| <li><tt>abc,.def ghi, .wow</tt></li></ul>
|
| <p>Vamos imaginar que os arquivos Abc diferenciem maiúsculas de minúsculas. Por esse motivo, você especificará <i>dois</i> tipos MIME neste tutorial:<tt>.abc</tt> e <tt>.ABC</tt>.</p></li>
|
| <li><b>Elemento raiz XML.</b> Especifica um único namespace que distingue um tipo de arquivo XML de todos os outros tipos de arquivos XML. Como muitos arquivos XML possuem a mesma extensão (<tt>xml</tt>), o IDE faz a distinção entre os arquivos XML através de seus elementos raiz XML. Mais especificamente, o IDE pode distinguir entre namespaces e o primeiro elemento XML em arquivos XML. Você pode usar isto para, por exemplo, distinguir entre um descritor de deployment JBoss e um descritor de deployment WebLogic. Após ter feito essa distinção, você poderá certificar-se de que os itens de menu adicionados ao menu contextual do descritor de deployment JBoss não estão disponíveis no descritor de deployment WebLogic. Para obter um exemplo, consulte o <a href="nbm-palette-api2.html">Tutorial do módulo da paleta de componentes do NetBeans</a>.</li></ul></li>
|
| </ul>
|
|
|
| <p>Clique em Próximo.</p></li>
|
|
|
| <li>No painel Nome e localização, digite <tt>Abc</tt> como o Prefixo do nome da classe e vá para qualquer arquivo de imagem de 16 x 16 pixels como o ícone do novo tipo de arquivo, conforme mostrado abaixo.
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-filewizard2.png" alt="Etapa 2 do assistente para Novo arquivo" /></p>
|
|
|
|
|
| <p><b>Nota:</b> você pode utilizar qualquer ícone com uma dimensão de 16x16 pixels. Se desejar, você pode clicar neste e salvá-lo localmente e depois especificá-lo na etapa do assistente acima: <img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/Datasource.gif" alt="Datasource.gif" /></p></li>
|
|
|
| <li>Clique em Terminar.</li></ol>
|
|
|
| <p>A janela Projetos agora deve ter esta aparência:</p>
|
|
|
| <p><img src="../images/tutorials/filetype/65-projectswindow2.png" alt="Janela Projetos finais." /></p>
|
|
|
| <p>Cada um dos arquivos recém-gerados é brevemente apresentado:</p>
|
| <ul>
|
| <li><b>AbcDataObject.java.</b> Inclui um <tt>FileObject</tt>. DataObjects são produzidos por DataLoaders. Para obter mais informações, consulte <a href="http://wiki.netbeans.org/wiki/view/DevFaqDataObject">O que é um DataObject?</a>.</li>
|
| <li><b>AbcResolver.xml.</b> Mapeia as extensões <tt>.abc</tt> e <tt>.ABC</tt> para o tipo de MIME. O <tt>AbcDataLoader</tt> reconhece somente o tipo MIME; ele não conhece a extensão de arquivo.</li>
|
| <li><b>AbcTemplate.abc.</b> Fornece a base para um modelo de arquivo registrado no <tt>layer.xml</tt> de forma que seja instalado na caixa de diálogo Novo arquivo como um novo modelo.</li>
|
| <li><b>AbcDataObjectTest.java.</b> Classe de teste JUnit para <tt>DataObject</tt>.</li>
|
| </ul>
|
|
|
| <p>No arquivo <tt>layer.xml</tt>, você deve ver o seguinte:</p>
|
|
|
| <pre><folder name="Loaders">
|
| <folder name="text">
|
| <folder name="x-abc">
|
| <folder name="Actions">
|
| <file name="org-myorg-abcfiletype-MyAction.shadow">
|
| <attr name="originalFile" stringvalue="Actions/Edit/org-myorg-abcfiletype-MyAction.instance"/>
|
| <attr name="position" intvalue="600"/>
|
| </file>
|
| <file name="org-openide-actions-CopyAction.instance">
|
| <attr name="position" intvalue="100"/>
|
| </file>
|
| <file name="org-openide-actions-CutAction.instance">
|
| <attr name="position" intvalue="200"/>
|
| </file>
|
| <file name="org-openide-actions-DeleteAction.instance">
|
| <attr name="position" intvalue="300"/>
|
| </file>
|
| <file name="org-openide-actions-FileSystemAction.instance">
|
| <attr name="position" intvalue="400"/>
|
| </file>
|
| <file name="org-openide-actions-OpenAction.instance">
|
| <attr name="position" intvalue="500"/>
|
| </file>
|
| <file name="org-openide-actions-PropertiesAction.instance">
|
| <attr name="position" intvalue="700"/>
|
| </file>
|
| <file name="org-openide-actions-RenameAction.instance">
|
| <attr name="position" intvalue="800"/>
|
| </file>
|
| <file name="org-openide-actions-SaveAsTemplateAction.instance">
|
| <attr name="position" intvalue="900"/>
|
| </file>
|
| <file name="org-openide-actions-ToolsAction.instance">
|
| <attr name="position" intvalue="1000"/>
|
| </file>
|
| <file name="sep-1.instance">
|
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
|
| <attr name="position" intvalue="1100"/>
|
| </file>
|
| <file name="sep-2.instance">
|
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
|
| <attr name="position" intvalue="1200"/>
|
| </file>
|
| <file name="sep-3.instance">
|
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
|
| <attr name="position" intvalue="1300"/>
|
| </file>
|
| <file name="sep-4.instance">
|
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/>
|
| <attr name="position" intvalue="1400"/>
|
| </file>
|
| </folder>
|
| <folder name="Factories">
|
| <file name="AbcDataLoader.instance">
|
| <attr name="SystemFileSystem.icon" urlvalue="nbresloc:/org/myorg/abcfiletype/Datasource.gif"/>
|
| <attr name="dataObjectClass" stringvalue="org.myorg.abcfiletype.AbcDataObject"/>
|
| <attr name="instanceCreate" methodvalue="org.openide.loaders.DataLoaderPool.factory"/>
|
| <attr name="mimeType" stringvalue="text/x-abc"/>
|
| </file>
|
| </folder>
|
| </folder>
|
| </folder>
|
| </folder></pre>
|
|
|
|
|
|
|
| <!-- ======================================================================================= -->
|
|
|
| <h2><a name="install"></a>Instalando e testando a funcionalidade</h2>
|
| <p>Agora vamos instalar o módulo e utilizar a funcionalidade básica criada até o momento. O IDE utiliza um script de construção Ant para construir e instalar seu módulo. O script de construção é criado quando o projeto é criado.</p>
|
| <div class="indent">
|
|
|
|
|
| <ol>
|
| <li>Na janela Projetos, clique com o botão direito do mouse no projeto <tt>Tipo de arquivo Abc</tt> e escolha Executar.
|
| <p>Uma nova instância do IDE é iniciada, instalando o módulo nele próprio.</p></li>
|
| <li>Utilize a caixa de diálogo Novo projeto (Ctrl-Shift-N) para criar qualquer tipo de aplicativo no IDE.</li>
|
| <li>Clique com o botão direito do mouse no nó do aplicativo e escolha Novo > Outro. Na categoria Outro, um modelo está disponível para trabalhar com o novo tipo de arquivo:
|
| <p><img src="../images/tutorials/filetype/60-action4.png" alt="Modelo fictício." /></p>
|
| <p>Complete o assistente e assim terá criado um modelo que pode ser utilizado para iniciar o trabalho do usuário com o tipo de arquivo fornecido.</p>
|
| <p class="tips">Se você desejar fornecer código padrão através do modelo, adicione o código ao arquivo <tt>AbcTemplate.abc</tt> que o assistente Novo tipo de arquivo criou para você.</p></li>
|
| </ol>
|
| </div>
|
|
|
| <!-- ===================================================================================== -->
|
| <h2><a name="adding"></a>Criando recursos para arquivos Abc</h2>
|
| <p>Agora que a Plataforma NetBeans consegue distinguir arquivos Abc de todos os outros tipos de arquivos, é hora de adicionar recursos especificamente para esses tipos de arquivos. Nesta seção, adicionaremos um item de menu no menu contextual de clique com o botão direito do nó do arquivo na janela do explorer, como na janela Projetos, e permitiremos que o arquivo seja aberto em uma janela, em vez de em um editor.</p>
|
|
|
| <div class="indent">
|
|
|
| <h3 class="tutorial"><a name="action"></a>Adicionando uma ação</h3>
|
|
|
| <p>Nesta subseção, utilizaremos o assistente de Nova ação para criar uma classe Java que realizará uma ação para o nosso tipo de arquivo. O assistente também registrará a classe no arquivo <tt>layer.xml</tt> de forma que o usuário possa chamar a ação do menu contextual de clique com o botão direito do nó do tipo de arquivo em uma janela do explorer.</p>
|
|
|
| <ol>
|
|
|
| <li>Clique com o botão direito do mouse no nó do projeto e escolha Nova > Ação</li>
|
| <li>No painel Tipo de ação, clique em Habilitada condicionalmente. Digite <tt>AbcDataObject</tt>, que é o nome do objeto de dados gerado acima pelo assistente de Novo tipo de arquivo, conforme mostrado abaixo:
|
|
|
| <p><img src="../images/tutorials/filetype/60-action1.png" alt="Etapa 1 do assistente para Nova ação" /></p>
|
|
|
|
|
|
|
| <p>Clique em Próximo.</p></li>
|
|
|
| <li>No painel Registro de 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.
|
| <p>Em seguida, desmarque Item de menu global e selecione Item de menu de conteúdo de tipo de arquivo. Na lista suspensa Tipo de conteúdo, selecione o tipo MIME especificado acima no assistente de Novo tipo de arquivo, conforme mostrado abaixo:</p>
|
|
|
| <p><img src="../images/tutorials/filetype/60-action2.png" alt="Etapa 2 do assistente para Nova ação" /></p>
|
|
|
| <p>Observe que você pode definir a posição do item de menu e que pode separar o item de menu do item antes e depois dele. Clique em Próximo.</p></li>
|
|
|
| <li>No painel Novo e localização, digite <tt>MyAction</tt> como o Nome da classe e <tt>My Action</tt> como o Nome de exibição. Os itens de menu fornecidos por menus contextuais não exibem ícones. Assim, clique em Terminar e <tt>MyAction.java</tt> será adicionado ao pacote <tt>org.myorg.abcfiletype</tt>.</li>
|
|
|
| <li>No Editor de código-fonte, adicione algum código ao método <tt>actionPerformed</tt> da ação:
|
|
|
| <pre class="examplecode">@Override
|
| public void actionPerformed(ActionEvent ev) {
|
| FileObject f = context.getPrimaryFile();
|
| String displayName = FileUtil.getFileDisplayName(f);
|
| String msg = "I am " + displayName + ". Hear me roar!"; |
| NotifyDescriptor nd = new NotifyDescriptor.Message(msg); |
| DialogDisplayer.getDefault().notify(nd); |
| }</pre>
|
| <p>Pressione Ctrl-Shift-I. O IDE automaticamente adiciona comandos import à parte superior da classe.</p>
|
|
|
| <p class="tips">Ainda há algum código sublinhado em vermelho, para indicar que nem todos os pacotes necessários estão no classpath. Clique com o botão direito do mouse no nó do projeto, escolha Propriedades e clique em Bibliotecas na caixa de diálogo Propriedades do projeto. Clique em Adicionar na parte superior do painel Bibliotecas e adicione a API das caixas de diálogo.</p>
|
|
|
| <p>Na classe <tt>MyAction.java</tt>, pressione Ctrl-Shift-I novamente. O sublinhado vermelho desaparece porque o IDE encontra os pacotes necessários na API das caixas de diálogo.</p></li>
|
|
|
| <li>No nó Arquivos importantes, expanda Camada XML. Os dois nós <tt><esta camada></tt> e <tt><esta camada no contexto></tt>, junto com seus subnós, formam o navegador <a href="https://platform.netbeans.org/tutorials/nbm-glossary.html">Sistema de arquivos do sistema</a>. Expanda <tt><esta camada></tt>, expanda <tt>Carregadores</tt>, continue expandindo nós até ver a <tt>Ação</tt> criada acima.</li>
|
|
|
| <li>Arraste e solte <tt>Minha ação</tt> para que ela apareça abaixo da ação <tt>Abrir</tt>, como mostrado abaixo:
|
| <p><img src="../images/tutorials/filetype/60-action3.png" alt="Navegador Sistema de arquivos do sistema." /></p>
|
|
|
| <p>Como você pode ver nas últimas duas etapas, o Navegador sistema de arquivos do sistema pode ser utilizado para reorganizar rapidamente a sequência de itens registrados no Sistema de arquivos do sistema.</p></li>
|
|
|
| <li>Execute novamente o módulo, como fez na seção anterior.</li>
|
| <li>Crie um arquivo ABC, utilizando o modelo mostrado na seção anterior, e clique com o botão direito do mouse no nó do arquivo de uma das visualizações do explorer, como a janela Projeto ou a janela Favoritos.
|
| <p>Observe que o arquivo Abc possui o ícone atribuído a ele em seu módulo e que a lista de ações definidas no arquivo <tt>layer.xml</tt> está disponível do menu contextual de clique com o botão direito do mouse:</p>
|
| <p><img src="../images/tutorials/filetype/60-dummytemplate.png" alt="Janela Projetos finais." /></p></li>
|
| <li>Escolha o novo item de menu, o nome e a localização do arquivo Abc são mostrados:
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/60-information.png" alt="Informação." /></p></li>
|
|
|
|
|
| </ol>
|
|
|
| <p>Você agora sabe como criar uma nova ação que aparece no menu de contexto de um arquivo do tipo fornecido, na janela Projetos, janela Arquivos ou na janela Favoritos.</p>
|
|
|
| <h3 class="tutorial"><a name="topcomponent"></a>Abrindo o arquivo em uma janela</h3>
|
| <p>Como padrão, quando o usuário abre um arquivo do tipo definido neste tutorial, o arquivo é aberto em um editor básico. Entretanto, algumas vezes você pode querer criar uma representação visual do arquivo e permitir que o usuário arraste e solte widgets na representação visual. A primeira etapa na criação dessa interface do usuário é permitir que o usuário abra o arquivo em uma janela. Esta subseção mostra como fazê-lo.</p>
|
| <ol>
|
| <li>Clique com o botão direito do mouse no nó do projeto e escolha Novo > Componente da janela. Defina "editor" para Posição da janela e "Abrir na inicialização do aplicativo", como abaixo mostrado:
|
|
|
| <p><img src="../images/tutorials/filetype/65-topc-1.png" alt="Etapa 1 do assistente para Nova ação" /></p></li>
|
| <li>Clique em Próximo e digite "Abc" como o prefixo do nome da classe:
|
| <p><img src="../images/tutorials/filetype/65-topc-2.png" alt="Etapa 1 do assistente para Nova ação" /></p>
|
| <p>Clique em Terminar.</p>
|
| </li>
|
| <li>Altere <tt>DataObject</tt> para utilizar <tt><a href="http://bits.netbeans.org/dev/javadoc/org-openide-loaders/org/openide/loaders/OpenSupport.html">OpenSupport </a></tt> em vez de DataEditorSupport, alterando o construtor de <tt>DataObject</tt> da seguinte maneira:
|
|
|
| <pre>public AbcDataObject(FileObject pf, MultiFileLoader loader) |
| throws DataObjectExistsException, IOException { |
| |
| super(pf, loader); |
| CookieSet cookies = getCookieSet(); |
| <b>//cookies.add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), cookies)); |
| cookies.add((Node.Cookie) new AbcOpenSupport(getPrimaryEntry()));</b> |
| |
| }</pre>
|
| </li>
|
|
|
| <li>Crie a classe <tt><a href="http://bits.netbeans.org/dev/javadoc/org-openide-loaders/org/openide/loaders/OpenSupport.html">OpenSupport</a></tt>:
|
|
|
| <pre>class AbcOpenSupport extends OpenSupport implements OpenCookie, CloseCookie { |
| |
| public AbcOpenSupport(AbcDataObject.Entry entry) { |
| super(entry); |
| } |
| |
| protected CloneableTopComponent createCloneableTopComponent() { |
| AbcDataObject dobj = (AbcDataObject) entry.getDataObject(); |
| AbcTopComponent tc = new AbcTopComponent(); |
| tc.setDisplayName(dobj.getName()); |
| return tc; |
| } |
| |
| }</pre>
|
|
|
| <p class="tips">Ajuste o TopComponent para estender CloneableTopComponent, em vez de TopComponent. Defina o modificador de classe do TopComponent e o modificador de seu construtor, como público em vez de privado.</p></li>
|
| </ol>
|
| <p>Instale o módulo novamente e depois, quando um arquivo Abc estiver aberto, a classe <tt>OpenSupport </tt>lidará com a abertura de forma que o arquivo seja aberto no <tt>TopComponent</tt> em vez de abrir no editor básico do <tt>DataEditorSupport:</tt></p>
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-topc-3.png" alt="Etapa 1 do assistente para Nova ação" /></p>
|
|
|
| <p class="tips">O <a href="https://platform.netbeans.org/tutorials/nbm-visual_library.html">tutorial do NetBeans Visual Library </a> fornece um exemplo do que você pode fazer para desenvolver o TopComponent ainda mais para que ele exiba o conteúdo de um arquivo que corresponda ao tipo de arquivo definido neste tutorial.</p>
|
|
|
| <br />
|
|
|
| <!-- ======================================================================================= -->
|
|
|
| <h3><a name="multiview"></a>Criando uma janela de múltiplas visualizações</h3>
|
|
|
| <p>Agora que somos capazes de abrir um arquivo em uma janela, vamos tornar esta janela mais interessante. Iremos criar uma janela de múltiplas visualizações. A primeira aba de uma janela com múltiplas visualizações é normalmente utilizada para exibir uma representação visual do arquivo, enquanto a segunda aba normalmente mostra a visualização fonte. Mais do que duas abas podem ser fornecidas, cada uma fornecendo mais níveis de detalhes sobre o arquivo aberto.</p>
|
|
|
| <ol>
|
| <li>Clique com o botão direito do mouse no nó do projeto e escolha Propriedades. Na caixa de diálogo Propriedades do projeto, escolha Bibliotecas, e clique em Adicionar. Defina uma dependência na "<a href="http://bits.netbeans.org/dev/javadoc/org-netbeans-core-multiview/overview-summary.html">Janela com múltiplas visualizações</a>". Clique em OK, em seguida, clique em OK novamente para sair da caixa de diálogo Propriedades do projeto.</li>
|
| <li>Para cada aba que deseja criar na janela com múltiplas visualizações, crie uma classe que implemente <tt><a href="http://bits.netbeans.org/dev/javadoc/org-netbeans-core-multiview/org/netbeans/core/spi/multiview/MultiViewDescription.html">MultiViewDescription</a></tt> e <tt>Serializable</tt>.<p>Para os propósitos deste tutorial, comece por criar uma classe denominada <tt>AbcMultiviewDescription1</tt>, implementando as classes especificadas:</p>
|
| <pre>public class AbcMultiviewDescription1 implements MultiViewDescription, Serializable {
|
|
|
| public int getPersistenceType() {
|
| throw new UnsupportedOperationException("Not supported yet.");
|
| }
|
|
|
| public String getDisplayName() {
|
| throw new UnsupportedOperationException("Not supported yet.");
|
| }
|
|
|
| public Image getIcon() {
|
| throw new UnsupportedOperationException("Not supported yet.");
|
| }
|
|
|
| public HelpCtx getHelpCtx() {
|
| throw new UnsupportedOperationException("Not supported yet.");
|
| }
|
|
|
| public String preferredID() {
|
| throw new UnsupportedOperationException("Not supported yet.");
|
| }
|
|
|
| public MultiViewElement createElement() {
|
| throw new UnsupportedOperationException("Not supported yet.");
|
| }
|
|
|
| }</pre>
|
|
|
| <p class="tips">Na classe <tt>AbcMultiviewDescription1</tt> acima, o método <tt>createElement()</tt> retorna um MultiViewElement. O que você deseja retornar aqui é seu <tt>TopComponent</tt>, o que faremos na próxima etapa.</p></li>
|
|
|
| <li>Reescreva a assinatura da classe. Para fornecer um elemento de múltiplas visualizações para a descrição na etapa anterior, precisamos implementar <tt><a href="http://bits.netbeans.org/dev/javadoc/org-netbeans-core-multiview/org/netbeans/core/spi/multiview/MultiViewElement.html">MultiViewElement</a></tt>:
|
|
|
| <pre>public final class AbcTopComponent extends TopComponent implements MultiViewElement {</pre>
|
|
|
| <p>Na <tt>TopComponent</tt>, você agora precisa excluir (colocar um comentário) os métodos <tt>findInstance()</tt>, <tt>getPersistenceType()</tt>, <tt>writeReplace()</tt> e <tt>preferredID()</tt>.</p></li>
|
|
|
| <li>Para o momento, forneça implementações bem simples para cada um dos métodos necessários. Comece por definir uma nova <tt>JToolbar</tt> acima da classe <tt>TopComponent</tt>:
|
|
|
| <pre>private JToolBar toolbar = new JToolBar();</pre>
|
|
|
| <p>A seguir, implemente os métodos como segue:</p>
|
|
|
| <pre> public JComponent getVisualRepresentation() {
|
| return this;
|
| }
|
|
|
| public JComponent getToolbarRepresentation() {
|
| return toolbar;
|
| }
|
|
|
| public void setMultiViewCallback(MultiViewElementCallback arg0) {
|
| }
|
|
|
| public CloseOperationState canCloseElement() {
|
| return null;
|
| }
|
|
|
| public Action[] getActions() {
|
| return new Action[]{};
|
| }
|
|
|
| public Lookup getLookup() {
|
| return Lookups.singleton(this);
|
| }
|
|
|
| public void componentShowing() {
|
| }
|
|
|
| public void componentHidden() {
|
| }
|
|
|
| public void componentActivated() {
|
| }
|
|
|
| public void componentDeactivated() {
|
| }
|
|
|
| public UndoRedo getUndoRedo() {
|
| return UndoRedo.NONE;
|
| }</pre></li>
|
|
|
| <li>Agora você pode redefinir a <tt>AbcMultiviewDescription1</tt> como segue:
|
|
|
| <pre>public class AbcMultiviewDescription1 implements MultiViewDescription, Serializable {
|
|
|
| public int getPersistenceType() {
|
| return TopComponent.PERSISTENCE_ALWAYS;
|
| }
|
|
|
| public String getDisplayName() {
|
| return "Tab 1";
|
| }
|
|
|
| public Image getIcon() {
|
| return ImageUtilities.loadImage("/org/myorg/abcfiletype/Datasource.gif");
|
| }
|
|
|
| public HelpCtx getHelpCtx() {
|
| return null;
|
| }
|
|
|
| public String preferredID() {
|
| return "AbcMultiviewDescription1";
|
| }
|
|
|
| public MultiViewElement createElement() {
|
| return new AbcTopComponent();
|
| }
|
|
|
| }</pre></li>
|
|
|
| <li>Altere o método <tt>createCloneableTopComponent</tt> na classe <tt>OpenSupport</tt> para abrir seu <tt>TopComponent</tt> através da classe <tt>MultiViewDescription</tt> acima criada:
|
|
|
| <pre>protected CloneableTopComponent createCloneableTopComponent() {
|
|
|
| // Create an array of multiview descriptors:
|
| AbcMultiviewDescription1 firstTab = new AbcMultiviewDescription1();
|
| MultiViewDescription[] descriptionArray = { firstTab };
|
|
|
| // Create the multiview window:
|
| CloneableTopComponent tc = MultiViewFactory.createCloneableMultiView(descriptionArray, firstTab, null);
|
| tc.setDisplayName(entry.getDataObject().getName());
|
| return tc;
|
|
|
| }</pre>
|
|
|
|
|
| <p class="tips">O segundo argumento em <tt>MultiViewFactory.createCloneableMultiView</tt> determina quais abas são abertas por padrão. Aqui está a <tt>firstTab</tt>, a aba definida por <tt>AbcMultiViewDescription1</tt>.</p></li>
|
|
|
| <li>Instale e abra novamente o arquivo. Agora você tem uma janela com múltiplas visualizações com uma aba:
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-mvdeployed.png" alt="múltipla visualização implementada" /></p></li>
|
|
|
| </ol>
|
|
|
| <p>Agora você tem uma aba única em uma janela com múltiplas visualizações. Para cada aba adicional, crie uma nova classe <tt>MultiviewDescription</tt> com um novo <tt>TopComponent</tt>, e, em seguida, crie a instância da classe <tt>MultiViewDescription</tt> na extensão <tt>OpenSupport</tt> , como mostrado acima.</p>
|
|
|
| </div>
|
|
|
|
|
| <!-- ======================================================================================= -->
|
|
|
| <h2><a name="share"></a>Criando um binário de módulo compartilhável</h2>
|
|
|
| <p>Agora que o módulo está concluído, você pode permitir que ele seja utilizado por outras pessoas. Para isso, você precisa criar um arquivo "NBM" (módulo NetBeans) binário e distribuí-lo.</p>
|
|
|
| <div class="indent">
|
|
|
| <ol>
|
| <li>Na janela Projetos, clique com o botão direito do mouse no projeto <tt>Tipo de arquivo Abc</tt> e escolha Criar NBM.
|
|
|
| <p>O arquivo NBM é criado e você pode visualizá-lo na janela Arquivos (Ctrl+-2):</p>
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/60-shareable-nbm.png" alt="NBM que pode ser compartilhado." /></p></li>
|
| <li>Disponibilize-o para outras pessoas, por exemplo, através do <a href="http://plugins.netbeans.org/PluginPortal/">Portal plug-in do NetBeans</a>. O destinatário deve utilizar o Gerenciador de plug-ins (Ferramentas > Plug-ins) para instalá-lo.</li>
|
| </ol>
|
|
|
| </div>
|
|
|
|
|
| <!-- ======================================================================================== -->
|
|
|
|
|
| <br>
|
| <div class="feedback-box"><a href="https://netbeans.org/about/contact_form.html?to=3&subject=Feedback:%20File%20Type%20Module%20Tutorial">Envie-nos seus comentários</a></div>
|
| <br style="clear:both;" />
|
|
|
|
|
| <!-- ======================================================================================== -->
|
|
|
| <h2><a name="nextsteps"></a>Próximas etapas</h2>
|
|
|
| <p>Para obter mais informações sobre a criação e o desenvolvimento de módulos do NetBeans, consulte os seguintes recursos:
|
| <ul>
|
| <li><a href="https://platform.netbeans.org/index.html">Página inicial da Plataforma NetBeans </a></li>
|
| <li><a href="https://netbeans.org/download/dev/javadoc/">Lista de APIs do NetBeans (Versão de desenvolvimento atual)</a></li>
|
| <li><a href="https://netbeans.org/kb/trails/platform_pt_BR.html">Outros tutoriais relacionados</a></li></ul>
|
| </p>
|
|
|
| <!-- ======================================================================================== -->
|
| <!--
|
| <h2><a name="version"></a>Versioning </h2>
|
|
|
| <p>
|
|
|
| <table width="76%" >
|
| <tbody>
|
| <tr>
|
| <td>
|
| <div align="left"><b>Version</b></div>
|
| </td>
|
| <td>
|
| <div align="left"><b>Date</b></div>
|
| </td>
|
| <td>
|
| <div align="left"><b>Changes</b></div>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 1
|
| </td>
|
| <td>
|
| 25 August 2005
|
| </td>
|
| <td>
|
| <ul><li>Initial version.
|
| <li>To do:
|
| <ul><li>Add post-creation customizations (i.e., the "Extending Support for the New File Type" section).
|
| <li>Explain what the generated files are for (placeholders currently).
|
| <li>Explain the layer file's entries.
|
| <li>Explain the first File Type panel (placeholders currently).
|
| <li>Maybe create a separate tutorial for recognizing XML files.</ul></ul>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 2
|
| </td>
|
| <td>
|
| 23 September 2005
|
| </td>
|
| <td>
|
| <ul><li>A lot of info added from the FAQ and added the Action wizard and System Filesystem Browser.
|
| <li>To do:
|
| <ul><li>Explain <tt>LoaderBeanInfo.java</tt> and <tt>Resolver.xml</tt> (one line each)
|
| <li>Maybe create a separate tutorial for recognizing XML files.
|
| <li>Using Tomcat GIF maybe not good idea.
|
| <li>Maybe the action should do something useful.
|
| <li>Maybe direct links to FAQ not good idea.
|
| <li>Probably more needed on <tt>layer.xml</tt> file.
|
| <li>Maybe other useful apisupport functionality could be added to this scenario.
|
| <li>More info needed on MIME types.
|
| <li>The introductory paragraphs should be illustrated with a graphic. A diagram to
|
| show relationship between node, dataobject, fileobject, dataloader, etc.</ul></ul>
|
| </td>
|
| </tr>
|
|
|
| <tr>
|
| <td>
|
| 3
|
| </td>
|
| <td>
|
| 28 September 2005
|
| </td>
|
| <td>
|
| <ul><li>Integrated comments from Jesse Glick.
|
| <li>To do:
|
| <ul> <li>More info needed on MIME types.
|
| <li>The introductory paragraphs should be illustrated with a graphic. A diagram to
|
| show relationship between node, dataobject, fileobject, dataloader, etc.
|
| <li>Many Javadoc links to be added (also for <tt>performAction</tt>.
|
| <li>Info on cookies, cookie actions, cookie classes needed.
|
| <li>Action ended up in text-html even though I chose my own mime type.
|
| <li>Need to explain or link to explanation for instance, shadow, etc.
|
| <li>Platform Manager needs to be mentioned in the context of installing
|
| in target platform.
|
| <li>Show how to add properties to the property sheet.</ul></ul>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 4
|
| </td>
|
| <td>
|
| 4 October 2005
|
| </td>
|
| <td>
|
| <ul><li>Added two diagrams in the introductory paragraphs, from Tim Boudreau's JavaOne presentation.
|
| <li>To do:
|
| <ul> <li>More info needed on MIME types.
|
| <li>Many Javadoc links to be added (also for <tt>performAction</tt>).
|
| <li>Need to create section near the start: "Related FAQs":
|
| <ul><li>Info on cookies, cookie actions, cookie classes needed.
|
| <li>Need to explain or link to explanation for instance, shadow, etc.
|
| <li>DataLoader, DataObject, etc.</ul>
|
| <li>Platform Manager needs to be mentioned in the context of installing
|
| in target platform.
|
| <li>Show how to add properties to the property sheet.
|
| <li>Mention the dummy template that you get, how to modify it,
|
| and how to set the description in the New File wizard.</ul></ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 4
|
| </td>
|
| <td>
|
| 4 November 2005
|
| </td>
|
| <td>
|
| <ul><li>Added downloadable source code, new 'Installing the Sample' section, and link to
|
| Syntax Highlighting tutorial at the end.
|
| <li>To do:
|
| <ul> <li>Same items as on 4 October still to be done.</ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 5
|
| </td>
|
| <td>
|
| 29 November 2005
|
| </td>
|
| <td>
|
| <ul><li>Added links to brand new Component Palette tutorial.
|
| <li>To do:
|
| <ul> <li>Same items as on 4 October still to be done.</ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 6
|
| </td>
|
| <td>
|
| 21 April 2006
|
| </td>
|
| <td>
|
| <ul><li>Changed the title from "DataLoader Module Tutorial" to "Recognizing a File Type Tutorial".
|
| <li>To do:
|
| <ul> <li>Same items as on 4 October still to be done.</ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 7
|
| </td>
|
| <td>
|
| 17 November 2007
|
| </td>
|
| <td>
|
| <ul><li>Updated the whole tutorial to 6.0, replaced all screenshots, and
|
| now [because the 6.0 IDE already provides support for manifest files], the
|
| tutorial focuses on imaginary Abc files.
|
| <li>To do:
|
| <ul> <li>Need to replace the download, which is the same as before, dealing with manifest files.
|
| <li>Same items as on 4 October still to be done.
|
| <li>Added OpenSupport into TopComponent, with a reference to Visual Library.</ul>
|
| <li>Changed title to File Type Integration Tutorial
|
| <li>Tweaked several places throughout tutorial, for 6.0
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 8
|
| </td>
|
| <td>
|
| 15 April 2008
|
| </td>
|
| <td>
|
| Updated the styles (badge, table of contents, required software table)
|
| to the new format.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 9
|
| </td>
|
| <td>
|
| 16 July 2008
|
| </td>
|
| <td>
|
| Created new version for 6.5, because of changes to the
|
| way file type recognition is done in that release. To do:
|
| <ul>
|
| <li>6.5-specific badge
|
| <li>Required software table
|
| <li>Search for DataNode, BeanInfo, DataLoader and reword
|
| <li>Check screenshots
|
| <li>Make sure all the sections work as before
|
| </ul>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 10
|
| </td>
|
| <td>
|
| 4 April 2009
|
| </td>
|
| <td>
|
| Worked through everything and added the multiview section.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 11
|
| </td>
|
| <td>
|
| 9 Feb 2010
|
| </td>
|
| <td>
|
| Changed JPanel to TopComponent in multiview section.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 12
|
| </td>
|
| <td>
|
| 10 Feb 2010
|
| </td>
|
| <td>
|
| Added links to javadoc for the MultiView classes.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 13
|
| </td>
|
| <td>
|
| 18 Feb 2010
|
| </td>
|
| <td>
|
| Added style for borders and fixed action instructions.
|
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| -->
|
| </body>
|
| </html>
|
