jp.co.hitachi.soft.portal.portal.controls.layoutbeans.TitleLayoutBean

機能

タイトルバー付きのポートレットテンプレートで使用するレイアウト情報を取得します。

Beanの項目

宣言

<jsp:useBean id="layoutbean"
class="jp.co.hitachi.soft.portal.portal.controls.layoutbeans.TitleLayoutBean"
scope="page"/>

対象スコープ
page

メソッドの一覧

戻り値のデータ型メソッド説明
java.lang.StringgetBackgroundColor()コンテンツ表示領域の背景色を取得します。
java.lang.StringgetButtonImage(int type)タイトルバーに含まれるボタン画像のURLを取得します。
java.lang.StringgetButtonUrl(int type)タイトルバーに含まれるボタン用のリンク先URLを取得します。
voidgetPortletContent(JspWriter out)ポートレットのコンテンツを出力します。
java.lang.StringgetPortletParameter(java.lang.String name)ポートレットのパラメタ値を取得します。
java.lang.StringgetPortletTitle()ポートレットのタイトル文字列を取得します。
java.lang.StringgetProperty(java.lang.String name)ポートレットコントロールに指定されているプロパティを取得します。
java.lang.StringgetTitleColor()タイトルバーの背景色を取得します。
voidinitBean(ServletRequest req)Beanを初期化します。
booleanisCloseMode()ポートレットを閉じることができるかを取得します。
booleanisEditMode()ポートレットの編集モードが有効かを判定します。
booleanisHelpMode()ポートレットのヘルプモードが有効かを判定します。
booleanisMaximizeMode()ポートレットを最大化表示できるかを取得します。
booleanisMinimizeMode()ポートレットを最小化表示ができるかを取得します。

メソッドの説明

getBackgroundColor
形式

public java.lang.String getBackgroundColor()

機能
コンテンツ表示領域の背景色を取得します。
パラメタ
なし
戻り値
背景色
次の優先度に従い,設定値を取得します。
  1. ポートレット配置情報ファイル(PSMLファイル)に設定されたbackground-colorの値
  2. プロパティjp.co.hitachi.soft.portal.layout.default.background.colorの値
  3. システムのデフォルト値(#FFFFFF)
例外
なし
getButtonImage
形式

public java.lang.String getButtonImage(int type)

機能
タイトルバーに含まれるボタン画像のURLを取得します。
パラメタ
type - ボタンのタイプ
ボタンのタイプ内容
TitleLayoutBean TYPE_CLOSE閉じるボタン
TitleLayoutBean TYPE_EDIT編集ボタン
TitleLayoutBean TYPE_HELPヘルプボタン
TitleLayoutBean TYPE_MAXIMIZE最大化ボタン
TitleLayoutBean TYPE_MINIMIZE最小化ボタン
TitleLayoutBean TYPE_RESTORE復元ボタン
戻り値
ボタン画像のURL
例外
なし
getButtonUrl
形式

public java.lang.String getButtonUrl(int type)

機能
タイトルバーに含まれるボタン用のリンク先URLを取得します。
パラメタ
type - ボタンのタイプ
ボタンのタイプ内容
TitleLayoutBean TYPE_CLOSE閉じるボタン
TitleLayoutBean TYPE_EDIT編集ボタン
TitleLayoutBean TYPE_HELPヘルプボタン
TitleLayoutBean TYPE_MAXIMIZE最大化ボタン
TitleLayoutBean TYPE_MINIMIZE最小化ボタン
TitleLayoutBean TYPE_RESTORE復元ボタン
戻り値
ボタンのリンク先URL
例外
IllegalArgumentException
getPortletContent
形式

public void getPortletContent(JspWriter out)

機能
ポートレットのコンテンツを出力します。
パラメタ
out - JSPに渡されたJspWriter
戻り値
なし
例外
IllegalArgumentException - 引数outがnullの場合
getPortletParameter
形式

public java.lang.String getPortletParameter(java.lang.String name)

機能
ポートレットのパラメタ値を取得します。
パラメタ
name - パラメタ設定値のキー
戻り値
パラメタ設定値
例外
IllegalArgumentException - 引数outがnullの場合
getPortletTitle
形式

public java.lang.String getPortletTitle()

機能
ポートレットのタイトル文字列を取得します。
パラメタ
なし
戻り値
ポートレットのタイトル文字列
例外
なし
getProperty
形式

public java.lang.String getProperty(java.lang.String name)

機能
ポートレットコントロールに指定されているプロパティを取得します。
パラメタ
name - プロパティのキー
戻り値
キーに対するプロパティ値
プロパティがない場合は空文字列を返却します。
例外
なし
getTitleColor
形式

public java.lang.String getTitleColor()

機能
タイトルバーの背景色を取得します。
パラメタ
なし
戻り値
タイトルバーの背景色
次の優先度に従い,設定値を取得します。
  1. ポートレット配置情報ファイル(PSMLファイル)に設定されたtitle-colorの値
  2. プロパティjp.co.hitachi.soft.portal.layout.default.title.colorの値
  3. システムのデフォルト値(#DDDDDD)
例外
なし
initBean
形式

public void initBean(ServletRequest req)

機能
このBeanを初期化します。
パラメタ
req - JSPに渡されたServletRequestオブジェクト
戻り値
なし
例外
IllegalArgumentException - 引数reqがnullまたは不正なオブジェクトである場合
isCloseMode
形式

public boolean isCloseMode()

機能
ポートレットを閉じることができるかを取得します。
パラメタ
なし
戻り値
true:ポートレットを閉じることができる
false:ポートレットを閉じることができない
  • ポートレットのパラメタに,キー名称を「hptl.CloseMode」,値を「true」に指定している
  • 利用者がログインしている
  • 画面上に二つ以上のポートレットが存在する
  • 強制表示タブの画面でない
例外
なし
isEditMode
形式

public boolean isEditMode()

機能
ポートレットの編集モードが有効かを判定します。表示されるポートレットが編集画面を持ち,かつユーザがログインしている場合に,編集モードが有効と判定します。
パラメタ
なし
戻り値
true:編集画面が有効
false:編集画面が無効
例外
なし
isHelpMode
形式

public boolean isHelpMode()

機能
ポートレットのヘルプモードが有効かを判定します。表示されるポートレットがヘルプ画面を持つ場合に,ヘルプモードが有効と判定します。
パラメタ
なし
戻り値
true:ヘルプモードが有効
false:ヘルプモードが無効
例外
なし
isMaximizeMode
形式

public boolean isMaximizeMode()

機能
ポートレットを最大化表示できるかを取得します。
パラメタ
なし
戻り値
true:ポートレットを最大化表示できる
false:ポートレットを最大化表示できない
次の条件にすべて当てはまる場合,tureを返却します。
  • ポートレットのパラメタに,キー名称を「hptl.MaximizeMode」,値を「true」または「指定無し」を指定している
  • 表示中のポートレットが最大化表示ではない
例外
なし
isMinimizeMode
形式

public boolean isMinimizeMode()

機能
ポートレットを最小化(タイトルだけ)の表示できるかを取得します。
パラメタ
なし
戻り値
true:ポートレットを最小化(タイトルだけ)の表示にできる
false:ポートレットを最小化(タイトルだけ)の表示できない
次の条件にすべて当てはまる場合,tureを返却します。
  • ポートレットのパラメタに,キー名称を「hptl.MinimizeMode」,値を「true」に指定している
  • 利用者がログインしている
  • 現在のポートレットが最小化の状態でない
  • 強制表示タブの画面でない
例外
なし