ブリックレシピ定義ファイルの各要素および属性について、以下に示します。
要素の説明
要素 | 説明 | ||
---|---|---|---|
brick-recipes | ブリックレシピ定義ファイルの文書ルートです。 | ||
brick-recipe | 各ブリックのブリックレシピ情報を以下の要素で記述します。 | ||
id | ブリックのIDを記述します。サービス中で一意である必要があります。 | ||
copyright | コピーライト表示を記述します。 | ||
author | 作者を記述します。 | ||
date | 作成日を記述します。 | ||
title | タイトルバーに表示される文字列を記述します。 | ||
caption | 説明を記述します。 | ||
description-uri | ヘルプ文書(HTMLまたはJSP)への URIを記述します。このタグが指定されるとブリックのタイトルバーにヘルプボタンが表示されます。 | ||
home-content-uri | 初期画面のURIを記述します。 | ||
content-option | ブリックのコンテンツの自動更新について記述します。 | ||
icon-uri | アイコンのイメージファイルのURIを記述します。アイコンのサイズは、13x13ドットの必要があります。 | ||
button | タイトルバーに表示するボタンの種類を記述します。 |
要素の属性
要素の属性を以下に示します。なお、属性値が英大文字の場合、運用管理コンソールでの別名登録時に初期状態を変更できません。
属性 | 説明 | 省略値 |
---|---|---|
auto-refresh (true | false) | auto-refresh (true | false | per-panel-click) | false |
height | ブリックの高さの初期値をピクセル単位で指定します。 | 300 |
initial-state(closed | shaded | unshaded | maximized | CLOSED | SHADED | UNSHADED | MAXIMIZED) | ブリックをパネルに追加した時の初期表示状態を指定します。 | unshaded |
属性値 | 説明 |
---|---|
closed | 初めてのブリックであっても、パネルには追加されません。 ただし、My Portalの「パネル操作」のブリック一覧には表示されます。 除去不可能である場合(除去ボタン属性の値がfalse)には、指定は無視されます。 |
shaded | パネルに初めて追加された時には、タイトルバーだけが表示されます。 |
unshaded | タイトルバーとコンテンツがともに表示されます。height属性が指定されている場合、指定された高さでブリックが表示されます。 |
maximized | 最大化した状態で追加されます。ただし、最大化を指定した追加ブリックが複数存在する場合は、そのうちのどれか1つのブリックだけが最大化されて表示されます。 |
属性 | 説明 | 省略値 |
---|---|---|
home (true | false | TRUE | FALSE) | trueの場合、 [ホーム]ボタンがタイトルバーに表示されます。[ホーム]ボタンをクリックすると初期画面に戻ります。 | true |
reload (true | false | TRUE | FALSE) | trueの場合、タイトルバーに[再読み込み]ボタンが表示されます。クリックすると表示しているブリックのコンテンツが更新されます。 | true |
personalize (true | invisible | false | TRUE | INVISIBLE | FALSE) | trueの場合、タイトルバーに[パーソナライズ]ボタンが表示されます。クリックするとブリックのカスタマイズ用画面(My Portalの設定画面)が表示されます。 | true |
shade (true | invisible | false | TRUE | INVISIBLE | FALSE) | trueの場合、ブリックの最小化および元のサイズに戻す処理ができるようになります。 | true |
close (true | invisible | false | TRUE | INVISIBLE | FALSE) | trueの場合、タイトルバーに[パネルから除去]ボタンが表示されます。クリックするとブリックがパネルから除去されます。除去されたブリックは、レイアウトのパーソナライズページで再び、パネルに追加することができます。 | invisible |
full (true | invisible | false | TRUE | INVISIBLE | FALSE) | trueの場合、[最大化]ボタンが表示されます。そのボタンをクリックするとブリックがパネル全体に表示されます。 | true |
fork (true | false | TRUE | FALSE) | trueの場合、[別ウィンドウ]ボタンが表示されます。そのボタンをクリックすると、このコンテンツを出力する時のcontentタグで指定したURLが別ウィンドウに表示されます。 | false |
history (true | false | TRUE | FALSE) | trueの場合、[戻る]ボタンと[進む]ボタンが表示されます。そのボタンをクリックすると、ブリック内のページ遷移が行われます。 | false |
属性値 | 説明 |
---|---|
true | タイトルバーにボタンが表示されます。また、運用管理コンソールで属性値の切り替えが行えます。 |
false | タイトルバーへのボタンの表示、および運用管理コンソールでの属性値の切り替えともに行えません。 |
invisible | タイトルバーにボタンが表示されません。ただし、運用管理コンソールで属性値の切り替えが行えます。 |
TRUE | タイトルバーにボタンが表示されます。また、運用管理コンソールで属性値の切り替えが行えます。 運用管理コンソールのシナリオ別名登録時(既存シナリオをコピーして別名で登録すること)にこの設定を変更できなくなります。 |
FALSE | タイトルバーへのボタンの表示、および運用管理コンソールでの属性値の切り替えともに行えません。 運用管理コンソールのシナリオ別名登録時(既存シナリオをコピーして別名で登録すること)にこの設定を変更できなくなります。 |
INVISIBLE | タイトルバーにボタンが表示されません。ただし、運用管理コンソールで属性値の切り替えが行えます。 運用管理コンソールのシナリオ別名登録時(既存シナリオをコピーして別名で登録すること)にこの設定を変更できなくなります。 |