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

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

機能

一つのレイアウトカスタマイズ画面を構成するBeanです。

Beanの項目

宣言

このBeanを単独で宣言できません。

対象スコープ

なし

メソッドの一覧

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

int getArrangement() 強制ポートレットの配置を取得します。

java.lang.String getBackgroundColor() 背景色を取得します。

int getGridMaxColumn() グリッド形式レイアウトの場合，最大列数を取得します。

int getGridMaxRow() グリッド形式レイアウトの場合，最大行数を取得します。

LayoutBean[] getLayoutBeans() レイアウトオブジェクトのリストを取得します。

int getLayoutCode() レイアウト形式を取得します。

java.lang.String getLayoutPattern() ユーザ登録形式の場合，レイアウトパターン名を取得します。

int getPaddingSize() パディングのサイズを取得します。

PortletBean getPortletBeanByPortletID(java.lang.String PortletID) 指定されたポートレットIDを持つPortletBeanを取得します。

PortletBean[] getPortletBeans() ポートレット群を取得します。

int getRowColumnMode() 行列形式のレイアウトの場合，行ベースまたは列ベースのモードを取得します。

int getRulerSize() ルーラーのサイズを取得します。

java.lang.String getSelectedColor() タブ形式の場合，選択したタブの色を取得します。

java.lang.String getTitle() タブ形式の場合，タブ名称を取得します。

java.lang.String getTitleColor() タイトル色を取得します。

boolean isForceTab() 強制編集画面で，強制タブかどうかを判断します。

void setBackgroundColor(java.lang.String color) 背景色を設定します。

void setLayoutBeans(LayoutBean[] layoutbeans) レイアウトオブジェクトのリストを設定します。

void setLayoutCode(int layoutcode) レイアウト形式を設定します。

void setLayoutPattern(java.lang.String pattern) ユーザ登録形式の場合，レイアウトパターン名を設定します。

void setPaddingSize(int size) 行列形式，ユーザ登録形式，またはグリッド形式の場合に，パディングのサイズを設定します。

void setParameter(Object key, Object value) タブ形式，行列形式，またはグリッド形式の場合，ポートレットを表示する幅の画面分割比率を設定します。

void setPortletBeans(PortletBean[] beans) ポートレット群を設定します。

void setRowColumnMode(int mode) 行列形式のレイアウトの場合，行ベースまたは列ベースのモードを設定します。

void setRulerSize(int size) ルーラーのサイズを設定します。

void setSelectedColor(java.lang.String color) タブ形式の場合，選択したタブの色を設定します。

void setTitle(java.lang.String name) タブ形式の場合，タブ名称を設定します。

void setTitleColor(java.lang.String color) タイトル色を設定します。

戻り値のデータ型	メソッド	説明
int	getArrangement()	強制ポートレットの配置を取得します。
java.lang.String	getBackgroundColor()	背景色を取得します。
int	getGridMaxColumn()	グリッド形式レイアウトの場合，最大列数を取得します。
int	getGridMaxRow()	グリッド形式レイアウトの場合，最大行数を取得します。
LayoutBean[]	getLayoutBeans()	レイアウトオブジェクトのリストを取得します。
int	getLayoutCode()	レイアウト形式を取得します。
java.lang.String	getLayoutPattern()	ユーザ登録形式の場合，レイアウトパターン名を取得します。
int	getPaddingSize()	パディングのサイズを取得します。
PortletBean	getPortletBeanByPortletID(java.lang.String PortletID)	指定されたポートレットIDを持つPortletBeanを取得します。
PortletBean[]	getPortletBeans()	ポートレット群を取得します。
int	getRowColumnMode()	行列形式のレイアウトの場合，行ベースまたは列ベースのモードを取得します。
int	getRulerSize()	ルーラーのサイズを取得します。
java.lang.String	getSelectedColor()	タブ形式の場合，選択したタブの色を取得します。
java.lang.String	getTitle()	タブ形式の場合，タブ名称を取得します。
java.lang.String	getTitleColor()	タイトル色を取得します。
boolean	isForceTab()	強制編集画面で，強制タブかどうかを判断します。
void	setBackgroundColor(java.lang.String color)	背景色を設定します。
void	setLayoutBeans(LayoutBean[] layoutbeans)	レイアウトオブジェクトのリストを設定します。
void	setLayoutCode(int layoutcode)	レイアウト形式を設定します。
void	setLayoutPattern(java.lang.String pattern)	ユーザ登録形式の場合，レイアウトパターン名を設定します。
void	setPaddingSize(int size)	行列形式，ユーザ登録形式，またはグリッド形式の場合に，パディングのサイズを設定します。
void	setParameter(Object key, Object value)	タブ形式，行列形式，またはグリッド形式の場合，ポートレットを表示する幅の画面分割比率を設定します。
void	setPortletBeans(PortletBean[] beans)	ポートレット群を設定します。
void	setRowColumnMode(int mode)	行列形式のレイアウトの場合，行ベースまたは列ベースのモードを設定します。
void	setRulerSize(int size)	ルーラーのサイズを設定します。
void	setSelectedColor(java.lang.String color)	タブ形式の場合，選択したタブの色を設定します。
void	setTitle(java.lang.String name)	タブ形式の場合，タブ名称を設定します。
void	setTitleColor(java.lang.String color)	タイトル色を設定します。

メソッドの説明

getArrangement
形式
public int getArrangement()
機能

強制ポートレットの配置を取得します。

パラメタ

なし

戻り値

配置が左上：1

配置が左下：2

配置が右上：3

配置が右下：4

例外

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

背景色を取得します。

パラメタ

なし

戻り値

背景色を"#rrggbb"形式で返却します。

例外

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

グリッド形式レイアウトの場合，最大列数を取得します。

パラメタ

なし

戻り値

グリッド形式レイアウトの最大列数

例外

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

グリッド形式レイアウトの場合，最大行数を取得します。

パラメタ

なし

戻り値

グリッド形式レイアウトの最大行数

例外

なし
getLayoutBeans
形式
public LayoutBean[] getLayoutBeans()
機能

このレイアウト下のレイアウトオブジェクトのリストを取得します。

パラメタ

なし

戻り値

レイアウトオブジェクトのリスト

例外

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

レイアウト形式を取得します。

パラメタ

なし

戻り値

レイアウト形式に対応する値を返却します。

次のどれかの値が戻されます。

値内容

LayoutCustomizeBean.Tab タブ形式

LayoutCustomizeBean.RowColumn 行列形式

LayoutCustomizeBean.Grid グリッド形式

LayoutCustomizeBean.Flow フロー形式

LayoutCustomizeBean.User ユーザ登録形式

LayoutCustomizeBean.CHTMLCard CHTMLカード形式

LayoutCustomizeBean.HDMLCard HDMLカード形式

例外

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

ユーザ登録形式の場合，レイアウトパターン名を取得します。

パラメタ

なし

戻り値

ユーザ登録形式のレイアウトの場合，ユーザ登録形式のレイアウトパターン名を取得します。

上記以外のレイアウトの場合，nullを返却します。

例外

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

パディングのサイズを取得します。

パラメタ

なし

戻り値

行列形式，ユーザ登録形式，またはグリッド形式のレイアウトの場合，パディングのサイズを取得します。

上記以外のレイアウトの場合，-1を返却します。

例外

なし
getPortletBeanByPortletID
形式
public PortletBean getPortletBeanByPortletID(java.lang.String PortletID)
機能

指定されたポートレットIDを持つPortletBeanを取得します。

パラメタ

PortletID - ポートレットID

戻り値

PortletIDに該当するPortletBeanオブジェクトを返却します。

PortletIDがnullの場合は，先頭のportletBeanオブジェクトを返却します。

例外

なし
getPortletBeans
形式
public PortletBean[] getPortletBeans()
機能

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

パラメタ

なし

戻り値

ポートレット群

例外

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

行列形式のレイアウトの場合，行ベースまたは列ベースのモードを取得します。

パラメタ

なし

戻り値

行列種別を返却します。

次のどちらかの値が戻されます。

値内容

LayoutCustomizeBean.RowColumnModeRow 行列形式（列ベース）

LayoutCustomizeBean.RowColumnModeColumn 行列形式（行ベース）

例外

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

ルーラーのサイズを取得します。

パラメタ

なし

戻り値

タブ形式のレイアウトの場合は，ルーラーのサイズを取得します。

上記以外の場合は，-1を返却します。

例外

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

タブ形式の場合，選択したタブの色を取得します。

パラメタ

なし

戻り値

選択したタブの色を"#rrggbb"形式で返却します。

例外

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

タブ形式の場合，タブの名称を取得します。

パラメタ

なし

戻り値

タブ名称

例外

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

タイトル色を取得します。

パラメタ

なし

戻り値

タイトル色を"#rrggbb"形式で返却します。

例外

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

強制編集画面で，強制タブかどうかを判断します。

パラメタ

なし

戻り値

true：強制タブの場合

false：強制タブでない場合

例外

なし
setBackgroundColor
形式
public void setBackgroundColor(java.lang.String color)
機能

背景色を設定します。

パラメタ

color - 背景色

colorは#rrggbb形式で設定します。#rrggbb形式以外の場合，指定を無視します。

背景色を標準配色に設定する場合は，nullを指定します。

戻り値

なし

例外

なし
setLayoutBeans
形式
public void setLayoutBeans(LayoutBean[] layoutbeans)
機能

このレイアウト下のレイアウトオブジェクトのリストを設定します。

パラメタ

layoutbeans - レイアウト下のレイアウトオブジェクトのリスト

戻り値

なし

例外

なし
setLayoutCode
形式
public void setLayoutCode(int layoutcode)
機能

レイアウト形式を設定します。

パラメタ

layoutcode - レイアウト種別

レイアウト種別内容

LayoutCustomizeBeanTab タブ形式

LayoutCustomizeBean.RowColumn 行列形式

LayoutCustomizeBean.Grid グリッド形式

LayoutCustomizeBean.Flow フロー形式

LayoutCustomizeBean.User ユーザ登録形式

LayoutCustomizeBean.CHTMLCard CHTMLカード形式

LayoutCustomizeBean.HDMLCard HDMLカード形式

戻り値

なし

例外

なし
setLayoutPattern
形式
public void setLayoutPattern(java.lang.String pattern)
機能

ユーザ登録形式の場合，レイアウトパターン名を設定します。

パラメタ

pattern - レイアウトパターン名を設定します。

patternがnull以外で，かつユーザ登録形式以外の場合，レイアウトパターン名を設定しません。

戻り値

なし

例外

IllegalArgumentException - パラメタに存在しないレイアウトパターン名を指定した場合およびユーザ登録形式の場合に，nullを指定したとき。
setPaddingSize
形式
public void setPaddingSize(int size)
機能

行列形式，ユーザ登録形式，またはグリッド形式の場合，パディングのサイズを設定します。

パラメタ

size - パディングのサイズ

sizeに指定する値を次に示します。

指定サイズを設定するとき：0以上

デフォルトサイズを設定する場合：-1

なお，sizeが0以上で，かつ行列形式，ユーザ登録形式，またはグリッド形式の場合，もしくはsizeが-1の場合は，指定を無視します。

戻り値

なし

例外

なし
setParameter
形式
public void setParameter(Object key,
                         Object value)
機能

タブ形式，行列形式，またはグリッド形式の場合，ポートレットを表示する幅の比率を設定します。

パラメタ

key - 設定するパラメタ名称

value - 設定するパラメタ値

パラメタ値内容

key "sizes" レイアウトが行列形式，またはタブ形式のタブ内が行列形式の場合，各列または各行の画面の分割比率を設定します。

"columnWidths" グリッド形式の場合，各行の画面の分割比率を設定します。

value "xx%,yy%,..." 画面をxx対yyの割合で左右に分割します。コンマで区切って複数指定できます。

戻り値

なし

例外

なし
setPortletBeans
形式
public void setPortletBeans(PortletBean[] beans)
機能

レイアウトに含まれるポートレット群を設定します。

パラメタ

beans - ポートレット群

戻り値

なし

例外

なし
setRowColumnMode
形式
public void setRowColumnMode(int mode)
機能

行列形式のレイアウトの場合，行ベースまたは列ベースのモードを設定します。

パラメタ

mode - 行列種別

行列種別内容

LayoutCustomizeBean.RowColumnModeRow 行列形式（列ベース）

LayoutCustomizeBean.RowColumnModeColumn 行列形式（行ベース）

戻り値

なし

例外

なし
setRulerSize
形式
public void setRulerSize(int size)
機能

タブ形式の場合，ルーラーのサイズを設定します。

パラメタ

size - ルーラーのサイズをドットで指定します。

-1の場合は，ルーラーのサイズを標準値に設定します。

sizeが0以上でタブ形式以外である場合，または-1未満の場合は，指定を無視します。

戻り値

なし

例外

なし
setSelectedColor
形式
public void setSelectedColor(java.lang.String color)
機能

タブ形式の場合，選択したタブの色を設定します。

パラメタ

color - 選択したタブの色

colorは#rrggbb形式で設定します。#rrggbb形式でタブ形式以外の場合，または#rrggbb形式以外の場合，指定を無視します。

選択したタブの色を標準配色に設定する場合は，nullを指定します。

戻り値

なし

例外

なし
setTitle
形式
public void setTitle(java.lang.String name)
機能

タブ形式の場合，タブの名称を設定します。

パラメタ

name - タブ名称

戻り値

なし

例外

なし

注意事項

IllegalArgumentException - パラメタに次のタブ名称を指定した場合，警告ログ（KDPF11462）を出力します。

指定無し（nullまたは””（文字列なし））のタブ名

数字だけのタブ名

65文字以上のタブ名

「-」「#」「'」以外の半角記号を含むタブ名

先頭の文字が半角記号のタブ名
setTitleColor
形式
public void setTitleColor(java.lang.String color)
機能

タイトル色を設定します。

パラメタ

color - タイトル色

colorは#rrggbb形式で設定します。#rrggbb形式以外の場合，指定を無視します。

タイトルの色を標準配色に設定する場合は，nullを指定します。

戻り値

なし

例外

なし

値	内容
LayoutCustomizeBean.Tab	タブ形式
LayoutCustomizeBean.RowColumn	行列形式
LayoutCustomizeBean.Grid	グリッド形式
LayoutCustomizeBean.Flow	フロー形式
LayoutCustomizeBean.User	ユーザ登録形式
LayoutCustomizeBean.CHTMLCard	CHTMLカード形式
LayoutCustomizeBean.HDMLCard	HDMLカード形式

値	内容
LayoutCustomizeBean.RowColumnModeRow	行列形式（列ベース）
LayoutCustomizeBean.RowColumnModeColumn	行列形式（行ベース）

レイアウト種別	内容
LayoutCustomizeBeanTab	タブ形式
LayoutCustomizeBean.RowColumn	行列形式
LayoutCustomizeBean.Grid	グリッド形式
LayoutCustomizeBean.Flow	フロー形式
LayoutCustomizeBean.User	ユーザ登録形式
LayoutCustomizeBean.CHTMLCard	CHTMLカード形式
LayoutCustomizeBean.HDMLCard	HDMLカード形式

パラメタ	値	内容
key	"sizes"	レイアウトが行列形式，またはタブ形式のタブ内が行列形式の場合，各列または各行の画面の分割比率を設定します。
"columnWidths"	グリッド形式の場合，各行の画面の分割比率を設定します。
value	"xx%,yy%,..."	画面をxx対yyの割合で左右に分割します。コンマで区切って複数指定できます。

行列種別	内容
LayoutCustomizeBean.RowColumnModeRow	行列形式（列ベース）
LayoutCustomizeBean.RowColumnModeColumn	行列形式（行ベース）

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

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