Netbeans用のプラグインを作成しています。 パート1

状況を想像してください。開発環境でプログラミングを行っており、エディターから小さなコードを送信する誰かが必要です。 目的のピースを選択してコピーし、ブラウザを開いて、ペーストビンに移動し、コードを貼り付け、リンクをコピーして、宛先に送信します。 これらのアクションを半分にするとどうなりますか？

Netbeans用のPB4NBプラグインがありますが、pastebinのAPIの変更により機能しません。 そのため、独自のプラグインを作成し、好みに合わせて構成すると同時に、Netbeansプラットフォームを少し扱います。 に興味がありますか？ 猫へようこそ。

準備する

Netbeansのプラグインを作成するには、最初に開発モジュールをアクティブにする必要があります。 これを行うには、メニューの「ツール->プラグイン」に進み、「インストール済み」タブで「Netbeansの開発」を有効にします。 次に、Netbeansプラットフォームのドキュメントが必要になります。 これは、Available Pluginsタブでプラグインとして利用でき、Netbeans APIドキュメントと呼ばれます。 おそらくそれだけです。

プロジェクト作成

新しいプロジェクトを作成し（「ファイル->新規プロジェクト-> Netbeansモジュール->モジュール」）、「次へ」をクリックします。

「プロジェクト名」フィールドに目的の名前を入力し、「ペーストビン」にして「次へ」をクリックします。

「コード名ベース」フィールドに入力します。「com.pastebin.pastebinplugin」とします-これはプラグインのコード名とリソースおよびクラスへのパスの両方になります。 「モジュール表示名」フィールドは、プロジェクト内のプラグインの表示名を設定します。「Pastebin.comに送信」として入力しますが、そこに独自の名前を入力できます。 残りのフィールドは触れないで、「完了」をクリックします。

新しいプロジェクトが作成され、その構造はこの形式になっています。

アクション作成

次に、プラグイン自体の作成、つまりアクションのクラスに直接進みます。 「新規」->「その他」->「モジュール開発」で「アクション」を選択し、「次へ」をクリックします。





アクションのタイプを選択するように求められます：「継続的に有効化」または「提供された有効化」。 選択したコードをエディターから取得するため、つまりコードエディターが開いているときにのみプラグインをアクティブにする必要があるため、2番目のタイプ「Conditionally Enabled」を選択します。 「Cookieクラス」に「EditorCookie」を配置しました。プロジェクト全体ではなく、エディターへのアクセスが必要なためです。 EditorCookieをサポートするサイトを少なくとも1つ開くときにプラグインが使用可能である必要があるため、「User Selects One Node」は選択されたままです。 「次へ」をクリックします。



次のステップでは、プラグインのGUIを登録します。 つまり、Netbeansウィンドウ内の場所です。 任意のメニュー、ツールバー、およびコンテキストメニューで使用可能な場所。 まず、カテゴリを設定しましょう。 提案されたリストから、「編集」と「ソース」が私たちに最も適しています。最も好きなものを選択し、最初に選択しました。 次に、プラグインを呼び出すのが最も簡単になる方法について考える必要があります。 個人的には、常に目の前にパネルにアイコンが表示されたくないので、[編集]メニューの[貼り付け]アイテムの直後にアイテムを追加しました。 パネルのアイコンをクリックしてプラグインを起動する方が便利な場合は、「グローバルツールバーボタン」の前にチェックマークを付けて、便利な場所を選択します。 すべてを味わうように構成したら、次の手順に進みます。



クラス名には「PastebinAction」が入力されます。 これはメニュー項目の表示名であるため、たとえば「pastebin.comに送信」など、「表示名」をできるだけ明確に入力することをお勧めします。 次に、16x16アイコンを選択します。 前の手順でツールバーの場所を選択した場合、24x24のサイズのアイコンを追加する必要があります。 その後、「完了」をクリックします。



これらの設定はすべて、生成されたコードに表示されます。

@ActionID( category = "Edit", id = "com.pastebin.pastebinplugin.PastebinAction") @ActionRegistration( iconBase = "com/pastebin/pastebinplugin/pastebin.png", displayName = "#CTL_PastebinAction") @ActionReference(path = "Menu/Edit", position = 1250) @Messages("CTL_PastebinAction=Send to pastebin.com")
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最初の打ち上げ

まだ何も書いていませんが、検証のためにプラグインを実行することはすでに可能です。 「実行」をクリックして、新しいNetbeansウィンドウが表示されるのを待ちます。 その後、任意のテキストファイルを開き、同様の画像を確認します。



不明な理由により、新しいNetbeansウィンドウはロシア語のローカライズから始まりましたが、問題ではありません。すぐにプラグインにロシア語を教えますが、今のところ、ウィンドウを閉じて、最終的にコードを書き始めます

ルーチン

プラグインの実行はactionPerformedメソッドで始まると推測しやすいため、このメソッドの本体にコードを記述します。 まずは、IDE自体が提供するEditorCookieを試してみましょう。 ただし、その前に必要なライブラリを追加します。そうしないと、後続のコードがコンパイルされません。

プロジェクトのプロパティで、「ライブラリ」タブを選択し、「追加」をクリックします。

「Nodes API」と「Editor」を追加します。

次のコードを書きましょう。

 public void actionPerformed(ActionEvent ev) { try { JEditorPane pane = context.getOpenedPanes()[0]; pane.setText("// Hello, editor pane!\n"+pane.getText()); context.openDocument().insertString(0, "// Hello, document!\n", null); } catch (Exception ex) { Exceptions.printStackTrace(ex); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコードは、プラグインが呼び出されると、オープンソーステキストに数行を追加します。 これは、JEditorPaneとStyledDocumentの2つの異なる方法で行われます。

プロジェクトを起動し、ファイルを開いてプラグインを呼び出すと、2行が追加されたことがわかります。

//こんにちは、ドキュメント！

//こんにちは、エディタペイン！



さて、プラグイン自体の作成を続けましょう。 pastebinで構文の強調表示を正しく構成できるように、編集したソースの形式だけでなく、テキストの選択した部分を取得する必要があります。 最初のメソッドであるJEditorPaneを使用します。これには、必要なすべてのメソッドが含まれているためです。 編集中のドキュメントのMIMEタイプに基づいて、構文強調表示形式を取得します。

 public void actionPerformed(ActionEvent ev) { JEditorPane currentPane = context.getOpenedPanes()[0]; final String mimeType = NbEditorUtilities.getMimeType(currentPane); final String code = getSelectedText(currentPane); System.out.println(mimeType + "\n" + code); } private String getSelectedText(JEditorPane currentPane) { String text = currentPane.getSelectedText(); if (text == null) return currentPane.getText(); return text; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

プロジェクトを実行し、コードの一部を選択し、プラグインを実行して、コンソールで結果を確認します。 次に、プラグインを実行するために何も強調表示しないでください-ソースコード全体がコンソールに表示されます。 後者の機能は、コードを完全に送信しなければならない場合があるため、便利なように思えました。



したがって、コードとそのMIMEタイプを手元に置いて、クライアントの作成を開始できます。 ここで、Pastebin APIのヘルプを取得し、開発者キーを見つけることができます。

コード： PastebinRequest 、 PastebinSender 。

フィールドを追加します。

プライベートの最終PastebinRequestリクエスト。

そして、コンストラクターで初期化します。

request = new PastebinRequest（）;

次に、actionPerformedメソッドを更新します。

 JEditorPane currentPane = context.getOpenedPanes()[0]; final String mimeType = NbEditorUtilities.getMimeType(currentPane); final String code = getSelectedText(currentPane); if (code != null) { RequestProcessor.getDefault().execute(new Runnable() { @Override public void run() { setupRequest(code, mimeType); String pastedUrl = PastebinSender.sendRequest(request.getRequestMessage()); System.out.println(pastedUrl); } }); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ニーズに合わせてsetupRequestメソッドを構成しましたが、自分でパラメーターを変更できます。

 private void setupRequest(String code, String mimeType) { request.initRequest(); request.setSourceCode(code); request.setFormat(mimeType); request.setExpireDate(PastebinRequest.EXPIRE_DATE.ONE_DAY); request.setUnlisted(true); request.setName(""); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

開始する前に、ホットキーを追加してアクティブ化することにより、プラグインの呼び出しを単純化しましょう。

次の行を置き換えます。

@ActionReference（パス= "メニュー/編集"、位置= 1250）

に：

@ActionReferences（{

@ActionReference（path = "Menu / Edit"、position = 1250）、

@ActionReference（パス=「ショートカット」、名前=「OS-P」）

}）

この場合、「OS-P」は「Alt + Shift + P」を意味します。 既存のホットキーと競合がない場合、プロジェクトを開始すると、次のように表示されます。





テキストを選択し、指定された組み合わせをクリックして、コンソールに投稿されたコードへのリンクを確認します。 やれやれ、私たちはやった！ このリンクを含むダイアログボックスを表示するだけです。 始めましょう。

新しいクラスを作成し、「UrlDialog」と呼びます。 このクラスのソースコードはこちらです。 PastebinActionクラスにメソッドを追加します。

 private void showUrlDialog(final String pastedUrl) { SwingUtilities.invokeLater(new Runnable() { @Override public void run() { Frame frame = WindowManager.getDefault().getMainWindow(); UrlDialog dialog = new UrlDialog(frame, pastedUrl); dialog.setLocation(frame.getWidth() / 2, frame.getHeight()/2); dialog.setVisible(true); } }); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

actionPerformedメソッドで、次の行を置き換えます。

System.out.println（pastedUrl）;

に：

showUrlDialog（pastedUrl）;

また、プロジェクトのプロパティで別のライブラリを追加する必要があります。このため、「ライブラリ」タブを再度開き、「ウィンドウシステムAPI」を追加します。

最後に、Bundle.propertiesローカライズファイルを開いて、次の行を追加する必要があります。

UrlDialog.title =貼り付けられたURL

UrlDialog.copyButton.text =コピー



これでプロジェクトを開始できます。 コードを選択し、プラグインをアクティブにして、ウィンドウを確認します。



「コピー」ボタンをクリックすると、リンクがクリップボードにコピーされます。 このウィンドウはコピー後すぐに閉じることができます。通常、ウィンドウを表示することはできませんが、すぐにクリップボードにコピーします。 あなたの想像力を示し、あなたが好きなようにしてください。

ローカリゼーション

記事の途中で、プラグインにロシア語を教えることを約束しました。 難しくありません。 PastebinActionクラスの前の最新の注釈を見てください。 行を誇示します：

@Messages（ "CTL_PastebinAction = pastebin.comに送信"）

削除してからBundle.propertiesを開いて、そこに行を追加してください：

CTL_PastebinAction = pastebin.comに送信

次に、プロジェクトブラウザウィンドウで、Bundle.propertiesファイルを右クリックし、「追加->ロケール」を選択します。 事前定義されたローカリゼーションのリストから、ロシア語を選択し、「OK」をクリックします。



新しいファイルが追加され、開いて変更する必要があります。 最初の行は翻訳できません。翻訳しないと、プロジェクトブラウザウィンドウで翻訳され、見た目が悪くなります。

OpenIDE-Module-Name = Pastebin.comに送信

UrlDialog.title =リンク

UrlDialog.copyButton.text =コピー

CTL_PastebinAction = pastebin.comに送信

さて、作業を確認する時間です。 開始して確認します：

NBMモジュールの作成

したがって、最後に行うことは、プラグインをNetbeansに接続することです。 プロジェクトのタイトルを右クリックして、「Create NBM」を選択します。 Netbeansは、「プラグインの追加」をクリックしてnbmファイルを選択することで、「ツール」->「プラグイン」->「ダウンロード」にのみ接続される、わかりやすいファイルにアクティビティの製品を収集します。

まとめ

Netbeans用に独自のプラグインを作成し、自分用にカスタマイズしました。また、Netbeansプラットフォームに少し精通しました。

プロジェクト全体はこちらからダウンロードできます 。



Netbeansプラットフォームに関する情報はあまりありませんが、少なくとも何かを見つけることができるリンクがあります。