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

機能

レイアウトの一覧を取得するBeanです。レイアウトの一要素を管理します。読み込み専用のクラスです。

メソッドの一覧

戻り値のデータ型メソッド説明
java.lang.StringgetDesc()レイアウトグループの説明文を取得します。
java.lang.StringgetName()レイアウトグループ名称を取得します。
java.lang.StringgetTitle()レイアウトグループのタイトル名称を取得します。
protected java.lang.StringgetTitle(java.lang.String lang)言語種別を指定して,レイアウトグループのタイトル名称を取得します。
java.lang.StringgetTitle(java.util.Locale locale)ロケールを指定して,レイアウトグループのタイトル名称を取得します。
java.util.HashMapgetAllNamesByLangType()レイアウトに設定されているすべてのロケールに対応する表示名を取得します。
booleanisForce()強制表示のレイアウトであるかどうかを取得します。
booleanisSelected()選択済みのレイアウトであるかどうかを取得します。
booleanisUserDefineLayout()ユーザ定義または過去のレイアウトであるかどうかを判断します。
booleanisView()標準で表示するレイアウトであるかどうかを取得します。

メソッドの説明

getDesc
形式

public java.lang.String getDesc()

機能
レイアウトグループの説明文を取得します。
パラメタ
なし
戻り値
レイアウトグループの説明文
必ずnull以外を返却します。
例外
なし
getName
形式

public java.lang.String getName()

機能
レイアウトグループ名称を取得します。
このメソッドはサーバ間での情報のやり取りをする場合に利用します。
ユーザ定義の場合は,null以外の一意な名称が返却されます。
パラメタ
なし
戻り値
レイアウトグループ名称
必ずnull以外が返却されます。
例外
なし
getTitle〔レイアウトグループのタイトル名称を取得〕
形式

public java.lang.String getTitle()

機能
レイアウトグループのタイトル名称を取得します。
パラメタ
なし
戻り値
レイアウトグループのタイトル名称
必ずnull以外が返却されます。
例外
なし
getTitle〔言語種別を指定して,レイアウトグループのタイトル名称を取得〕
形式

protected java.lang.String getTitle(java.lang.String lang)

機能
言語種別を指定して,レイアウトグループのタイトル名称を取得します。
パラメタ
lang - 言語種別
戻り値
レイアウトグループタイトル名称
指定の言語種別で見つからないときはnullが返却されます。
言語種別が日本語(ja)の場合,nullが返却されることはありません。
例外
なし
getTitle〔ロケールを指定して,レイアウトグループのタイトル名称を取得〕
形式

public java.lang.String getTitle(java.util.Locale locale)

機能
ロケールを指定して,レイアウトグループのタイトル名称を取得します。
パラメタ
locale - ロケール
戻り値
レイアウトグループタイトル名称
指定のロケールで見つからないときはnullが返却されます。
言語種別が日本語(ja)の場合,nullが返却されることはありません。
例外
なし
getAllNamesByLangType
形式
public java.util.HashMap getAllNamesByLangType()
機能
レイアウトに設定されているすべてのロケールに対応する表示名を取得します。
パラメタ
なし
戻り値
レイアウトに設定されているすべてのロケールに対応する表示名が格納されたMapを返却します。返却するMapの内容は次のとおりです。
key:java.lang.String("{言語コード}[-{国コード}[-{バリアント}]]")
value:java.lang.String("{レイアウトの表示名称}")
表示名が設定されていない場合は,空のMapを返却します。
例外
なし
isForce
形式

public boolean isForce()

機能
強制表示のレイアウトであるかどうかを取得します。
パラメタ
なし
戻り値
true:強制表示のレイアウトである
false:強制表示のレイアウトでない
例外
なし
isSelected
形式

public boolean isSelected()

機能
選択済みのレイアウトであるかどうかを取得します。
パラメタ
なし
戻り値
true:選択済みのレイアウトである
false:選択済みのレイアウトでない
例外
なし
isUserDefineLayout
形式

public boolean isUserDefineLayout()

機能
ユーザ定義であるかまたは過去のレイアウトであるかどうかを判断します。
パラメタ
なし
戻り値
true:ユーザ定義または過去のレイアウトである
false:ユーザ定義または過去のレイアウトでない
例外
なし
isView
形式

public boolean isView()

機能
標準で表示するレイアウトであるかどうかを取得します。
なお,強制表示のレイアウトであっても,管理者が削除した場合はユーザ定義のレイアウトとなるため,falseを返却します。
パラメタ
なし
戻り値
true:標準で表示するレイアウトである
false:標準で表示するレイアウトでない
例外
なし