ポートレットテンプレートは,ポートレットの画面表示の内容を決定するテンプレートです。ポートレットの表示状態によって使用されるテンプレートが変わります。
(1) ポートレットテンプレートの種類
各ポートレットテンプレートの種類と表示内容を次の表に示します。
表5-9 ポートレットテンプレートの種類と表示内容
ポートレットテンプレート名 | ポートレットテンプレートの表示内容 |
---|---|
TitlePortletControl | タイトルバーとコンテンツを表示します。 |
BorderPortletControl | ポートレットのコンテンツ部分を枠線で囲んで表示します。[スタイル編集画面]でポートレットのスタイルをタイトルなし・枠なしに設定した場合に使用されます。 |
PanedPortletControl | タブを表示します。ナビゲーションバーを表示しないときに使用されます。 |
NavigationPanedPortletControl | タブを表示します。ナビゲーションバーを表示するときに使用されます。 |
TitleControl | タイトルバーだけを表示します。ポートレットを最小化表示するときに使用されます。 |
FullScreenControl | タイトルバーとコンテンツを表示します。ポートレットを最大化表示するときに使用されます。 |
EditScreenControl | 最大化した状態で編集画面を表示します。編集ボタンをクリックしたときに使用されます。 |
ポートレットテンプレートを編集してデザインなどを変更できます。
ポートレットテンプレートの格納ディレクトリを次に示します。ポートレットテンプレートのファイル名は,「ポートレットテンプレート名.jsp」です。
ポートレットテンプレートを編集する際は,BODY要素の内側に記述する部分だけを記述してください。また,次に示すタグを使用したカスタマイズはできません。
(a) TitlePortletControl
ポートレットのタイトルバーとコンテンツが表示されるテンプレートです。ポートレットに対してポートレットテンプレートを何も指定しなかった場合には,TitlePortletControlが自動的に適用されます。TitlePortletControlを使用したときのポータル画面を次に示します。
図5-8 TitlePortletControl(基本テンプレート)を使用した場合
(b) BorderPortletControl
ポートレットが枠線で囲まれて表示されるテンプレートです。
BorderPortletControlを使用したときのポータル画面を次に示します。
図5-9 BorderPortletControl(基本テンプレート)を使用した場合
(c) PanedPortletControl
タブ形式の画面が表示されるテンプレートです。タブ形式のレイアウトでナビゲーションメニューを表示していない場合は,このテンプレートが使用されます。ポートレット表示領域の上下に表示される線をルーラーと呼びます。
PanedPortletControlを使用したときのポータル画面を次に示します。
図5-10 PanedPortletControl(基本テンプレート)を使用した場合
(d) NavigationPanedPortletControl
タブ形式の画面が表示されるテンプレートです。タブ形式のレイアウトでナビゲーションメニューを表示した場合は,このテンプレートが使用されます。
NavigationPanedPortletControlを使用したときのポータル画面を次に示します。
図5-11 NavigationPanedPortletControl(基本テンプレート)を使用した場合
(e) TitleControl
ポートレットのタイトルバーだけが表示されるテンプレートです。ポートレットを最小化表示するときに使用されます。
TitleControlを使用したときのポータル画面を次に示します。
図5-12 TitleControl(基本テンプレート)を使用した場合
(f) FullScreenControl
ポートレットが最大化表示されるテンプレートです。ポートレットを最大化表示するときに使用されます。
FullScreenControlを使用したときのポータル画面を次に示します。
図5-13 FullScreenControl(基本テンプレート)を使用した場合
(g) EditScreenControl
最大化した状態で編集画面が表示されるテンプレートです。標準APIポートレット以外のポートレットで,編集ボタンをクリックしたときに使用されます。EditScreenControlを使用したときのポータル画面を次に示します。
図5-14 EditScreenControl(基本テンプレート)を使用した場合
(2) カスタマイズ方法
ポートレットテンプレートのカスタマイズの例を次の表に示します。
表5-10 ポートレットテンプレートのカスタマイズの例
ポートレットテンプレート | 例 |
---|---|
TitlePortletControl |
|
BorderPortletControl | 枠線の付加 |
PanedPortletControl |
|
NavigationPanedPortletControl |
|
TitleControl |
|
FullScreenControl |
|
EditScreenControl |
|
カスタマイズするには,ポートレットテンプレートBeanを使用します。
ポートレットテンプレートBeanは,ポートレットテンプレートで使用するAPIです。ポートレット配置情報ファイル(PSMLファイル)に保存されているユーザごとのカスタマイズ情報,ポートレット定義ファイル(jetspeed-config.jcfg)に定義されているポートレットのタイトルなどの情報を取得します。
ポートレットテンプレートを編集するときは,次の表に示すポートレットテンプレートBeanを使用します。
表5-11 ポートレットテンプレートで使用するポートレットテンプレートBean
ポートレットテンプレート | ポートレットテンプレートBean |
---|---|
TitlePortletControl | TitleLayoutBean |
BorderPortletControl | NoTitleLayoutBean |
PanedPortletControl | PanedLayoutBean |
NavigationPanedPortletControl | NavigationPanedLayoutBean |
TitleControl | TitleLayoutBean |
FullScreenControl | TitleLayoutBean |
EditScreenControl | TitleLayoutBean |
ポートレットテンプレートで使用できるAPIは,ポートレットテンプレートBeanだけです。uCosminexus Portal Frameworkが提供するほかのタグライブラリ,クラスライブラリおよびBeanは使用できません。
ポートレットテンプレートBeanの詳細は,「9.4 ポートレットテンプレートBean」を参照してください。
ポートレットテンプレートBeanによって,取得できるレイアウト項目が異なります。
レイアウト項目と設定内容を次の表に示します。
表5-12 レイアウト項目と設定内容
ポートレットテンプレートBean | レイアウト項目 | 設定ファイル | パラメタ名称 |
---|---|---|---|
共通 | コンテンツの背景色 | ポートレット配置情報ファイル(PSMLファイル) | background-color |
NoTitleLayoutBean | 枠線の太さ | ポートレット配置情報ファイル(PSMLファイル) | border-size |
枠線の色 | ポートレット配置情報ファイル(PSMLファイル) | border-color | |
PanedLayoutBean | 選択しているタブ色 | ポートレット配置情報ファイル(PSMLファイル) | selected-color |
選択していないタブ色 | ポートレット配置情報ファイル(PSMLファイル) | title-color | |
ルーラー幅 | ポートレット配置情報ファイル(PSMLファイル) | ruler-size | |
ルーラー色 | ポートレット配置情報ファイル(PSMLファイル) | ruler-color | |
タブのタイトル | ポートレット配置情報ファイル(PSMLファイル) | <title>要素 | |
TitleLayoutBean | タイトルバーの背景色 | ポートレット配置情報ファイル(PSMLファイル) | title-color |
ボタンに使用する画像 | {PROJECT_HOME}¥imagesに格納されています。
| - |
(凡例) -:該当しません。
(3) TitlePortletControlの構成
TitlePortletControlで表示したポートレットの画面構成を次に示します。なお,これは,基本テンプレートを使用した場合の構成図です。
図5-15 TitlePortletControlで表示したポートレットの画面構成
一つのポートレットは,一つのテーブル要素から成り立っています。図のいちばん外側の枠がテーブル要素に該当します。
(a) ポートレットに表示されるボタン(標準APIポートレットの場合)
表5-13 ポートレットの状態と表示されるボタンの関係(標準APIポートレット)
ポートレットの状態 | 表示されるボタン | |||||||
---|---|---|---|---|---|---|---|---|
表示モード | 表示サイズ | ビュー | ヘルプ | 編集 | 元に戻す | 最小化 | 最大化 | 閉じる |
ビューモード(コンテンツが表示されている状態) | 通常表示(1画面上に複数のポートレットを表示している状態) | △ | ○※1 | ○※2 | △ | ○※3 | ○ | ○※4 |
最大化表示 | △ | ○※1 | ○※2 | ○ | ○※3 | △ | × | |
最小化表示 | △ | ○※1 | ○※2 | ○ | △※3 | ○ | ○※4 | |
編集モード(編集画面が表示されている状態) | 通常表示 | ○ | ○※1 | △※2 | △ | ○※3 | ○ | ○※4 |
最大化表示 | ○ | ○※1 | △※2 | ○ | ○※3 | △ | × | |
最小化表示 | ○ | ○※1 | △※2 | ○ | △※3 | ○ | ○※4 | |
ヘルプモード(ヘルプ画面が表示されている状態) | 通常表示 | ○ | △※1 | ○※2 | △ | ○※3 | ○ | ○※4 |
最大化表示 | ○ | △※1 | ○※2 | ○ | ○※3 | △ | × | |
最小化表示 | ○ | △※1 | ○※2 | ○ | △※3 | ○ | ○※4 |
(凡例) ○:表示されます。 △:非活性状態で表示されます。 ×:表示されません。
注※1 ポートレットアプリケーションDD(portlet.xml)のsupportsタグ内で,portlet-modeにHELPが定義されている場合だけ,表示されます。
注※2 ポートレットアプリケーションDD(portlet.xml)のsupportsタグ内で,portlet-modeにEDITが定義されている場合だけ,表示されます。
注※3 ポートレットが強制表示ポートレットの場合は表示されません。
注※4 次の場合には表示されません。
(b) ポートレットに表示されるボタン(標準APIポートレット以外のポートレットの場合)
表5-14 ポートレットの状態と表示されるボタンの関係(標準APIポートレット以外のポートレット)
ポートレットの状態 | 表示されるボタン | |||||
---|---|---|---|---|---|---|
ヘルプ ボタン | 編集 ボタン | 最小化 ボタン | 復元 ボタン | 最大化 ボタン | 閉じる ボタン | |
通常表示状態(1画面上に複数のポートレットを表示している状態) | ○※1 | ○※2 | ○※3 | × | ○※4 | ○※5 |
最大化表示状態 | ○※1 | ○※2 | × | ○ | × | × |
編集状態 | ○※1 | × | × | ○※6 | × | × |
最小化表示状態 | ○※1 | × | × | ○ | ○※4 | ○※5 |
新規ウィンドウ表示状態 | ○※1 | × | × | × | × | × |
(凡例) ○:表示されます。 ×:表示されません。
注※1 ポートレット定義ファイル(jetspeed-config.jcfg)で,使用言語のヘルプが設定されている場合だけ,表示されます。各言語のヘルプを設定するプロパティは次のとおりです。
hptl.help.url.{言語コード}[-{国コード}[-{バリアント}]]
例えば,使用言語が日本語の場合は,ポートレット定義ファイル(jetspeed-config.jcfg)のhptl.help.url.ja,使用言語が英語の場合は,hptl.help.url.enを設定したときだけ表示されます。なお,使用言語が日本語の場合は,hptl.help.urlを設定している場合も表示されます。
注※2 ポートレット定義ファイル(jetspeed-config.jcfg)のhptl.EditModeで表示を有効にした場合だけ表示されます。
注※3 ポートレット定義ファイル(jetspeed-config.jcfg)のhptl.MinimizeModeで表示を有効にした場合だけ表示されます。
注※4 ポートレット定義ファイル(jetspeed-config.jcfg)のhptl.MaximizeModeで表示を有効(または指定なし)にした場合だけ表示されます。
注※5 ポートレット定義ファイル(jetspeed-config.jcfg)のhptl.CloseModeで表示を有効にした場合だけ表示されます。
注※6 編集内容を反映しないで,遷移元の画面に戻ります。
(4) TitleControlの構成
TitleControlは,ポートレットのタイトルバーだけが表示されるテンプレートです。
TitleControl.jspの画面構成は,TitlePortletControl.jspの画面構成のタイトルバー部分と同じです。TitlePortletControl.jspの画面構成については,「(3) TitlePortletControlの構成」を参照してください。なお,ポートレットに表示されるボタンは,ポートレットを最小化表示しているときに表示されるボタンと同じです。
(5) レイアウト項目のデフォルト値
ポートレット配置情報ファイル(PSMLファイル)内に設定するタブのタイトル以外のパラメタが設定されていない場合には,プロパティファイル(PortalResources.properties)のプロパティ値を使用します。プロパティの設定もない場合には,システムのデフォルト値を使用します。
レイアウト項目のプロパティ値およびデフォルト値を次の表に示します。
表5-15 レイアウト項目のプロパティ値およびデフォルト値
レイアウト項目 | プロパティ | デフォルト値 |
---|---|---|
コンテンツの背景色 | jp.co.hitachi.soft.portal.layout.default.background.color | #FFFFFF |
枠線の太さ | jp.co.hitachi.soft.portal.layout.default.border.size | 1 |
枠線の色 | jp.co.hitachi.soft.portal.layout.default.border.color | #CCCCCC |
選択しているタブ色 | jp.co.hitachi.soft.portal.layout.default.active.color | #990000 |
選択していないタブ色 | jp.co.hitachi.soft.portal.layout.default.nonactive.color | #DDDDDD |
ルーラー幅 | jp.co.Hitachi.soft.portal.layout.default.ruler.size | 2 |
ルーラー色 | jp.co.Hitachi.soft.portal.layout.default.ruler.color | #DDDDDD |
タイトルバーの背景色 | jp.co.hitachi.soft.portal.layout.default.title.color | #DDDDDD |
ポートレット間隔 | jp.co.Hitachi.soft.portal.layout.default.padding.size | 3 |
プロパティファイル(PortalResources.properties)は{設定ファイル格納ディレクトリ}に格納されています。デフォルトの格納ディレクトリは次のとおりです。
プロパティファイル(PortalResources.properties)のプロパティ設定例を次に示します。
#-------------------------------------------------------------
#
# D E F A U L T L A Y O U T P R O P E R T I E S
#
#--------------------------------------------------------------
# Padding Size
jp.co.Hitachi.soft.portal.layout.default.padding.size=3
# Border Size
jp.co.hitachi.soft.portal.layout.default.border.size=1
# Border Color
jp.co.hitachi.soft.portal.layout.default.border.color=#CCCCCC
# Active Tab Color
jp.co.hitachi.soft.portal.layout.default.active.color=#990000
# NonActive Tab Color
jp.co.hitachi.soft.portal.layout.default.nonactive.color=#DDDDDD
# Ruler Size
jp.co.hitachi.soft.portal.layout.default.ruler.size=2
# Ruler Color
jp.co.hitachi.soft.portal.layout.default.ruler.color=#990000
# Title Color
jp.co.hitachi.soft.portal.layout.default.title.color=#DDDDDD
# Background Color
jp.co.hitachi.soft.portal.layout.default.background.color=#FFFFFF