uCosminexus Portal Framework　ポートレット開発ガイド

jp.co.hitachi.soft.portal.portlet.beans.PortletInfoBean

機能

ポートレット固有の情報を取得します。

Beanの項目

宣言

<jsp:useBean id="configbean" 
class="jp.co.hitachi.soft.portal.portlet.beans.PortletInfoBean"
scope="page"/>

対象スコープ: page

メソッドの一覧

戻り値のデータ型メソッド説明

String getDescription() ポートレットの説明文を取得します。

PortletInfoBean.Mode getMode() 現在の画面モードを取得します。

String getName() ポートレット名称を取得します。

String getParameter(String name) パラメタ設定値を取得します。

String getTitle() ポートレットのタイトル文字列を取得します。

void initBean(ServletRequest req) Beanを初期化します。

void initBean(ServletRequest req, String portletName) 指定したポートレット名称でPortletInfoBeanを初期化します。

void setCustomizeTitle(String titleString) 新規ウィンドウのタイトルを，一時的に変更します。

戻り値のデータ型	メソッド	説明
String	getDescription()	ポートレットの説明文を取得します。
PortletInfoBean.Mode	getMode()	現在の画面モードを取得します。
String	getName()	ポートレット名称を取得します。
String	getParameter(String name)	パラメタ設定値を取得します。
String	getTitle()	ポートレットのタイトル文字列を取得します。
void	initBean(ServletRequest req)	Beanを初期化します。
void	initBean(ServletRequest req, String portletName)	指定したポートレット名称でPortletInfoBeanを初期化します。
void	setCustomizeTitle(String titleString)	新規ウィンドウのタイトルを，一時的に変更します。

メソッドの説明

getDescription
形式
public String getDescription()
機能

ポートレットの説明文を取得します。

パラメタ

なし

戻り値

ポートレットの説明文

説明文が設定されていない場合，空文字列を戻します。

例外

なし
getMode
形式
public PortletInfoBean.Mode getMode()
機能

現在の画面モードを取得します。

パラメタ

なし

戻り値

現在の画面モード

次のどれかの値を戻します。

戻り値モード名称説明

PortletInfoBean.Mode.DEFAULT 標準モード複数ポートレット表示状態

PortletInfoBean.Mode.MAXIMIZE 最大化モード最大化表示状態

PortletInfoBean.Mode.EDIT 編集モード編集画面表示状態

PortletInfoBean.Mode.NEWWINDOW 新規ウィンドウモード新規ウィンドウ表示状態

PortletInfoBean.Mode.IFRAME インラインモードインラインフレーム表示状態

PortletInfoBean.Mode.IRREGULAR 規格外モード画面モードが取得できない状態

例外

なし
getName
形式
public String getName()
機能

ポートレット名称を取得します。

パラメタ

なし

戻り値

ポートレット名称

initBean()が呼ばれていない，またはinitBean()に失敗している場合，nullを戻します。

例外

なし
getParameter
形式
public String getParameter(String name)
機能

nameで指定されたパラメタ設定値を取得します。

パラメタ

name - パラメタ名称

戻り値

パラメタ設定値

例外

IllegalArgumentException - 入力パラメタが不正な場合
getTitle

形式

public String getTitle()

機能

ポートレットのタイトル文字列を取得します。

パラメタ

なし

戻り値

ポートレットのタイトル文字列

ポートレットのタイトルが設定されていない場合，"No title set"を戻します。

例外

なし
initBean〔PortletInfoBeanを初期化〕
形式
public void initBean(ServletRequest req)
機能

PortletInfoBeanを初期化します。

パラメタ

req - JSPに渡されたServletRequestオブジェクト

戻り値

なし

例外

IllegalArgumentException - 引数reqがnullまたは不正なオブジェクトである場合
initBean〔指定したポートレット名称でPortletInfoBeanを初期化〕
形式
public void initBean(ServletRequest req,
                     String portletName)
機能

指定したポートレット名称でPortletInfoBeanを初期化します。以降，指定したポートレットの情報を取得します。

パラメタ

req - JSPに渡されたServletRequestオブジェクト

portletName - ポートレット名称。指定できる最大文字数は80文字です。

戻り値

なし

例外

IllegalArgumentException - 次の場合に発生します。

引数reqがnullまたは不正なオブジェクトである場合

引数portletNameがnullの場合

IllegalStateException - 引数portletNameに指定したポートレットがデプロイされていない場合
setCustomizeTitle
形式
public void setCustomoizeTitle(String titleString)
機能

新規ウィンドウのタイトルを，一時的に変更します。

パラメタ

titleString - 新規ウィンドウのタイトルに表示する文字列。指定できる最大文字数は64文字です。

戻り値

なし

例外

IllegalAugumentException - 次の場合に発生します。

引数titleStringがnullの場合

引数titleStringの文字数が64文字を超えた場合

InitializationException - 初期化されていない場合

戻り値	モード名称	説明
PortletInfoBean.Mode.DEFAULT	標準モード	複数ポートレット表示状態
PortletInfoBean.Mode.MAXIMIZE	最大化モード	最大化表示状態
PortletInfoBean.Mode.EDIT	編集モード	編集画面表示状態
PortletInfoBean.Mode.NEWWINDOW	新規ウィンドウモード	新規ウィンドウ表示状態
PortletInfoBean.Mode.IFRAME	インラインモード	インラインフレーム表示状態
PortletInfoBean.Mode.IRREGULAR	規格外モード	画面モードが取得できない状態

[目次][前へ][次へ]

[他社商品名称に関する表示]