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

機能

[レイアウト編集画面]のJSPで使用するライブラリです。

LayoutCustomizeBean.getLayoutCustomizeUtil()メソッドを使用して取得します。

Beanの項目

宣言
このBeanを単独で宣言できません。
対象スコープ
なし

メソッドの一覧

戻り値のデータ型メソッド説明
voidaddLayoutGroup(java.lang.String layoutgroupname)指定したレイアウトグループを追加します。
booleanaddPortletForGrid(int columnno, int rowno, java.lang.String portlet, LayoutBean lb)グリッド形式の場合,指定した位置にポートレットを追加します。
intaddPortletsForColumn(int lineno, java.lang.String[] portlets, LayoutBean lb)指定した列にポートレットを追加します。
intaddPortletsForRow(int lineno, java.lang.String[] portlets, LayoutBean lb)指定した行にポートレットを追加します。
intaddTab(java.lang.String tabname, int pos)タブ形式の場合,指定した位置の後ろにタブを追加します。
voidchangeArrangement(int iArrangement, LayoutBean lb)強制ポートレットの配置を変更します。
voidchangeColor(int stylecode, java.lang.String color)スタイルの色を変更します。
voidchangeLayoutCode(int layoutcode)レイアウト形式を変更します。
voidchangeLayoutPattern(java.lang.String pattern, LayoutBean lb)ユーザ登録形式のレイアウトパターンを変更します。
voidchangeRowColumnMode(int mode, LayoutBean lb)行列形式の行ベースまたは列ベースのモードを変更します。
voidchangeSize(int stylecode, int size)スタイルのサイズを変更します。
voidchangeStyle(int stylecode)スタイル種別を変更します。
java.lang.StringgetColor(int stylecode)スタイルに設定されている色を取得します。
LayoutBeangetEditLayoutBean()編集中のLayoutBeanオブジェクト取得します。
LayoutBeangetEditLayoutBean(LayoutBean lb, java.lang.String title)指定したタブ内のLayoutBeanオブジェクトを取得します。
intgetSize(int stylecode)スタイルに設定されているサイズを取得します。
intgetStyle()スタイル種別を取得します。
booleanisSelectedPortlet(java.lang.String portlet, LayoutBean lb)指定したポートレットが追加済みであることを示します。
intmovePortlet(java.lang.String portletID, int movecode, LayoutBean lb)指定したポートレットを移動します。
intmoveTab(java.lang.String tabname, int movecode)タブ形式の場合,指定したタブを移動します。
voidremoveForceTab()強制タブを編集中の場合,強制タブを削除します。
booleanremovePortlet(java.lang.String portletID, LayoutBean lb)指定したポートレットを削除します。
booleanremovePortlets(int lineno, LayoutBean lb)行列形式の場合,指定した行または列に配置されているポートレットをすべて削除します。
booleanremoveTab(java.lang.String tabname)タブ形式の場合,指定したタブを削除します。

メソッドの説明

addLayoutGroup
形式

public void addLayoutGroup(java.lang.String layoutgroupname)

機能
指定したレイアウトグループを追加します。
パラメタ
layoutgroupname - 追加するレイアウトグループ名
パラメタlayoutgroupnameに存在しないレイアウトグループ名を指定します。
レイアウトグループ名称で指定できるレイアウトグループ名は,先頭が英字で,2文字目以降が半角の英数字です。なお,大文字・小文字を区別しません。また,存在するレイアウトグループ名は指定できません。
戻り値
なし
例外
java.lang.IllegalStateException - レイアウトグループを追加できない場合
  • パラメタlayoutgroupnameに,存在するレイアウトグループを指定した
  • パラメタlayoutgroupnameに,不正なレイアウトグループ名を指定した
  • 管理者モードでない
  • ポートレット配置情報ファイル(PSMLファイル)のパスが指定されていない
  • ポートレット配置情報ファイル(PSMLファイル)が作成できない
addPortletForGrid
形式

public boolean addPortletForGrid(int columnno,
                              int rowno,
                              java.lang.String portlet,
                              LayoutBean lb)

機能
グリッド形式の場合,指定した位置にポートレットを追加します。
パラメタ
columnno - 列番号
グリッド形式で1から始まる列番号を指定します。
rowno - 行番号
グリッド形式で1から始まる行番号を指定します。
portlet - 追加するポートレットのポートレット名
lb - 追加対象のLayoutBeanオブジェクト
LayoutBeanオブジェクトには,グリッド形式で,編集中のLayoutBeanを指定します。
戻り値
true:追加
false:未追加
なお,次の場合は,ポートレットを追加しないでfalseを返却します。
  • 存在しない行番号または列番号を指定した場合
  • 追加済みのポートレットを指定した場合
  • 存在しないポートレット名を指定した場合
例外
java.lang.IllegalArgumentException -
  • columnnoに,指定できない値を指定した場合
  • rownoに,指定できない値を指定した場合
  • lbに,グリッド形式以外の不正なLayoutBeanオブジェクトを指定した場合
addPortletsForColumn
形式

public int addPortletsForColumn(int lineno,
                               java.lang.String[] portlets,
                               LayoutBean lb)

機能
指定した列にポートレットを追加します。
パラメタ
lineno - 列番号
linenoに指定する値を次に示します。
  • 行列形式(列ベース):1から始まる列番号
  • ユーザ登録形式:1から始まる列番号
  • グリッド形式:最大列数+1
  • フロー形式:1
  • カード形式(CHTML):1
  • カード形式(HDML):1
なお,存在しない列番号を指定した場合は,新規に列を作成してポートレットを追加します。また,存在しないポートレット名を指定した場合,および追加済みのポートレットを指定した場合は,そのポートレットは追加されません。
ユーザ登録形式の場合,指定された列に設定されているサイズと異なるサイズのポートレットを指定すると,そのポートレットは追加しません。
グリッド形式の場合,linenoには (LayoutCustomizeUtil.getEditLayoutBean().getGridMaxColumn()で取得した値+1)を指定します。
 
portlets - 追加するポートレットのポートレット名のリスト
 
lb - 追加対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。
  • タブ形式以外:現在編集中のLayoutBean
  • タブ形式:タブ内のLayoutBean
戻り値
追加した列の位置
未追加の場合は-1を返却します。
例外
java.lang.IllegalArgumentException -
  • linenoに,指定できない値を指定した場合
  • lbに,不正なLayoutBeanオブジェクトを指定した場合
addPortletsForRow
形式

public int addPortletsForRow(int lineno,
                           java.lang.String[] portlets,
                           LayoutBean lb)

機能
指定した行にポートレットを追加します。
パラメタ
lineno - 行番号
linenoに指定する値を次に示します。
  • 行列形式(行ベース):1から始まる行番号
  • グリッド形式:最大行数+1
存在しない行番号を指定した場合は,新規に行を作成しポートレットを追加します。存在しないポートレット名を指定した場合,および,追加済みのポートレットを指定した場合は,そのポートレットは追加しません。
グリッド形式の場合は,linenoに (LayoutCustomizeUtil.getEditLayoutBean().getGridMaxRow()で取得した値+1)を指定します。
 
portlets - 追加するポートレットのポートレット名のリスト
 
lb - 追加対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。
  • タブ形式以外:現在編集中のLayoutBean
  • タブ形式:タブ内のLayoutBean
戻り値
- 追加した行の位置
未追加の場合は,-1を返却します。
例外
java.lang.IllegalArgumentException -
  • linenoに,指定できない値を指定した場合
  • lbに,不正なLayoutBeanオブジェクトを指定した場合
addTab
形式

public int addTab(java.lang.String tabname,
                  int pos)

機能
タブ形式の場合,指定した位置の後ろにタブを追加します。
パラメタ
tabname - 追加するタブ名
tabnameには,存在しないタブ名を指定します
 
pos - 追加位置
posには,1から始まるタブ位置を指定します。新規にタブを追加する場合は,1を指定します。
戻り値
- 追加したタブの位置
未追加の場合は,-1を返却します。
なお,存在するタブ名を指定した場合はタブを追加しないで,エラーログ(KDPF11461-E)を出力し,-1を返却します。
例外
java.lang.IllegalArgumentException - tabnameにnullまたは次の不正なタブ名を指定した場合,およびposに指定できない値を指定した場合
  • 指定無し(nullまたは””(文字列なし))のタブ名
  • 65文字以上のタブ名
  • 数字だけのタブ名
  • 「-」「#」「'」以外の半角記号を含むタブ名
  • 先頭の文字が半角記号のタブ名
java.lang.IllegalStateException - タブ形式以外の場合
注意事項
指定した追加位置にタブが存在しない場合は,最後に追加します。この場合,タブ内のレイアウトは「行列形式(列ベース)」となります。指定した位置のタブ内のレイアウトと同じレイアウトでタブを作成します。
changeArrangement
形式

public void changeArrangement(int iArrangement,
                              LayoutBean lb)

機能
強制ポートレットの配置を指定した配置に変更します。
パラメタ
iArrangement - 強制ポートレットの配置
パラメタiArrangementには,次の値を指定します。
  1. LayoutCustomizeBean.ARRANGEMENT_LEFTUP
  2. LayoutCustomizeBean. ARRANGEMENT_LEFTDOWN
  3. LayoutCustomizeBean. ARRANGEMENT_RIGHTUP
    LayoutCustomizeBean. ARRANGEMENT_RIGHTDOWN
     
lb - 変更対象のLayoutBean
戻り値
なし
例外
java.lang.IllegalStateException - 配置を設定できない場合
パラメタiArrangementに,不正な値を指定した場合
changeColor
形式

public void changeColor(int stylecode,
                       java.lang.String color)

機能
スタイルの色を変更します。
パラメタ
stylecode - スタイル色コード
stylecodeに指定する値を次に示します。
  • LayoutCustomizeBean.STYLE_COLOR_BACKGROUND:ポートレット背景色
  • LayoutCustomizeBean.STYLE_COLOR_TITLE:タイトル背景色
  • LayoutCustomizeBean.STYLE_COLOR_TAB:選択中のタブ背景色
  • LayoutCustomizeBean.STYLE_COLOR_BORDER:枠色
 
color - 色
colorには"#rrggbb"形式で指定します。
colorに指定する値を次に示します。
  • 指定色を設定する場合:#rrggbb形式
  • デフォルトの色を設定する場合:null
戻り値
なし
colorに指定できる値以外を指定した場合は,指定を無視します。
例外
java.lang.IllegalArgumentException - stylecodeに,指定できない値を指定した場合
changeLayoutCode
形式

public void changeLayoutCode(int layoutcode)

機能
レイアウト形式を変更します。
パラメタ
layoutcode - レイアウト形式コード
layoutcodeに指定する値を次に示します。なお,指定するレイアウトコードによっては,メソッドを実行する必要があります。
形式実行するメソッド
タブ形式LayoutCustomizeBean.TabLayoutCustomizeUtil.addTab()
行列形式LayoutCustomizeBean.RowColumnLayoutCustomizeUtil.changeRowColumnMode()
グリッド形式LayoutCustomizeBean.Gridなし
フロー形式LayoutCustomizeBean.Flowなし
HDMLカード形式LayoutCustomizeBean.HDMLCardなし
CHTMLカード形式LayoutCustomizeBean.CHTMLCardなし
ユーザ登録形式LayoutCustomizeBean.UserLayoutCustomizeUtil.changeLayoutPattern()
戻り値
なし
例外
java.lang.IllegalArgumentException - layoutcodeに,指定できない値を指定した場合
注意事項
レイアウトパターンを変更後は,設定済みのレイアウト情報がすべて削除されます。ただし指定したレイアウトパターンで設定済みの場合は,削除されません。
changeLayoutPattern
形式

public void changeLayoutPattern(java.lang.String pattern,
                               LayoutBean lb)

機能
ユーザ登録形式のレイアウトパターンを変更します。
パラメタ
pattern - レイアウトパターン名
patternには存在するレイアウトパターン名を指定します。
 
lb - 変更対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。なお,下記以外を指定した場合は変更しません。
  • ユーザ登録形式:現在編集中のLayoutBean
  • タブ形式:ユーザ登録形式のタブ内のLayoutBean
戻り値
なし
例外
java.lang.IllegalArgumentException -
patternに,指定できない値を指定した場合
lbに,不正なLayoutBeanオブジェクトを指定した場合
注意事項
レイアウト形式を変更後は,設定済みのレイアウト情報がすべて削除されます。ただし指定したレイアウト形式で設定済みの場合は,削除されません。
changeRowColumnMode
形式

public void changeRowColumnMode(int mode,
                                 LayoutBean lb)

機能
行列形式の行ベースまたは列ベースのモードを変更します。
パラメタ
mode - 行ベースまたは列ベースのモード
modeに指定する値を次に示します。
  • 列ベース:LayoutCustomizeBean.RowColumnModeRow
  • 行ベース:LayoutCustomizeBean.RowColumnModeColumn
 
lb - 変更対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。
  • 行列形式:現在編集中のLayoutBean
  • タブ形式:行列形式のタブ内のLayoutBean
戻り値
なし
例外
java.lang.IllegalArgumentException -
  • modeに,指定できない値を指定した場合
  • lbに,不正なLayoutBeanオブジェクトを指定した場合
注意事項
レイアウト形式が行列形式,またはユーザ登録形式の場合,設定済みのレイアウトの情報は保持されますが,それ以外はすべて削除されます。
changeSize
形式

public void changeSize(int stylecode,
                      int size)

機能
スタイルのサイズを変更します。
パラメタ
stylecode - スタイルサイズコード
stylecodeに指定する値を次に示します。
  • LayoutCustomizeBean.STYLE_SIZE_RULER:ルーラーサイズ
  • LayoutCustomizeBean.STYLE_SIZE_PADDING:ポートレット間隔
  • LayoutCustomizeBean.STYLE_SIZE_BORDER:枠幅
 
size - サイズ
sizeに指定する値を次に示します。
  • 指定サイズを設定する場合:0以上
  • デフォルトサイズを設定する場合:-1
戻り値
なし
ただし,sizeに指定できる値以外を指定した時は,指定を無視します。
例外
java.lang.IllegalArgumentException - stylecode - 指定できない値を指定した場合
changeStyle
形式

public void changeStyle(int stylecode)

機能
スタイル種別を変更します。
パラメタ
stylecode - スタイル種別コード
stylecodeに指定する値を次に示します。
  • LayoutCustomizeBean.STYLE_TITLE:タイトル付き
  • LayoutCustomizeBean.STYLE_FRAME:タイトルなし・枠付き
  • LayoutCustomizeBean.STYLE_NONE:タイトルなし・枠なし
戻り値
なし
例外
java.lang.IllegalArgumentException - stylecode - 指定できない値を指定した場合
getColor
形式

public java.lang.String getColor(int stylecode)

機能
スタイルに設定されている色を取得します。
パラメタ
stylecode - スタイル色コード
stylecodeに指定する値を次に示します。
  • LayoutCustomizeBean.STYLE_COLOR_BACKGROUND:ポートレット背景色
  • LayoutCustomizeBean.STYLE_COLOR_TITLE:タイトル背景色
  • LayoutCustomizeBean.STYLE_COLOR_TAB:選択中のタブ背景色
  • LayoutCustomizeBean.STYLE_COLOR_BORDER:枠色
戻り値
スタイル色コード:"#rrggbb"形式
未設定の場合は,nullを返却します。
例外
java.lang.IllegalArgumentException - stylecode - 指定できない値を指定した場合
getEditLayoutBean
形式

public LayoutBean getEditLayoutBean()

機能
編集中のLayoutBeanオブジェクトを取得します。
パラメタ
なし
戻り値
編集中のLayoutBeanオブジェクト
ただし,編集中のデバイスの設定(LayoutCustomizeBean.setEditDeviceCode())を行っていない場合は,nullを返却します。
例外
なし
getEditLayoutBean
形式

public LayoutBean getEditLayoutBean(LayoutBean lb,
                                  java.lang.String title)

機能
指定したタブ内のLayoutBeanオブジェクトを取得します。
パラメタ
lb - 編集中のタブ形式のLayoutBeanオブジェクト
title - 存在するタブ名
戻り値
指定したタブ内のLayoutBeanオブジェクト
例外
java.lang.IllegalArgumentException
  • lbに,タブ形式以外のLayoutBeanオブジェクトを指定した場合
  • titleに,存在しないタブ名を指定した場合
getSize
形式

public int getSize(int stylecode)

機能
スタイルに設定されているサイズを取得します。
パラメタ
stylecode - スタイルサイズコード
指定する値を次に示します。
  • LayoutCustomizeBean.STYLE_SIZE_RULER:ルーラーサイズ
  • LayoutCustomizeBean.STYLE_SIZE_PADDING:ポートレット間隔
  • LayoutCustomizeBean.STYLE_SIZE_BORDER:枠幅
戻り値
スタイルサイズ
未設定の場合は-1を返却します。
例外
java.lang.IllegalArgumentException - stylecodeに指定できない値を指定した場合
getStyle
形式

public int getStyle()

機能
スタイル種別を取得します。
パラメタ
なし
戻り値
スタイル種別コードを次に示します。
  • LayoutCustomizeBean.STYLE_TITLE:タイトル付き
  • LayoutCustomizeBean.STYLE_FRAME:タイトルなし・枠付き
  • LayoutCustomizeBean.STYLE_NONE:タイトルなし・枠なし
ただし,未設定の場合は,LayoutCustomizeBean.STYLE_TITLEを返却します。
例外
なし
isSelectedPortlet
形式

public boolean isSelectedPortlet(java.lang.String portlet,
                              LayoutBean lb)

機能
指定したポートレットが追加済みであることを示します。
パラメタ
portlet - ポートレット名
lb - 追加対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトは,タブ形式以外の場合,現在編集中のLayoutBeanを,タブ形式の場合は,タブ内のLayoutBeanを指定します。
戻り値
true:追加済みの場合
false:未追加の場合
例外
java.lang.IllegalArgumentException
  • portletに,nullを指定した場合
  • lbに,不正なLayoutBeanオブジェクトを指定した場合
movePortlet
形式

public int movePortlet(java.lang.String portletID,
                      int movecode,
                      LayoutBean lb)

機能
指定したポートレットを移動します。
パラメタ
portletID - 移動するポートレットのポートレットID(識別子)
portletIDには,PortletBeanオブジェクトのgetPortletID()メソッドで取得した値を指定します。
 
movecode - 移動先コード
movecodeに指定する値を次に示します。
形式
行列形式(行ベース)LayoutCustomizeBean.MOVE_LEFT,またはLayoutCustomizeBean.MOVE_RIGHT
行列形式(列ベース)LayoutCustomizeBean.MOVE_UP,またはLayoutCustomizeBean.MOVE_DOWN
ユーザ登録形式LayoutCustomizeBean.MOVE_UP,またはLayoutCustomizeBean.MOVE_DOWN
フロー形式LayoutCustomizeBean.MOVE_UP,またはLayoutCustomizeBean.MOVE_DOWN
カード形式(CHTML)LayoutCustomizeBean.MOVE_UP,またはLayoutCustomizeBean.MOVE_DOWN
カード形式(HDML)LayoutCustomizeBean.MOVE_UP,またはLayoutCustomizeBean.MOVE_DOWN
 
lb - 移動対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。
  • タブ形式以外:現在編集中のLayoutBean
  • タブ形式:タブ内のLayoutBean
戻り値
移動後のポートレットの位置
例外
java.lang.IllegalArgumentException -
  • portletIDに,不正なポートレットIDを指定した場合
  • movecodeに,指定できない値を指定した場合
  • lbに,不正なLayoutBeanオブジェクトを指定した場合
moveTab
形式

public int moveTab(java.lang.String tabname,
                   int movecode)

機能
タブ形式の場合,指定したタブを移動します。
パラメタ
tabname - 移動するタブ名。存在するタブ名を指定します。
movecode - 移動先コード。LayoutCustomizeBean.MOVE_LEFT,またはLayoutCustomizeBean.MOVE_RIGHTを指定します。
戻り値
移動後のタブの位置
移動できない場合はタブを移動しないで,指定したタブの位置を返却します。
例外
java.lang.IllegalArgumentException -
  • tabnameおよびmovecodeに指定できない値を指定した場合
  • java.lang.IllegalStateException - - タブ形式以外の場合
removeForceTab
形式

public void removeForceTab()

機能
強制タブを編集中の場合,強制タブを削除します。
パラメタ
なし
戻り値
なし
例外
java.lang.IllegalStateException - 強制タブ編集中以外の場合
LayoutCostomizeBean.isForceLayout()がfalseの場合
注意事項
forceHomeHTML.psmlファイルは,初期化されるだけで削除されません。 強制タブ名を[タブ1],強制タブ内のレイアウトを[行列形式(行ベース)]に設定します。
removePortlet
形式

public boolean removePortlet(java.lang.String portletID,
                          LayoutBean lb)

機能
指定したポートレットを削除します。
パラメタ
portletID - 削除するポートレットのポートレットID(識別子)
portletIDには,PortletBeanオブジェクトのgetPortletID()メソッドで取得した値を指定します
lb - 削除対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。
  • タブ形式以外:現在編集中のLayoutBean
  • タブ形式:タブ内のLayoutBean
戻り値
true:削除
false:未削除
なお,指定したポートレットが存在しない場合は,ポートレットを削除しないでfalseを返却します。
例外
java.lang.IllegalArgumentException - lbに,不正なLayoutBeanオブジェクトを指定した場合
removePortlets
形式

public boolean removePortlets(int lineno,
                            LayoutBean lb)

機能
行列形式の場合,指定した行または列に配置されているポートレットをすべて削除します。
パラメタ
lineno - 削除する行番号または列番号
linenoに指定する値を次に示します。
  • 行列形式(行ベース):1から始まる行番号
  • 行列形式(列ベース):1から始まる列番号
lb - 削除対象のLayoutBeanオブジェクト
lbに指定するLayoutBeanオブジェクトを次に示します。
  • タブ形式以外:現在編集中のLayoutBean
  • タブ形式:タブ内のLayoutBean
戻り値
true:削除
false:未削除
なお,存在しない行番号または列番号を指定した場合は,ポートレットを削除しないでfalseを返却します。
例外
java.lang.IllegalArgumentException -
linenoに,指定できない値を指定した場合
lbに,行列形式以外の不正なLayoutBeanオブジェクトを指定した場合
removeTab
形式

public boolean removeTab(java.lang.String tabname)

機能
タブ形式の場合,指定したタブを削除します。
パラメタ
tabname - 削除するタブ名。存在するタブ名を指定します。
戻り値
true:削除
false:未削除
指定したタブ名が存在しない場合はタブを削除せず,falseを返却します。
例外
java.lang.IllegalStateException - タブ形式以外の場合