Tutorial de integração de tipo de arquivo

1. Na janela Projetos, clique com o botão direito do mouse no projeto Tipo de arquivo Abc e escolha Executar.

Uma nova instância do IDE é iniciada, instalando o módulo nele próprio.

2. Use a caixa de diálogo Novo projeto (Ctrl-Shift-N) para criar qualquer tipo de aplicativo no IDE.
3. 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:



Complete o assistente e assim terá criado um modelo que pode ser usado para iniciar o trabalho do usuário com o tipo de arquivo fornecido.

Caso você deseje fornecer código padrão através do modelo, adicione o código ao arquivo AbcTemplate.abc que o assistente Novo tipo de arquivo criou para você.

Adicionando uma ação

Nesta subseção, usaremos 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 layer.xml 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.

1. Clique com o botão direito do mouse no nó do projeto e escolha Nova > Ação
2. No painel Tipo de ação, clique em Habilitada condicionalmente. Digite AbcDataObject, que é o nome do objeto de dados gerado acima pelo Assistente de novo tipo de arquivo, conforme mostrado abaixo:



Clique em Próximo.

3. 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.

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:



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.

4. No painel Novo e localização, digite MyAction como o Nome da classe e My Action como o Nome de exibição. Os itens de menu fornecidos por menus contextuais não exibem ícones. Assim, clique em Terminar e MyAction.java será adicionado ao pacote org.myorg.abcfiletype.
5. No Editor de código-fonte, adicione código ao método performAction da ação:

   protected void performAction(Node[] activatedNodes) {
   	AbcDataObject abcDataObject = activatedNodes[0].getLookup().lookup(AbcDataObject.class);
   	FileObject f = abcDataObject.getPrimaryFile();
   	String displayName = FileUtil.getFileDisplayName(f);
   	String msg = "I am " + displayName + ". Hear me roar!"; 
           NotifyDescriptor nd = new NotifyDescriptor.Message(msg);
           DialogDisplayer.getDefault().notify(nd);
   }

   Pressione Ctrl-Shift-I. O IDE automaticamente adiciona comandos import à parte superior da classe.

   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 projeto 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.

   Na classe MyAction.java, pressione Ctrl-Shift-I novamente. O sublinhado vermelho desaparece porque o IDE encontra os pacotes necessários na API das caixas de diálogo.

6. No nó Arquivos importantes, expanda Camada XML. Os dois nós <esta camada> e <esta camada no contexto>, junto com seus subnós, formam o navegador Sistema de arquivos do sistema. Expanda <esta camada>, expanda Carregadores, continue expandindo nós até ver a Ação criada acima.
7. Arraste e solte Minha ação para que ela apareça abaixo da ação Abrir, como mostrado abaixo:



Como você pode ver nas últimas duas etapas, o Navegador Sistema de arquivos do sistema pode ser usado para reorganizar rapidamente a seqüência de itens registrados no sistema de arquivos do sistema.

8. Execute novamente o módulo, como fez na seção anterior.
9. Crie um arquivo ABC, usando 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.

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 layer.xml está disponível do menu contextual de clique com o botão direito do mouse:



10. Escolha o novo item de menu, o nome e a localização do arquivo Abc são mostrados:

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.

Abrindo o arquivo em uma janela

Por 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.

1. 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:



2. Clique em Próximo e digite "Abc" como o prefixo do nome da classe:

   

   Clique em Terminar.

3. Altere DataObject para usar OpenSupport em vez de DataEditorSupport, alterando o construtor de DataObject da seguinte maneira:

public AbcDataObject(FileObject pf, MultiFileLoader loader)
        throws DataObjectExistsException, IOException {

    super(pf, loader);
    CookieSet cookies = getCookieSet();
    //cookies.add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), cookies));
    cookies.add((Node.Cookie) new AbcOpenSupport(getPrimaryEntry()));
              
}

4. Crie a classe OpenSupport:

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;
    }
 
}

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.

Instale o módulo novamente e depois, quando um arquivo Abc estiver aberto, a classe OpenSupport lidará com a abertura de forma que o arquivo seja aberto no TopComponent em vez de abrir no editor básico do DataEditorSupport:

O tutorial do NetBeans Visual Library 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.

Criando uma janela de múltiplas visualizações

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 usada para exibir uma representação visual do arquivo, enquanto a segunda aba normalmente mostra a visualização Código-fonte. Mais do que duas abas podem ser fornecidas, cada uma fornecendo mais níveis de detalhes sobre o arquivo aberto.

1. 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 "Janela com múltiplas visualizações". Clique em OK, em seguida, clique em OK novamente para sair da caixa de diálogo Propriedades do projeto.

2. Para cada aba que deseja criar na janela com múltiplas visualizações, crie uma classe que implemente MultiViewDescription e Serializable.

   Para os propósitos deste tutorial, comece por criar uma classe denominada AbcMultiviewDescription1, implementando as classes especificadas:

   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.");
       }
   
   }

   Na classe AbcMultiviewDescription1 acima, o método createElement() retorna um MultiViewElement. O que você deseja retornar aqui é seu TopComponent, o que faremos na próxima etapa.

3. Reescreva a assinatura da classe. Para fornecer um elemento de múltiplas visualizações para a descrição na etapa anterior, precisamos estender o JPanel ao invés do TopComponent e precisamos implementar a MultiViewElement:

   public final class AbcTopComponent extends JPanel implements MultiViewElement {

Na TopComponent, você agora precisa excluir (colocar um comentário) os métodos findInstance(), getPersistenceType(), writeReplace() e preferredID().

4. Para o momento, forneça implementações bem simples para cada um dos métodos necessários. Comece por definir uma nova JToolbar acima da classe TopComponent:

   private JToolBar toolbar = new JToolBar();

A seguir, implemente os métodos como segue:

    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;
    }

5. Agora você pode redefinir a AbcMultiviewDescription1 como segue:

   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();
       }
   
   }

6. Altere o método createCloneableTopComponent na classe OpenSupport para abrir seu TopComponent através da classe MultiViewDescription acima criada:

   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;
   
   }

   O segundo argumento em MultiViewFactory.createCloneableMultiView determina quais abas são abertas por padrão. Aqui está a firstTab, a aba definida por AbcMultiViewDescription1.

7. Instale abra novamente o arquivo. Agora você tem uma janela com múltiplas visualizações com uma aba:

Agora você tem uma aba única em uma janela com múltiplas visualizações. Para cada aba adicional, crie uma nova classe MultiviewDescription , com um novo JPanel, e a seguir crie a instância da classe MultiViewDescription na extensão OpenSupport , como acima mostrado.

1. Na janela Projetos, clique com o botão direito do mouse no projeto Tipo de arquivo Abc e escolha Criar NBM.

O arquivo NBM é criado e você pode visualizá-lo na janela Arquivos (Ctrl+-2):



2. Disponibilize-o para outras pessoas, por exemplo, através do Portal de plug-in do NetBeans. O destinatário deve usar o Gerenciador de plug-ins (Ferramentas > Plug-ins) para instalá-lo.