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

機能

一つの動的ポートレット情報を持つBeanです。

Beanの項目

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

メソッドの一覧

戻り値のデータ型メソッド説明
java.lang.StringgetBorderColor()ポートレットが枠付きの場合,枠の色を取得します。
intgetBorderSize()ポートレットが枠付きの場合,枠のサイズを取得します。
PortletEntryBeangetPortletEntryBean()ポートレットの静的情報を取得します。
java.lang.StringgetPortletGroupID()ポートレットのグループ識別子を取得します。
java.lang.StringgetPortletGroupName()ポートレットのグループ名称を取得します。
java.lang.StringgetPortletID()ポートレットの識別子を取得します。
java.lang.StringgetPortletName()ポートレット名称を取得します。
java.lang.StringgetPortletTitle()ポートレットのタイトル名称を取得します。
booleanisBorderControl()ポートレットに枠があるかを判断します。
booleanisClearControl()ポートレットにタイトルがあるかを判断します。
booleanisPortletCompulsionDisplay()強制ポートレットであるかどうかを判断します。
voidsetBorderColor(java.lang.String color)ポートレットが枠付きの場合,枠の色を設定します。
voidsetBorderControl(boolean border)ポートレットに枠を付けます。
voidsetBorderSize(int size)ポートレットが枠付きの場合,枠のサイズを設定します。
voidsetClearControl(boolean clear)ポートレットにタイトルを付けます。
voidsetPortletEntryBean(PortletEntryBean PortletEntryBean)ポートレットの静的情報を設定します。

メソッドの説明

getBorderColor
形式

public java.lang.String getBorderColor()

機能
ポートレットが枠付きの場合,枠の色を取得します。
パラメタ
なし
戻り値
ポートレットの枠の色
例外
なし
getBorderSize
形式

public int getBorderSize()

機能
ポートレットが枠付きの場合,枠のサイズを取得します。
パラメタ
なし
戻り値
isBorderControl()がtrueかつ枠のサイズの指定がある場合:枠のサイズ(0以上)
上記以外の場合:-1
例外
なし
getPortletEntryBean
形式

public PortletEntryBean getPortletEntryBean()

機能
ポートレットの静的情報を取得します。
パラメタ
なし
戻り値
ポートレットの静的情報を持つオブジェクト
例外
なし
getPortletGroupID
形式

public java.lang.String getPortletGroupID()

機能
ポートレットのグループ識別子を取得します。
パラメタ
なし
戻り値
ポートレットグループ識別子
例外
なし
getPortletGroupName
形式

public java.lang.String getPortletGroupName()

機能
ポートレットのグループ名称を取得します。
パラメタ
なし
戻り値
ポートレットグループ名称
例外
なし
getPortletID
形式

public java.lang.String getPortletID()

機能
ポートレットの識別子を取得します。
パラメタ
なし
戻り値
ポートレットの識別子
例外
なし
getPortletName
形式

public java.lang.String getPortletName()

機能
ポートレット名称を取得します。
パラメタ
なし
戻り値
ポートレット名称
例外
なし
getPortletTitle
形式

public java.lang.String getPortletTitle()

機能
ポートレットのタイトル名称を取得します。
ただし,タイトルを設定していない場合は,ポートレット名称を取得します。
パラメタ
なし
戻り値
ポートレットのタイトル名称
ポートレットのタイトル名称が指定されていない場合,nullを返却します。
この場合,タイトル名称として画面上にはポートレット名称が表示されます。
例外
なし
isBorderControl
形式

public boolean isBorderControl()

機能
ポートレットに枠があるかを判断します。
パラメタ
なし
戻り値
true:枠付きのポートレットの場合
false:枠無しのポートレットの場合
例外
なし
isClearControl
形式

public boolean isClearControl()

機能
ポートレットにタイトルがあるかを判断します。
パラメタ
なし
戻り値
true:タイトルがあるポートレットの場合
false:タイトルがないポートレットの場合
例外
なし
isPortletCompulsionDisplay
形式

public boolean isPortletCompulsionDisplay()

機能
強制ポートレットであるかどうかを判断します。
パラメタ
なし
戻り値
true:強制ポートレットの場合
false:強制ポートレットでない場合
例外
なし
setBorderColor
形式

public void setBorderColor(java.lang.String color)

機能
ポートレットが枠付きの場合,枠の色を設定します。
パラメタ
color - 枠の色
colorは#rrggbb形式で設定します。
枠の色を標準配色に設定する場合は,nullを指定します。
#rrggbb形式でisBorderControl()が「false」の場合,およびcolorに#rrggbb形式以外を指定している場合は,指定を無視します。
戻り値
なし
例外
なし
注意事項
枠無しの場合,処理を無視します。
このメソッドを利用する際,同一クライアントのすべてのポートレットに対して同じ設定をしてください。
setBorderControl
形式

public void setBorderControl(boolean border)

機能
ポートレットに枠を付けます。
パラメタ
border -
true:ポートレットに枠を付ける場合
false:ポートレットに枠を付けない場合
戻り値
なし
例外
なし
注意事項
このメソッドを利用する際,同一クライアントのすべてのポートレットに対して同じ設定をしてください。
setBorderSize
形式

public void setBorderSize(int size)

機能
ポートレットが枠付きの場合,枠のサイズを設定します。
パラメタ
size - 枠のサイズ
sizeが0以上の場合,枠のサイズを指定します。
-1の場合は,枠のサイズを標準値に設定します。
sizeが0以上でisBorderControl()が「false」の場合,および-1未満の場合は,指定を無視します。
戻り値
なし
例外
なし
注意事項
枠無しの場合,処理を無視します。
このメソッドを利用する際,同一クライアントのすべてのポートレットに対して同じ設定をしてください。
setClearControl
形式

public void setClearControl(boolean clear)

機能
ポートレットにタイトルを付けます。
パラメタ
clear -
true:ポートレットにタイトルを付ける場合
false:ポートレットにタイトルを付けない場合
戻り値
なし
例外
なし
注意事項
このメソッドを利用する際,同一クライアントのすべてのポートレットに対して同じ設定をしてください。
setPortletEntryBean
形式

public void setPortletEntryBean(PortletEntryBean PortletEntryBean)

機能
ポートレットの静的情報を設定します。
パラメタ
PortletEntryBean - ポートレットの静的情報を持つオブジェクト
戻り値
なし
例外
なし