#topicpath ---- //ここにコンテンツを記述します。 ***このサイト内の、Eclipseプラグイン開発のコンテンツ一覧 [#u25b59e3] #ls2 ---- ***目次 [#l0d087c0] #contents **とりあえずやってみる [#k6a964ed] JavaWorldの2004年3月号に特集されていたので、Eclipseのプラグイン開発ツールを触ってみました。 Eclipseはこのプラグインの固まりで、すべての機能はプラグインで作成されているみたいです。ようするにEclipseを機能拡張したい場合はこのプラグインという作法に則って作成するわけですね。 まだ全然やり方がわかりません。とりあえずView(パースペクティブ内の一つのタイルのこと)を拡張して、選択しているファイルのファイル名を表示するプラグインを作成しています。 一番簡単なやり方は - プラグイン開発 >> プラグイン・プロジェクト >> プロジェクト名~ (プロジェクト名はたとえばnu.mine.kino.sampleとか) -プラグイン・コード生成プログラム >> デフォルト・プラグイン構造~ (何も追加しない単純なテンプレート) 後はすべてデフォルトでOKでよいです。ウィザードが完了すると、単純なプラグイン・プロジェクトの作成完了です。 基本的な構成はできたので、次はプラグインファイル(plugin.xml)の記述です。手順は -プラグインエディタの拡張タブ >> 追加 >> 汎用ウィザード >> スキーマベースの拡張 -拡張ポイントを org.eclipse.ui.views を選択 -プラグインエディタの拡張タブより、org.eclipse.ui.viewsを右クリック >> 新規 >> Category を追加(Viewを属させるグループの作成) -さらに拡張タブより、org.eclipse.ui.viewsを右クリック >> 新規 >> View を追加(実際のViewの作成) とするとViewを追加できます。後はプロパティViewより必要事項を入力します。 ただのビューを表示するだけなら <extension point="org.eclipse.ui.views"> <category name="サンプルMyView" <- viewが属するカテゴリ名 id="com.samples.myview"> <- カテゴリのID </category> <view name="シンプルView" <- viewのバーのタイトル category="com.samples.myview" <- viewが属するカテゴリID class="com.samples.myview.SimpleView" <- viewを実装するクラス名 id="com.samples.myview.simpleview"> <- viewのID </view> </extension> で十分です。プロパティViewよりclassを選択すると対応するクラス(ここではcom.samples.myview.SimpleView)のスケルトンもウィザードが作ってくれます。 **覚え書き [#j62d232a] ***サンプルのダウンロード [#w152c277] ヘルプに リッチ・クライアント・プラットフォーム・アプリケーションのビルド という項目があったので、見てみるとサンプルがEclipseのCVS :pserver:anonymous@dev.eclipse.org:/home/eclipse からダウンロード可能とのこと。 *** アクティブなエディタへの参照の取得 [#uf7ea3d1] // ワークベンチの取得 IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchWindow window = workbench.getActiveWorkbenchWindow(); //アクティブなエディタの取得 IEditorPart editor = window.getActivePage().getActiveEditor(); AbstractTextEditor aEditor = (AbstractTextEditor) editor; *** エディタ内のドキュメントを取得 [#o1b1fa35] IDocument document = aEditor.getDocumentProvider().getDocument(editor.getEditorInput()); ***プラグインのディレクトリを取得する(2.0系) [#rf1a32e3] Log4jの初期化のためにlog4j.xmlを読み込むなど、プラグインディレクトリのパスを取得する場面は結構ありますが、その方法です。 String pluginDirectory = Platform .resolve(getDefault().getDescriptor().getInstallURL()).getPath(); で取得できます。 ちなみにLog4jの初期化などはAbstractUIPluginのサブクラス(勝手に作られるヤツ)で public void startup() throws CoreException { super.startup(); String pluginDirectory = null; try { pluginDirectory = Platform .resolve(getDefault().getDescriptor().getInstallURL()) .getPath(); } catch (IOException e) { e.printStackTrace(); } DOMConfigurator.configure(new File(pluginDirectory, "lib/log4j.xml").toString()); } などとstartup()をOverrideすればよいでしょうか。 ***プラグインのディレクトリを取得する(3.0系) [#ae45800c] Eclipse3.0から上のやり方は deprecated になりました。2.0で String pluginDirectory = Platform .resolve(getDefault().getDescriptor().getInstallURL()).getPath(); だったのを3.0では URL entry = getDefault().getBundle().getEntry("/"); String pluginDirectory = Platform.resolve(entry).getPath(); と書き換えます。 http://www3.vis.ne.jp/~asaki/p_diary/diary.cgi?Date=2004-09-05 ***外部のライブラリを使用する [#dc5c9f14] プラグインディレクトリにlibディレクトリなどを作成しておいて、plugin.xmlで <runtime> <library name="hoge.jar"/> <library name="lib/fuga.jar"/> <-外部ライブラリ </runtime> とすればOKです。 *** プロジェクトへの参照を取得する [#u15a6a98] いわゆるEclipseのプロジェクトへの参照を取得する方法です。 IWorkspaceRoot myWorkspaceRoot = ResourcesPlugin.getWorkspace().getRoot(); IProject project = myWorkspaceRoot.getProject([プロジェクト名の文字列]); ***ポップアップメニューの拡張 [#sfc14d79] <extension point="org.eclipse.ui.popupMenus"> <objectContribution objectClass="org.eclipse.core.resources.IResource" <- ファイルとか、フォルダだったら表示 objectClass="org.eclipse.jdt.core.ICompilationUnit" <- いわゆるソースファイルだったら objectClass="org.eclipse.core.resources.IFile" <- ファイルだったら表示 objectClass="org.eclipse.core.resources.IFolder" <- フォルダだったら表示 id="nu.mine.kino.IResource"> <action label="スクリプト生成(&R)" class="nu.mine.kino.HogeAction" menubarPath="additions" <- すでにあるメニューに追加 enablesFor="1" <- 選択したファイルが1つだけの時有効 id="nu.mine.kino.HogeAction"> </action> </objectContribution> </extension> ***デバッグするためのダイアログを出したい [#a91aa3cd] IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchWindow window = workbench.getActiveWorkbenchWindow(); Shell shell = window.getShell(); MessageDialog.openInformation(shell, "タイトル","メッセージ"); が定番でしょう。windowオブジェクトはメソッドを記述するクラスによってはフィールドから得られたりしますが。。 ***ウィンドウに配置されているViewを取得する。 [#z76cff34] IWorkbenchPage page = workbench.getActiveWorkbenchWindow().getActivePage(); IViewReference[] references = page.getViewReferences(); for (int i = 0; i < references.length; i++) { IViewPart view = references[i].getView(false); <- Viewへの参照が取得できました MessageDialog.openInformation(window.getShell(), "ViewのtoString()", view.toString()); } ***ウィンドウに配置されているViewを、ID指定で取得する。 [#i39484e4] IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchPage workbenchPage = workbench .getActiveWorkbenchWindow().getActivePage(); //IWorkbenchPage workbenchPage = editor.getSite().getPage(); try { HogeView view = (HogeView) workbenchPage.showView("HogeViewのID"); } catch (PartInitException e) { } ***おなじViewを複数開く [#t81ac22d] Eclipse3.0から(だと思う)同じウィンドウを複数開くことができるようです。 IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchPage workbenchPage = workbench .getActiveWorkbenchWindow().getActivePage(); try { HogeView view = (HogeView) workbenchPage .showView("HogeViewのID", "HogeViewの別のID(Uniqueならよい?)", IWorkbenchPage.VIEW_ACTIVATE); } catch (PartInitException e) { } http://d.hatena.ne.jp/muimy/20040804 から情報をいただきました。 ***プラグインのパッケージング手順 [#i4b96068] -build.propertiesに、パッケージしたいものを記述する(bin.includesにlib/hoge.jarとかicons/*とか) -plugin.xmlの右クリック >> Antビルドファイルの作成 でbuild.xml作成 -javac要素はソースコードのエンコーディングが考慮されてないので、追加(encoding="EUC-JP"など)。 -ant zip.pluginでZIPが作成される。 -完了。 トラブル(↓メモ書き状態) -plugin.xmlの右クリック>>Antビルドファイルの作成 は、コンパイルのエンコーディングが考慮されない(encoding="EUC-JP"などを追加する必要あり) -build.propertiesに、パッケージしたいものを記述する(bin.includesに書く) ***パッケージ化するとインスタンスを生成できない。 [#kecb2ad7] [[パッケージ化するとインスタンスを生成できない。:http://groups.yahoo.co.jp/group/eclipse-ml/message/1019?expand=1]] 私も同じトラブルに遭遇しました。 プラグインをパッケージングすると、何故かエラーになってしまうというもの。ビューを開こうとすると インスタンスを生成できませんでした。 と言われてしまうんだけど、エラーを調べようにもどこにエラーが表示されているのかも分からないので困っていました。 そこでネットを探していたところ、同じような内容の投稿が。とりあえずこれを見て、プラグインのログは -ウィンドウ→ビューの表示→その他→PDEランタイム→エラー・ログ で「エラーログビュー」を開く。 -エラーログビューで、該当エラーをダブルクリックし「エラーのプロパティー」を開く。 -「状況詳細」を選択します(状況詳細はない場合もあります)。→ここにStackTraceなどが表示されます。 というところまで分かりました。感謝!! そのエラーログを見ると、xml関連のライブラリがないと。どうもプラグインをパッケージした場合と、ランタイムワークベンチで稼動しているVMのバージョンの違いが原因でした。((WebSphereStudioはJ2SE1.3だったためだ〜)) plugin.xmlに、 <library name="lib/xercesImpl.jar"/> <library name="lib/xml-apis.jar"/> を追加して、ようやく動きました。疲れた...。。。 ***プラグインがロードされるタイミング [#lf696913] http://www-6.ibm.com/jp/developerworks/opensource/040604/j_os-ecspy1.html ***拡張ポイントクラス(IExtension)から、そのクラスローダでメソッドを実行する [#ncca9c7b] -2.1バージョン // IExtensionからそれが宣言されているプラグインをIPluginDescriptorとして取り出す。 IPluginDescriptor descriptor = extension.getDeclaringPluginDescriptor(); // そのプラグイン用のクラスローダを取得。 ClassLoader classLoader = descriptor.getPluginClassLoader(); DOMConfigurator configurator = (DOMConfigurator) classLoader .loadClass("org.apache.log4j.xml.DOMConfigurator") .newInstance(); -3.0バージョン String namespace = extension.getNamespace(); Bundle bundleOfExtension = Platform.getBundle(namespace); DOMConfigurator configurator = (DOMConfigurator) bundleOfExtension .loadClass("org.apache.log4j.xml.DOMConfigurator") .newInstance(); ***プラグインクラスに定義しておきたいメソッド [#bf1fd810] ○○Pluginなど、プラグインクラスにはそのプラグインでやりたいビジネスロジックや、ログ出力などのロジックを記述します。ログ出力に関するメソッドはだいたい以下のようなメソッドを定義しておけばよいでしょう。 public static void log(String message, Exception e) { IStatus status = new Status(IStatus.ERROR, getPluginId(), IStatus.ERROR, message, e); getDefault().getLog().log(status); } public static void log(String message) { log(message, null); } public static void log(Exception e) { StringWriter stringWriter = new StringWriter(); e.printStackTrace(new PrintWriter(stringWriter)); String message = stringWriter.getBuffer().toString(); log(message, e); } public static String getPluginId() { return getDefault().getBundle().getSymbolicName(); } ***リファクタリング >> ストリングの外部化 [#m6e7d7f7] Eclipse自体のTIPSですが、メモメモ。 Eclipseはハードコーディングされた文字列を外部ファイル(*.properties)に外出しするリファクタリングをすることができます。で、それをやるとStringの一覧のダイアログが出るんですけど、なんかわかりにくかったんでまとめておきます。各チェックの意味は以下の通り。 |チェック|Externalize|外部化して、//$NON-NLS-1$ をつける| |×|Ignore|以後無視するよう、//$NON-NLS-1$ をつける| |×'|Internalize|//$NON-NLS-1$ をはずすもしくはなにもしない| *** Viewerにポップアップメニューをつける。 [#w21d509e] 下記のメソッドをcreatePartControl(Composite parent)で実行する private void hookContextMenu() { MenuManager menuMgr = new MenuManager("#PopupMenu"); //$NON-NLS-1$ menuMgr.setRemoveAllWhenShown(true); menuMgr.addMenuListener(new IMenuListener() { public void menuAboutToShow(IMenuManager manager) { fillContextMenu(manager); } }); Menu menu = menuMgr.createContextMenu(viewer.getControl()); viewer.getControl().setMenu(menu); getSite().registerContextMenu(menuMgr, viewer); // getSite().registerContextMenu("hogeID",menuMgr, viewer); // ↑別のIDをつける場合(ここではhogeID) } private void fillContextMenu(IMenuManager manager) { manager.add(action1); // Other plug-ins can contribute there actions here manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS)); manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS + "-end")); } これで、ポップアップの追加・他のプラグインへの公開の準備ができたことになります。 ***他のプラグインから、既存のビューのポップアップにアクションを追加する。 [#m473b99d] 上で、 getSite().registerContextMenu(menuMgr, viewer); manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS)); としたことで、 -このビューのポップアップはmenuMgrですよ -ポップアップに追加するときに指定するtargetIDはビューのIDですよ((もしくはgetSite().registerContextMenu("hogeID",menuMgr, viewer);とやってIDを指定できる。)) -menubarPathはIWorkbenchActionConstants.MB_ADDITIONSという文字列(("additions"という文字列))ですよ という事になります。ここまでできてると別のプラグインからこのビューのポップアップにアクションを追加することができます。追加するにはplugin.xmlで以下のように宣言すればOKです。 <viewerContribution targetID="hoge" id="nu.mine.kino.plugin.samples.viewerContribution2"> <action label="追加したアクション" class="nu.mine.kino.plugin.samples.Action4" ↑ IViewActionDelegateの実装クラス menubarPath="additions" ↑ additionsは IWorkbenchActionConstants.MB_ADDITIONSの文字列 id="nu.mine.kino.plugin.samples.action4"/> </viewerContribution> **[[Eclipseプラグイン開発:http://yoichiro.cocolog-nifty.com/eclipse/]] [#yd461a90] #showrss(http://yoichiro.cocolog-nifty.com/eclipse/index.rdf,,24,1) ---- この記事は #vote(おもしろかった[9],そうでもない[1]) #comment #topicpath SIZE(10){現在のアクセス:&counter;}