前のトピック: メニュー オプションを使用した[参照]ウィジェットの呼び出し

次のトピック: メニュー オプションを使用した[リクエスト]ウィジェットの呼び出し


ソース コードを使用した[参照]ウィジェットの呼び出し

Liferay で、ポートレットを作成し、ソース コードを指定することにより[参照]ウィジェットを呼び出すことができます。 前述の[参照]ウィジェットの例を生成する以下の手順を確認します。 ユーザの実装で[参照]ウィジェットの表示および動作を設定するモデルとして、これらを実行します。

次の手順に従ってください:

  1. ポータル ページで、ポートレットを作成するためにこれらのアクションを実行します。
    1. [Add]-[Web Content Display]をクリックします。
    2. プラスのアイコン([Add]-[Web Content])をクリックします。

      [New Web Content]ウィンドウが表示されます。

    3. 必須フィールドを指定し、ウィンドウを閉じます。

    新しいポートレットが Liferay に追加されます。

  2. ページの一番上の[Edit Controls]をクリックします。
  3. ポートレット上にマウスを置いて、鉛筆(Web コンテンツの編集)アイコンをクリックします。

    ポートレットの設定が表示されます。

  4. [Content]ウィンドウで、[Source]をクリックします。

    ソース コンテナが編集用に開きます。

  5. 前述の[参照]ウィジェットの例の以下のソースおよびキー パラメータを確認します。 ユーザのソースを指定するモデルとしてそれらを使用します。
  6. 以下の操作を実行します。

ソースとキー パラメータ

[参照]ウィジェットの例のソースは以下のとおりです。

<script type="text/javascript" src="http://hostname:portnumber/usm/explorer/scripts/browse.widget.js"> </script>
<script type="text/javascript"> CA_Catalog.buildWidget({type: 'browse', renderTo: 'browse1', rootId: 10001, linkColor: 'inherit', borderColor: 'black', layout:'layout-1', openIn:'_widget', search: true } ); </script>
<div id="browse1" style="margin-bottom: 10px; height: 700px">
	&nbsp;</div>

最初の行は、[参照]ウィジェット用の JavaScript ファイルを参照します。

2 番目の行は、[参照]ウィジェット用の設定パラメータを持つ JavaScript を指定します。

注: パラメータはカンマで区切りますが、最後のパラメータの後でカンマを指定しないでください。

3 番目の行は、[参照]ウィジェットが表示される DOM 要素を指定します。

キー パラメータおよび説明は[参照]ウィジェットの例 の CA_Catalog.buildWidget 関数呼び出しに対して実行されます。

ログイン クレデンシャル

ウィジェットにシングル サインオンをお勧めします。 ただし、このウィジェットのログイン認証情報が必要な場合は、この関数呼び出しでそれらを指定します。 以下のフォーマットを使用します。

username: 'username', password: 'password'
type:"browse"

ウィジェットが[参照]ウィジェットであることを指定します。

renderTo:"browse1"

ウィジェットがその ID が browse1 である DOM 要素に表示されることを指定します。

rootId:10001

[参照] ウィジェットが表示するフォルダまたはサービスのオブジェクト ID を指定します。 この例では、10001 はビジネス ユニットのカタログのルート フォルダです。

それらのオブジェクト ID を使用して、単一のフォルダまたはサービスのカンマ区切りリストのいずれかを指定できます。

注: オプションでツリー(左側のフォルダのリスト)を非表示にできます。 ツリーを非表示にするには、hideTree:true パラメータを指定します。 デフォルトでは、このパラメータは false に設定されています。

layout:'layout-1'

[参照]ウィジェットに表示されるサービスのアイコンおよび名前を表します。

または、サービスの名前、アイコン、および説明を表示するために layout-2 を指定します。

openIn:"_widget"

同じページ上の別のウィジェットが[参照]ウィジェットからのイベントをリスンしそれらに応答することを指定します。 このシナリオでは、ユーザがサービスをクリックするときに、[リクエスト]ウィジェットはサービスを開くことにより応答します。 この機能を有効にするには、このページに[リクエスト]ウィジェットを追加する必要があります。

OpenInは、ユーザが[参照]ウィジェット上のサービスをクリックするときに、サービスが[リクエスト]ウィジェットでどのように開くか指定します。 openIn パラメータに対する他の可能な値を以下に示します。

_self

同じページ上に、カタログのサービスを開きます。

_top

サービスをブラウザの最上位フレームで開く場合を除いて、_self と同じ関数を実行します。 サービスがフレームである場合、サービス オプション要素の関連する最初のフレームが選択されます。

_blank

新しいページ上で、カタログ内のサービスを開きます。 ユーザはそのページ上に、カタログのサービスを開きます。

_url

カスタム URL を使用して、サービスを開きます。 URL には、サービスのオブジェクト ID 用のプレースホルダを含めることができます。 以下に例を示します。

http://www.google.com?id={id}
search: true

[参照]ウィジェットに[検索]フィールドが含まれることを指定します。 ユーザは、名前または主要な用語に応じて、サービスのカタログを検索するためにこのフィールドを使用できます。

注: ソース コードに表示される次の設定を指定できます: [主な提供サービスを表示]、[リンクの色]、[境界の色]、[背景の色]