org.seasar.uruma.rcp
インタフェース UrumaService

既知の実装クラスの一覧:
MockUrumaService, UrumaServiceImpl

public interface UrumaService

RCP 環境で Uruma が提供するサービスです。

作成者:
y-komori

メソッドの概要
 String createRcpId(String id)
          画面コンポーネントのIDをRCP上のIDに変換します。
 ClassLoader getAppClassLoader()
          Urumaアプリケーションバンドルのクラスローダを返します。
 Bundle getBundle()
          Uruma アプリケーションのバンドルを返します。
 CommandRegistry getCommandRegistry()
          CommandRegistry のインスタンスを返します。
 S2Container getContainer()
          S2Container のインスタンスを返します。
 String getDefaultContextId()
          Uruma アプリケーションのためのデフォルトコンテクスト ID を返します。
 Extension getExtension(String point)
          指定した名前の拡張ポイントを返します。
 List<Extension> getExtensions()
          現在登録されている拡張ポイントのリストを返します。
 ResourceBundle getImageBundle()
          イメージ定義を保持する ResourceBundle を返します。
 String getLocalId(String rcpId)
          RCP上のIDから画面コンポーネントのIDを取得します。
 String getPluginId()
          現在のプラグイン ID を返します。
 Template getTemplate(String path)
          指定されたパスの画面定義XMLを読み込み、Template オブジェクトを生成します。
 ClassLoader getUrumaClassLoader()
          Urumaバンドルのクラスローダを返します。
 List<ViewPartComponent> getViewPartComponent()
          ViewPartComponent のリストを返します。
 IWorkbench getWorkbench()
          IWorkbench のインスタンスを返します。
 WorkbenchComponent getWorkbenchComponent()
          WorkbenchComponent を返します。
 WindowContext getWorkbenchWindowContext()
          ワークベンチウィンドウに対応する WindowContext を返します。
 void restoreClassLoader()
          直前に使用していたクラスローダに切り替えます。
 void switchToAppClassLoader()
          コンテクストクラスローダを Uruma アプリケーションのクラスローダに切り替えます。
 void switchToUrumaClassLoader()
          コンテクストクラスローダを Uruma バンドルのクラスローダに切り替えます。
 

メソッドの詳細

getBundle

Bundle getBundle()
Uruma アプリケーションのバンドルを返します。

戻り値:
Bundle オブジェクト

getPluginId

String getPluginId()
現在のプラグイン ID を返します。

戻り値:
プラグイン ID

createRcpId

String createRcpId(String id)
画面コンポーネントのIDをRCP上のIDに変換します。
RCP上のIDは、画面コンポーネントのIDにサフィックスとしてプラグインIDを追加したものになります。

【例】プラグインID: org.seasar.uruma.example、コンポーネントID: button の場合、本メソッドの戻り値は、 org.seasar.uruma.example.button となります。

パラメータ:
id - 画面コンポーネントのID
戻り値:
RCP上のID

getLocalId

String getLocalId(String rcpId)
RCP上のIDから画面コンポーネントのIDを取得します。

パラメータ:
rcpId - RCP上のID
戻り値:
画面コンポーネントのID
関連項目:
createRcpId(String)

getTemplate

Template getTemplate(String path)
指定されたパスの画面定義XMLを読み込み、Template オブジェクトを生成します。

パラメータ:
path - 画面定義XMLのパス
戻り値:
Template オブジェクト

getWorkbench

IWorkbench getWorkbench()
IWorkbench のインスタンスを返します。

戻り値:
IWorkbench のインスタンス

getWorkbenchComponent

WorkbenchComponent getWorkbenchComponent()
WorkbenchComponent を返します。

戻り値:
WorkbenchComponent オブジェクト

getViewPartComponent

List<ViewPartComponent> getViewPartComponent()
ViewPartComponent のリストを返します。

戻り値:
ViewPartComponent オブジェクト

getExtensions

List<Extension> getExtensions()
現在登録されている拡張ポイントのリストを返します。

戻り値:
拡張ポイントのリスト

getExtension

Extension getExtension(String point)
指定した名前の拡張ポイントを返します。

パラメータ:
point - 拡張ポイントの名称
戻り値:
拡張ポイント。見つからなかった場合は null

getWorkbenchWindowContext

WindowContext getWorkbenchWindowContext()
ワークベンチウィンドウに対応する WindowContext を返します。

戻り値:
WindowContext

getContainer

S2Container getContainer()
S2Container のインスタンスを返します。

戻り値:
S2Container のインスタンス

getAppClassLoader

ClassLoader getAppClassLoader()
Urumaアプリケーションバンドルのクラスローダを返します。

戻り値:
Urumaアプリケーションバンドルのクラスローダ

getUrumaClassLoader

ClassLoader getUrumaClassLoader()
Urumaバンドルのクラスローダを返します。

戻り値:
Urumaバンドルのクラスローダ

switchToAppClassLoader

void switchToAppClassLoader()
コンテクストクラスローダを Uruma アプリケーションのクラスローダに切り替えます。


switchToUrumaClassLoader

void switchToUrumaClassLoader()
コンテクストクラスローダを Uruma バンドルのクラスローダに切り替えます。


getImageBundle

ResourceBundle getImageBundle()
イメージ定義を保持する ResourceBundle を返します。
デフォルトは urumaImages.properties の内容となります。

戻り値:
ResourceBundle オブジェクト

restoreClassLoader

void restoreClassLoader()
直前に使用していたクラスローダに切り替えます。
直前に実行された switchToUrumaClassLoader() メソッドまたは、 switchToAppClassLoader() メソッド実行前のクラスローダに切り替えます。


getCommandRegistry

CommandRegistry getCommandRegistry()
CommandRegistry のインスタンスを返します。


getDefaultContextId

String getDefaultContextId()
Uruma アプリケーションのためのデフォルトコンテクスト ID を返します。
デフォルト値は <プラグインID>.context となります。

戻り値:
デフォルトコンテクスト ID


Copyright © 2006-2008 The Seasar Foundation. All Rights Reserved.