uCosminexus Portal Framework　システム管理者ガイド

jp.co.hitachi.soft.portal.portal.portlets.beans.LayoutCustomizeBean

機能

カスタマイズ機能を使用する画面のJSPから呼び出されるBeanです。

Beanの項目

宣言

<jsp:useBean id="databean" 
class="jp.co.hitachi.soft.portal.portal.portlets.beans.LayoutCustomizeBean"
scope="session"/>

対象スコープ: session

フィールド一覧

フィールド形式フィールドの説明

Tab レイアウト形式の「タブ形式」を示します。

RowColumn レイアウト形式の「行列形式」を示します。

Grid レイアウト形式の「グリッド形式」を示します。

Flow レイアウト形式の「フロー形式」を示します。

HDMLCard レイアウト形式の「HDMLカード形式」を示します。

CHTMLCard レイアウト形式の「CHTMLカード形式」を示します。

User レイアウト形式の「ユーザ登録形式」を示します。

RowColumnModeRow 行列種別の「列ベース」を示します。

RowColumnModeColumn 行列種別の「行ベース」を示します。

HTML デバイス種別の「PCブラウザ用画面」を示します。

CHTML デバイス種別の「iモード用画面」を示します。

HDML デバイス種別の「EZweb用画面」を示します。

STYLE_TITLE スタイル種別の「タイトル付き」を示します。

STYLE_FRAME スタイル種別の「タイトルなし・枠付き」を示します。

STYLE_NONE スタイル種別の「タイトルなし・枠なし」を示します。

STYLE_COLOR_BACKGROUND スタイル色の「ポートレット背景色」を示します。

STYLE_COLOR_TITLE スタイル色の「タイトル背景色」を示します。

STYLE_COLOR_TAB スタイル色の「選択中の背景色」を示します。

STYLE_COLOR_BORDER スタイル色の「枠色」を示します。

STYLE_SIZE_RULER スタイルサイズの「ルーラー」を示します。

STYLE_SIZE_PADDING スタイルサイズの「ポートレット間隔」を示します。

STYLE_SIZE_BORDER スタイルサイズの「枠幅」を示します。

MOVE_UP 方向の「上」を示します。

MOVE_DOWN 方向の「下」を示します。

MOVE_LEFT 方向の「左」を示します。

MOVE_RIGHT 方向の「右」を示します。

MODE_ADMIN ポータルの管理者を示します。

MODE_SECTION 部門管理者を示します。

MODE_USER 利用者を示します。

ARRANGEMENT_LEFTUP 配置の左上を示します。

ARRANGEMENT_LEFTDOWN 配置の左下を示します。

ARRANGEMENT_RIGHTUP 配置の右上を示します。

ARRANGEMENT_RIGHTDOWN 配置の右下を示します。

MODE_FORCE 強制編集モードを示します。

MODE_FORCETAB 強制タブモードを示します。

フィールド形式	フィールドの説明
Tab	レイアウト形式の「タブ形式」を示します。
RowColumn	レイアウト形式の「行列形式」を示します。
Grid	レイアウト形式の「グリッド形式」を示します。
Flow	レイアウト形式の「フロー形式」を示します。
HDMLCard	レイアウト形式の「HDMLカード形式」を示します。
CHTMLCard	レイアウト形式の「CHTMLカード形式」を示します。
User	レイアウト形式の「ユーザ登録形式」を示します。
RowColumnModeRow	行列種別の「列ベース」を示します。
RowColumnModeColumn	行列種別の「行ベース」を示します。
HTML	デバイス種別の「PCブラウザ用画面」を示します。
CHTML	デバイス種別の「iモード用画面」を示します。
HDML	デバイス種別の「EZweb用画面」を示します。
STYLE_TITLE	スタイル種別の「タイトル付き」を示します。
STYLE_FRAME	スタイル種別の「タイトルなし・枠付き」を示します。
STYLE_NONE	スタイル種別の「タイトルなし・枠なし」を示します。
STYLE_COLOR_BACKGROUND	スタイル色の「ポートレット背景色」を示します。
STYLE_COLOR_TITLE	スタイル色の「タイトル背景色」を示します。
STYLE_COLOR_TAB	スタイル色の「選択中の背景色」を示します。
STYLE_COLOR_BORDER	スタイル色の「枠色」を示します。
STYLE_SIZE_RULER	スタイルサイズの「ルーラー」を示します。
STYLE_SIZE_PADDING	スタイルサイズの「ポートレット間隔」を示します。
STYLE_SIZE_BORDER	スタイルサイズの「枠幅」を示します。
MOVE_UP	方向の「上」を示します。
MOVE_DOWN	方向の「下」を示します。
MOVE_LEFT	方向の「左」を示します。
MOVE_RIGHT	方向の「右」を示します。
MODE_ADMIN	ポータルの管理者を示します。
MODE_SECTION	部門管理者を示します。
MODE_USER	利用者を示します。
ARRANGEMENT_LEFTUP	配置の左上を示します。
ARRANGEMENT_LEFTDOWN	配置の左下を示します。
ARRANGEMENT_RIGHTUP	配置の右上を示します。
ARRANGEMENT_RIGHTDOWN	配置の右下を示します。
MODE_FORCE	強制編集モードを示します。
MODE_FORCETAB	強制タブモードを示します。

メソッドの一覧

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

void changeForce() ファイル編集中の場合に，現在編集中のレイアウトを強制表示タブレイアウトに切り替えます。すでに切り替わっている場合は何もしません。

void changeForce(int iForceMode) ファイル編集中の場合に，現在編集中のレイアウトを指定された強制レイアウトに切り替えます。すでに切り替わっている場合は何もしません。

void changeNormal() ファイル編集中の場合に，現在編集中の強制表示タブレイアウトを通常表示レイアウトに切り替えます。すでに切り替わっている場合は何もしません。

java.lang.String getApplyURL() ［レイアウト編集画面］でレイアウト情報を更新するときのURLを取得します。

java.lang.String getCancelURL() ［レイアウト編集画面］でレイアウト情報を更新しないで，通常の画面に戻るときのURLを取得します。

void getContents() 現在設定しているカスタマイズ情報を取得します。

java.lang.String getDefaultURL() ［レイアウト編集画面］で現在のレイアウト情報を標準の設定に戻すときのURLを取得します。

DeviceBean[] getDeviceBeans() すべてのクライアントの画面構成オブジェクトを取得します。

DeviceBean getEditDeviceBean() 現在編集中のDeviceBeanオブジェクトを取得します。

int getEditDeviceCode() 現在編集中のクライアント種別を取得します。

java.lang.String getEditLayoutGroup() 現在編集中のレイアウトグループ名称を取得します。

java.lang.String getEditPSMLPath() 現在編集中のポートレット配置情報ファイル（PSMLファイル）のパスを取得します。

java.lang.String[] getErrorMessages() カスタマイズ操作によるエラーメッセージを取得します。

int getForceMode() 現在の強制モードを取得します。

java.lang.String getForceTabName() 管理者が強制表示タブを編集中の場合，強制表示タブを取得します。

java.lang.String getHomeURL() ［レイアウト編集画面］でレイアウト情報を更新し，通常の画面に戻るときのURLを取得します。

LayoutCustomizeUtil getLayoutCustomizeUtil() カスタマイズで使用するライブラリを取得します。

java.lang.String getLayoutID() 部門管理者のレイアウトグループIDを取得します。

java.lang.String[][] getLayoutPatterns() 登録されているレイアウトパターンの名称と表示名称のリストを取得します。

int getMaxColumn() 表示できる最大列数を取得します。

int getMaxRow() 表示できる最大行数を取得します。

int getMode() 現在のモードを取得します。

PortletGroupBean[] getPortletGroupBeans() ポートレットグループの一覧を取得します。

PortletGroupBean[] getRootPortletGroupBean() 最上位のポートレットグループの配列を取得します。

java.lang.String getSelectedTabName() 各利用者のホーム画面で表示しているタブ名称を取得します。

void initBean(ServletRequest request,boolean adminmode) ［レイアウト編集画面］以外でBeanを初期化します。

boolean isAdminMode() 管理者用レイアウトカスタマイズ画面であるかを判定します。

boolean isForceLayout() ファイル編集中の場合に現在編集中のレイアウトが強制表示レイアウトであることを表示します。

void setChangeLayoutGroup(java.lang.String layoutGroupName) 現在編集中のレイアウトグループ名称を別の名称に変更します。

void setContents() 現在設定しているカスタマイズ情報を保存します。

void setDeviceBeans(DeviceBean [] setDeviceBeans) すべてのクライアント画面構成オブジェクトのリストを設定します。ただし，このメソッドは推奨いたしません。

void setEditDeviceCode(int deviceCode) 現在編集中のクライアント種別を設定します。

void setEditLayoutGroup(java.lang.String layout) 現在編集中のレイアウトグループ名称を設定します。

void setEditPSMLPath(java.lang.String path) 現在編集中のポートレット配置情報ファイル（PSMLファイル）のパスを設定します。

void setRemoveLayoutGroup(java.lang.String layoutGroupName) レイアウトグループを削除します。

void setSelectedLayoutList(java.util.Vector lv) このデバイスBeanが取得している選択済みのレイアウトの一覧を設定します。

void setSelectedTabName(java.lang.String selectedTabName) 各利用者のホーム画面で現在選択中のタブ名称を設定します。

戻り値のデータ型	メソッド	説明
void	changeForce()	ファイル編集中の場合に，現在編集中のレイアウトを強制表示タブレイアウトに切り替えます。すでに切り替わっている場合は何もしません。
void	changeForce(int iForceMode)	ファイル編集中の場合に，現在編集中のレイアウトを指定された強制レイアウトに切り替えます。すでに切り替わっている場合は何もしません。
void	changeNormal()	ファイル編集中の場合に，現在編集中の強制表示タブレイアウトを通常表示レイアウトに切り替えます。すでに切り替わっている場合は何もしません。
java.lang.String	getApplyURL()	［レイアウト編集画面］でレイアウト情報を更新するときのURLを取得します。
java.lang.String	getCancelURL()	［レイアウト編集画面］でレイアウト情報を更新しないで，通常の画面に戻るときのURLを取得します。
void	getContents()	現在設定しているカスタマイズ情報を取得します。
java.lang.String	getDefaultURL()	［レイアウト編集画面］で現在のレイアウト情報を標準の設定に戻すときのURLを取得します。
DeviceBean[]	getDeviceBeans()	すべてのクライアントの画面構成オブジェクトを取得します。
DeviceBean	getEditDeviceBean()	現在編集中のDeviceBeanオブジェクトを取得します。
int	getEditDeviceCode()	現在編集中のクライアント種別を取得します。
java.lang.String	getEditLayoutGroup()	現在編集中のレイアウトグループ名称を取得します。
java.lang.String	getEditPSMLPath()	現在編集中のポートレット配置情報ファイル（PSMLファイル）のパスを取得します。
java.lang.String[]	getErrorMessages()	カスタマイズ操作によるエラーメッセージを取得します。
int	getForceMode()	現在の強制モードを取得します。
java.lang.String	getForceTabName()	管理者が強制表示タブを編集中の場合，強制表示タブを取得します。
java.lang.String	getHomeURL()	［レイアウト編集画面］でレイアウト情報を更新し，通常の画面に戻るときのURLを取得します。
LayoutCustomizeUtil	getLayoutCustomizeUtil()	カスタマイズで使用するライブラリを取得します。
java.lang.String	getLayoutID()	部門管理者のレイアウトグループIDを取得します。
java.lang.String[][]	getLayoutPatterns()	登録されているレイアウトパターンの名称と表示名称のリストを取得します。
int	getMaxColumn()	表示できる最大列数を取得します。
int	getMaxRow()	表示できる最大行数を取得します。
int	getMode()	現在のモードを取得します。
PortletGroupBean[]	getPortletGroupBeans()	ポートレットグループの一覧を取得します。
PortletGroupBean[]	getRootPortletGroupBean()	最上位のポートレットグループの配列を取得します。
java.lang.String	getSelectedTabName()	各利用者のホーム画面で表示しているタブ名称を取得します。
void	initBean(ServletRequest request,boolean adminmode)	［レイアウト編集画面］以外でBeanを初期化します。
boolean	isAdminMode()	管理者用レイアウトカスタマイズ画面であるかを判定します。
boolean	isForceLayout()	ファイル編集中の場合に現在編集中のレイアウトが強制表示レイアウトであることを表示します。
void	setChangeLayoutGroup(java.lang.String layoutGroupName)	現在編集中のレイアウトグループ名称を別の名称に変更します。
void	setContents()	現在設定しているカスタマイズ情報を保存します。
void	setDeviceBeans(DeviceBean [] setDeviceBeans)	すべてのクライアント画面構成オブジェクトのリストを設定します。ただし，このメソッドは推奨いたしません。
void	setEditDeviceCode(int deviceCode)	現在編集中のクライアント種別を設定します。
void	setEditLayoutGroup(java.lang.String layout)	現在編集中のレイアウトグループ名称を設定します。
void	setEditPSMLPath(java.lang.String path)	現在編集中のポートレット配置情報ファイル（PSMLファイル）のパスを設定します。
void	setRemoveLayoutGroup(java.lang.String layoutGroupName)	レイアウトグループを削除します。
void	setSelectedLayoutList(java.util.Vector lv)	このデバイスBeanが取得している選択済みのレイアウトの一覧を設定します。
void	setSelectedTabName(java.lang.String selectedTabName)	各利用者のホーム画面で現在選択中のタブ名称を設定します。

メソッドの説明

changeForce
形式
public void changeForce()
機能

ファイル編集中の場合に，現在編集中のレイアウトを強制表示タブレイアウトに切り替えます。すでに切り替わっている場合は何もしません。

パラメタ

なし

戻り値

なし

例外

IllegalStateException - 部門管理者の場合で，現在設定しているカスタマイズ情報がディスクまたはディレクトリに存在しない場合
changeForce
形式
public void changeForce(int iForceMode)
機能

ファイル編集中の場合に，現在編集中のレイアウトを指定された強制レイアウトに切り替えます。すでに切り替わっている場合は何もしません。

パラメタ

iForceMode

1：強制タブレイアウトに切り替えます。

2：強制編集レイアウトに切り替えます。

戻り値

なし

例外

IllegalStateException - 部門管理者の場合で，現在設定しているカスタマイズ情報がディスクまたはディレクトリに存在しない場合
changeNormal
形式
public void changeNormal()
機能

ファイル編集中の場合に，現在編集中の強制表示タブレイアウトを通常表示レイアウトに切り替えます。すでに切り替わっている場合は何もしません。

パラメタ

なし

戻り値

なし

例外

IllegalStateException - 部門管理者の場合で，現在設定しているカスタマイズ情報がディスクまたはディレクトリに存在しない場合
getApplyURL
形式
public java.lang.String getApplyURL()
機能

［レイアウト編集画面］でレイアウト情報を更新するときのURLを取得します。

パラメタ

なし

戻り値

［設定完了］をクリックしたときのURL

［レイアウト編集画面］以外ではnullを返却します。

例外

なし
getCancelURL
形式
public java.lang.String getCancelURL()
機能

［レイアウト編集画面］でレイアウト情報を更新しないで，通常の画面に戻るときのURLを取得します。

パラメタ

なし

戻り値

レイアウト情報を更新しないで，通常の画面に戻るときのURL

［レイアウト編集画面］以外ではnullを返却します。

例外

なし
getContents
形式
public void getContents()
機能

現在設定しているカスタマイズ情報をディスクまたはディレクトリ上から取得します。

isAdminMode()がtrueの場合

次の設定後このメソッドを呼び出します。

取得対象のクライアントの設定：setEditDeviceCode(int)

取得対象のパスの設定：setEditPSMLPath(java.lang.String)

取得対象のレイアウトコードの設定：setEditLayoutGroup(java.lang.String)

isAdminMode()がfalseの場合

取得対象のクライアントの設定をsetEditDeviceCode(int)に設定後，このメソッドを呼び出します。

　

なお，取得したカスタマイズ情報が不正な場合，次の表に示す補正が行われます。

条件補正方法ログ

レイアウト形式が［ユーザ登録形式］でレイアウトパターンが無効な場合レイアウト形式を［行列形式（列ベース）］にします。 KDPF33001-W

選択済みのポートレットが存在しない場合ポートレット（PortletBean）は作成しません。 KDPF33001-W

選択済みのポートレットに対してアクセス権がない場合ポートレット（PortletBean）は作成しません。 KDPF33001-W

レイアウト形式が［ユーザ登録形式］で，選択済みのポートレットのサイズとレイアウトパターンの列幅サイズが異なる場合ポートレット（PortletBean）は作成しません。 KDPF33001-W

一つの行内にポートレットが存在しない場合ポートレットが存在しない行（LayoutBean）は作成しません。－

パラメタ

なし

戻り値

なし

例外

IllegalStateException - 部門管理者の場合で，現在設定しているカスタマイズ情報がディスクまたはディレクトリに存在しない場合
getDefaultURL
形式
public java.lang.String getDefaultURL()
機能

［レイアウト編集画面］で現在のレイアウト情報を標準の設定に戻すときのURLを取得します。

パラメタ

なし

戻り値

［標準に戻す］をクリックしたときのURL

［レイアウト編集画面］以外ではnullを返却します。

例外

なし
getDeviceBeans
形式
public DeviceBean[] getDeviceBeans()
機能

すべてのクライアントの画面構成オブジェクトを取得します。

パラメタ

なし

戻り値

DeviceBeanクラスのリスト

例外

なし
getEditDeviceBean
形式
public DeviceBean getEditDeviceBean()
機能

現在編集中のDeviceBeanオブジェクトを取得します。

パラメタ

なし

戻り値

現在編集中のDeviceBeanオブジェクト

例外

なし
getEditDeviceCode
形式
public int getEditDeviceCode()
機能

現在編集中のクライアント種別を取得します。［適用］，［戻る］，および［標準に戻す］で処理されるクライアント種別は，public int getEditDeviceCode()で得られるクライアント種別のレイアウト情報です。デフォルトではLayoutCustomizeBean.HTMLを設定しています。

パラメタ

なし

戻り値

値内容

LayoutCustomizeBean.HTML PCブラウザ用画面

LayoutCustomizeBean.CHTML iモード用画面

LayoutCustomizeBean.HDML EZweb用画面

例外

なし
getEditLayoutGroup
形式
public java.lang.String getEditLayoutGroup()
機能

現在編集中のレイアウトグループ名称を取得します。

例えば，次のファイルを編集中の場合，"layout1"を返却します。

C:\portal\webapp\psml\group\layout1

パラメタ

なし

戻り値

レイアウトグループ名称

ファイルの編集中でない場合，nullを返却します。

例外

なし
getEditPSMLPath
形式
public java.lang.String getEditPSMLPath()
機能

現在編集中のポートレット配置情報ファイル（PSMLファイル）のパスを取得します。

例：C:\portal\webapp\psml

パラメタ

なし

戻り値

管理者用レイアウトカスタマイズ画面の場合：ポートレット配置情報ファイル（PSMLファイル）のパス

最初に呼び出したときは，ポータルプロジェクト上のポートレット配置情報ファイル（PSMLファイル）のパスを返却します。ポートレット配置情報ファイルのパスはvoid setEditPSMLPathメソッドで変更できます。

利用者用レイアウトカスタマイズ画面の場合：null

例外

なし
getErrorMessages
形式
public java.lang.String[] getErrorMessages()
機能

カスタマイズ操作によるエラーメッセージを取得します。

パラメタ

なし

戻り値

エラーメッセージ

エラーが発生しなかった場合はnullを返却します。

例外

なし
getForceMode
形式
public int getForceMode()
機能

現在の強制モードを取得します。

パラメタ

なし

戻り値

強制タブモード：0

強制編集モード：1

上記以外：-1

例外

なし
getForceTabName
形式
public java.lang.String getForceTabName()
機能

管理者が強制表示タブを編集中の場合，強制表示タブを取得します。

パラメタ

なし

戻り値

強制表示タブが設定されており，管理者が強制表示タブを編集中の場合：強制表示タブのタブ名称

上記以外の場合：null

例外

なし
getHomeURL
形式
public java.lang.String getHomeURL()
機能

［レイアウト編集画面］でレイアウト情報を更新し，カスタマイズ画面から通常の画面に戻るときのURLを取得します。

パラメタ

なし

戻り値

［レイアウト編集画面］から通常の画面に戻るときのURL

［レイアウト編集画面］以外では，nullを返却します。

例外

なし
getLayoutCustomizeUtil
形式
public LayoutCustomizeUtil getLayoutCustomizeUtil()
機能

カスタマイズで使用するライブラリを取得します。

パラメタ

なし

戻り値

カスタマイズのライブラリクラス

例外

なし
getLayoutID
形式
public java.lang.String getLayoutID()
機能

部門管理者のレイアウトグループIDを取得します。

パラメタ

なし

戻り値

部門管理者のレイアウトグループID

ただし，部門管理者のレイアウトグループの種類が"default"の場合（部門管理者がレイアウトグループに属していない場合）は，nullを返却します。

例外

なし
getLayoutPatterns
形式
public java.lang.String[][] getLayoutPatterns()
機能

登録されているレイアウトパターンの名称と表示名称のリストを取得します。

取得の設定は次のようになっています。

java.lang.String[][0]：レイアウトパターンの名称

java.lang.String[][1]：レイアウトパターンの表示名称

パラメタ

なし

戻り値

Controllers.xmlファイルに設定されている場合：レイアウトパターンの名称とレイアウトパターンの表示名称のリスト

Controllers.xmlファイルを設定していない場合：null

例外

なし
getMaxColumn
形式
public int getMaxColumn()
機能

表示できる最大列数を取得します。

パラメタ

なし

戻り値

Controllers.xmlファイルに設定されている場合：0以上

上記以外の場合：-1

例外

なし
getMaxRow
形式
public int getMaxRow()
機能

表示できる最大行数を取得します。

パラメタ

なし

戻り値

Controllers.xmlファイルに設定されている場合：0以上

上記以外の場合：-1

例外

なし
getMode
形式
public int getMode()
機能

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

パラメタ

なし

戻り値

システム管理者：0

部門管理者：1

利用者：2

上記以外：-1

例外

なし
getPortletGroupBeans
形式
public PortletGroupBean[] getPortletGroupBeans()
機能

ポートレットグループのリストを取得します。

パラメタ

なし

戻り値

ポートレットグループ一覧

例外

なし
getRootPortletGroupBean
形式
public PortletGroupBean[] getRootPortletGroupBean()
機能

最上位のポートレットグループの配列を取得します。

パラメタ

なし

戻り値

最上位のポートレットグループの配列を返却します。

ポートレットグループが存在しない場合は，空配列を返却します。

例外

EmPowermentException - リポジトリへの接続に失敗した場合
getSelectedTabName
形式
public java.lang.String getSelectedTabName()
機能

各ユーザのホーム画面で表示しているタブ名称を取得します。［レイアウト編集画面］で，PCブラウザ用のレイアウト形式に［タブ形式］を使用しており，現在のホーム画面で選択中のタブを取得したい場合に使用します。カスタマイズBeanによるレイアウトのカスタマイズ実行前に必ず取得してください。［レイアウト編集画面］以外でカスタマイズBeanを使用する場合は，getContentを実行したあとで呼び出してください。

パラメタ

なし

戻り値

ホーム画面で現在選択しているタブ名称

タブ形式でない場合，および強制表示タブが選択されている場合は，nullを返却します。

例外

なし
initBean
形式
public void initBean(ServletRequest request,
                    boolean adminmode)
機能

［レイアウト編集画面］以外でBeanを初期化します。

パラメタ

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

adminmode - true：システム管理者用，false：ポータル利用者用

戻り値

なし

例外

IllegalArgumentException - パラメタにnullを指定した場合
isAdminMode
形式
public boolean isAdminMode()
機能

管理者用レイアウトカスタマイズ画面であるかを判定します。

パラメタ

なし

戻り値

true：管理者用レイアウトカスタマイズ画面の場合

false：利用者用レイアウトカスタマイズ画面の場合

例外

なし
isForceLayout
形式
public boolean isForceLayout()
機能

ファイル編集中の場合に現在編集中のレイアウトが強制表示レイアウトであることを表示します。

パラメタ

なし

戻り値

true：強制表示レイアウトである

false：強制表示レイアウトでない，または編集中である

例外

なし
setChangeLayoutGroup
形式
public void setChangeLayoutGroup(java.lang.String layoutGroupName)
機能

現在編集中のレイアウトグループ名称を別の名称に変更します。

レイアウトグループ名称はgetEditLayoutGroup()メソッドで取得できるレイアウトグループ名称です。getEditLayoutGroup()メソッドについては，「LayoutCustomizeBeanクラス」の「getEditLayoutGroup」を参照してください。

パラメタ

layoutGroupName - 変更後のレイアウトグループ名称

戻り値

なし

例外

なし
setContents
形式
public void setContents()
機能

現在設定しているカスタマイズ情報を保存します。

システム管理者が設定している情報は，ディスクに保存します。

また，ポータル利用者が設定している情報は，ディレクトリの情報を更新

します。ディレクトリへの書き込みは，ログアウトが行われた時に発生します。

isAdminMode()がtrueの場合

次の設定後，このメソッドを呼び出します。

保存対象のクライアントの設定：setEditDeviceCode(int)

保存対象のパスの設定：setEditPSMLPath(java.lang.String)

保存対象のレイアウトグループの設定：setEditLayoutGroup(java.lang.String)

保存対象のレイアウトグループ名称を変更する場合，変更後レイアウトグループの設定：setChangeLayoutGroup(java.lang.String)

パラメタの設定：LayoutBean.setParameter(Object, Object)
保存対象のレイアウト情報（DeviceBean）のレイアウト形式(LayoutBean.getLayoutCode) が次の場合だけ必要です。
行列形式：LayoutCustomizeBean.RowColumn
グリッド形式：LayoutCustomizeBean.Grid

保存対象のレイアウト情報の設定：setDeviceBean(DeviceBean[])

isAdminMode()がfalseの場合

次の設定後，このメソッドを呼び出します。

保存対象のクライアントの設定：setEditDeviceCode(int)

パラメタの設定：LayoutBean.setParameter(Object, Object)
保存対象のレイアウト情報（DeviceBean）のレイアウト形式(LayoutBean.getLayoutCode) が次の場合だけ必要です。
行列形式：LayoutCustomizeBean.RowColumn
グリッド形式：LayoutCustomizeBean.Grid

保存対象のレイアウト情報の設定：setDeviceBean(DeviceBean[])

パラメタ

なし

戻り値

なし

例外

なし
setDeviceBeans
形式
public void setDeviceBeans(DeviceBean [] setDeviceBeans)
機能

すべてのクライアント画面構成オブジェクトのリストを設定します。ただし，このメソッドは推奨いたしません。

パラメタ

setDeviceBeans - すべてのクライアント画面構成オブジェクトのリスト

戻り値

なし

例外

なし
setEditDeviceCode
形式
public void setEditDeviceCode(int deviceCode)
機能

現在編集中のクライアント種別を設定します。例えば，クライアント種別のドロップダウンリストと［変更］を作成して，ユーザが異なるクライアントの編集を選択した場合に，クライアントを再設定します。クライアント種別は必ず設定します。デフォルトでは，LayoutCustomizeBean.HTMLを設定します。

パラメタ

deviceCode - クライアント種別

クライアント種別説明

LayoutCustomizeBean.HTML PCブラウザ用画面

LayoutCustomizeBean.CHTML iモード用画面

LayoutCustomizeBean.HDML EZweb用画面

上記以外例外が発生します。

戻り値

なし

例外

java.lang.IllegalArgumentException
setEditLayoutGroup
形式
public void setEditLayoutGroup(java.lang.String layout)
機能

現在編集中のレイアウトグループ名称を設定します。引数の指定によって，編集するコンテンツが異なります。XXXXはHTMLなどのクライアント種別を示します。

引数がnullの場合：C:\portal\webapp\psml\homeXXXX.psml

引数がnull以外の場合（"layout1"）：C:\portal\webapp\psml\group\layout1\homeXXXX.psml

パラメタ

layout - 読み込むファイルのレイアウトグループ

nullの場合，getEditPSMLPathメソッドで取得したディレクトリ直下のポートレット配置情報ファイル（PSMLファイル）を取得します。getEditPSMLPathメソッドの結果がnullでない場合だけ有効です。

戻り値

なし

例外

なし
setEditPSMLPath
形式
public void setEditPSMLPath(java.lang.String path)
機能

現在編集中のポートレット配置情報ファイル（PSMLファイル）のパスを設定します。

例：C:\portal\webapp\psml

パラメタ

path - 編集するポートレット配置情報ファイル（PSMLファイル）のパス

nullを指定した場合，現在のポータルプロジェクトのポートレット配置情報ファイル（PSMLファイル）のパスが設定されます。

戻り値

なし

例外

なし
setRemoveLayoutGroup
形式
public void setRemoveLayoutGroup(java.lang.String layoutGroupName)
機能

レイアウトグループを削除します。

パラメタ

layoutGroupName - 削除するレイアウトグループ名称

戻り値

なし

例外

なし
setSelectedLayoutList
形式
public void setSelectedLayoutList(java.util.Vector lv)
機能

このデバイスBeanが取得している選択済みのレイアウトの一覧を設定します。

追加の場合
追加するレイアウトはポートレット配置情報ファイル（PSMLファイル）から読み込みます。
合成位置は，管理者が定義したレイアウトの表示順序に従います。ユーザ定義しかない場合は，常に管理者が定義したレイアウトの方が前に設定されます。行列形式に追加する場合は，タブが付加され合成されます。

削除の場合
レイアウトを削除します。
元のレイアウトが１個になり，管理者が定義したレイアウトでタブ形式以外の場合は，タブが取り除かれます。

例
layout1（未選択），layout2（選択），layout3（未選択），layout4（選択）
layout1（選択），layout2（選択）
この場合，
layout1は，（未選択）→（選択）のため，ファイルから情報を読み込み，合成します。先頭に追加されます。
layout2は，（選択）→（選択）のため，何もしません（情報を更新しない）。
layout3は，（未選択）→（未選択）のため何もしません。
layout4は，（選択）→（未選択）のため削除します。
上記を合成していきますが，最後に配色を合成します。配色は従来から指定されていたものを優先します。

パラメタ

lv - 選択したレイアウト（nullは指定しないでください）

戻り値

なし

例外

なし
setSelectedTabName
形式
public void setSelectedTabName(java.lang.String selectedTabName)
機能

各利用者のホーム画面で現在選択中のタブ名称を設定します。

PCブラウザ用のレイアウト形式にタブ形式を使用していて，現在ホーム画面で選択中のタブを変更したい場合に使用します。カスタマイズBeanによるレイアウトのカスタマイズ実行前に必ず取得してください。［レイアウト編集画面］以外でこのメソッドを使用する場合，getContentメソッド実行後に呼び出してください。

パラメタ

selectedTabName - 各利用者のホーム画面で選択中のタブ名称を設定します。

戻り値

なし

例外

なし

注意事項

タブ形式の場合，設定してください。

タブ形式以外の場合は，設定が無効となります。また，タブ名称をnullに指定した場合も設定が無効となります。設定が無効となった場合は，前回表示していたタブ名称を表示します。

条件	補正方法	ログ
レイアウト形式が［ユーザ登録形式］でレイアウトパターンが無効な場合	レイアウト形式を［行列形式（列ベース）］にします。	KDPF33001-W
選択済みのポートレットが存在しない場合	ポートレット（PortletBean）は作成しません。	KDPF33001-W
選択済みのポートレットに対してアクセス権がない場合	ポートレット（PortletBean）は作成しません。	KDPF33001-W
レイアウト形式が［ユーザ登録形式］で，選択済みのポートレットのサイズとレイアウトパターンの列幅サイズが異なる場合	ポートレット（PortletBean）は作成しません。	KDPF33001-W
一つの行内にポートレットが存在しない場合	ポートレットが存在しない行（LayoutBean）は作成しません。	－

値	内容
LayoutCustomizeBean.HTML	PCブラウザ用画面
LayoutCustomizeBean.CHTML	iモード用画面
LayoutCustomizeBean.HDML	EZweb用画面

クライアント種別	説明
LayoutCustomizeBean.HTML	PCブラウザ用画面
LayoutCustomizeBean.CHTML	iモード用画面
LayoutCustomizeBean.HDML	EZweb用画面
上記以外	例外が発生します。

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

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