jp.co.fujitsu.reffi.client.nexaweb.controller
クラス ClientConfig

java.lang.Object
  jp.co.fujitsu.reffi.client.nexaweb.controller.ClientConfig

public class ClientConfig
extends java.lang.Object

[概 要]

フレームワーク挙動情報が格納されたクラスです。

[詳 細]

[備 考]

[環 境] JDK 6.0 Update 11

Copyright (c) 2008-2009 FUJITSU Japan All rights reserved.

作成者:

Project Reffi

コンストラクタの概要

ClientConfig()
[概 要] デフォルトコンストラクタです。

メソッドの概要

void	addDuplicateElementAndEvent(java.lang.String elementName, java.lang.String eventType) [概 要] 指定したエレメントとイベントの組み合わせでアクション多重起動を許可するように設定をします。
void	addWindowLevelElementDefinition(java.lang.String elementName) [概 要] フレームワークが「ウィンドウ」として認識するエレメント名のリストに追加します。
java.lang.String	getComponentColorOnValidationFault() [概 要] バリデーションエラー発生時の、コンポーネント背景色を取得します。
java.lang.Class<? extends com.nexaweb.util.LogConsumer>	getLogConsumerClass() [概 要] ログイベントを受信するコンシューマクラスを取得します。
java.lang.String	getLogDateFormat() [概 要] ログヘッダの日付、時間フォーマットを取得します。
java.lang.String	getLogFileCharset() [概 要] ログファイルの文字エンコーディングを取得します。
java.lang.String	getLogFileDir() [概 要] ログファイルを格納するディレクトリ名を取得します。
int	getLogFileMaxBackupIndex() [概 要] ログファイルサイズローテーション時の最大バックアップファイル保持数を取得します。
int	getLogFileMaxExist() [概 要] ディレクトリ内ログファイルの格納数上限を取得します。
long	getLogFileMaxSize() [概 要] ログファイルサイズ上限を取得します。
java.lang.String	getLogFileNamePrefix() [概 要] ログファイル名の接頭文字を取得します。
java.lang.String	getLogFileNameSuffix() [概 要] ログファイル名の接尾文字を取得します。
int	getMaxDisplayCountOnValidationFault() [概 要] 画面上に表示するバリデーションエラー数を取得します。
java.lang.String	getUnexpectedErrorDialogMessage() [概 要] 予期せぬ例外発生時に表示するダイアログメッセージを取得します。
java.lang.String	getUnexpectedErrorDialogTitle() [概 要] 予期せぬ例外発生時に表示するダイアログタイトルを取得します。
java.util.List<java.lang.String>	getWindowLevelElementDefinition() [概 要] フレームワークが「ウィンドウ」として認識するエレメント名のリストを取得します。
boolean	isComponentColorAndTipChangeOnValidationFault() [概 要] コンポーネント背景色の変更、ツールチップのエラー文言化を行うかどうかのフラグを取得します。
boolean	isDisplayDialogOnValidationFault() [概 要] エラー文言をダイアログ表示するかどうかのフラグを取得します。
boolean	isDuplicateActionInvoke() [概 要] 同一エレメントからのアクションを、同時に複数起動するかどうかのフラグを取得します。
boolean	isDuplicateElementAndEvent(java.lang.String elementName, java.lang.String eventType) [概 要] 指定したエレメントとイベントの組み合わせでアクション多重起動が許可されているか取得します。
boolean	isEnableValidationFaultProcessing() [概 要] フレームワークによるデフォルトエラー処理を行うかどうかのフラグを取得します。
boolean	isWindowElementDefaultFocus() [概 要] ui DOMにwindowエレメントが追加された時、focused="true"属性を自動で付与するかどうかのフラグを取得します。
void	setComponentColorAndTipChangeOnValidationFault(boolean componentColorAndTipChangeOnValidationFault) [概 要] コンポーネント背景色の変更、ツールチップのエラー文言化を行うかどうかのフラグ [詳 細] componentColorAndTipChangeOnValidationFaultフィールドを引数ComponentColorAndTipChangeOnValidationFaultで設定します。
void	setComponentColorOnValidationFault(java.lang.String componentColorOnValidationFault) [概 要] バリデーションエラー発生時の、コンポーネント背景色を設定します。
void	setDisplayDialogOnValidationFault(boolean displayDialogOnValidationFault) [概 要] エラー文言をダイアログ表示するかどうかのフラグを設定します。
void	setDuplicateActionInvoke(boolean duplicateActionInvoke) [概 要] 同一エレメントからのアクションを、同時に複数起動するかどうかのフラグを設定します。
void	setEnableValidationFaultProcessing(boolean enableValidationFaultProcessing) [概 要] フレームワークによるデフォルトエラー処理を行うかどうかのフラグを設定します。
void	setLogConsumerClass(java.lang.Class<? extends com.nexaweb.util.LogConsumer> logConsumerClass) [概 要] ログイベントを受信するコンシューマクラスを設定します。
void	setLogDateFormat(java.lang.String logDateFormat) [概 要] ログヘッダの日付、時間フォーマットを設定します。
void	setLogFileCharset(java.lang.String logFileCharset) [概 要] ログファイルの文字エンコーディングを設定します。
void	setLogFileDir(java.lang.String logFileDir) [概 要] ログファイルを格納するディレクトリ名を設定します。
void	setLogFileMaxBackupIndex(int logFileMaxBackupIndex) [概 要] ログファイルサイズローテーション時の最大バックアップファイル保持数を設定します。
void	setLogFileMaxExist(int logFileMaxExist) [概 要] ディレクトリ内ログファイルの格納数上限を設定します。
void	setLogFileMaxSize(long logFileMaxSize) [概 要] ログファイルサイズ上限を設定します。
void	setLogFileNamePrefix(java.lang.String logFileNamePrefix) [概 要] ログファイル名の接頭文字を設定します。
void	setLogFileNameSuffix(java.lang.String logFileNameSuffix) [概 要] ログファイル名の接尾文字を設定します。
void	setMaxDisplayCountOnValidationFault(int maxDisplayCountOnValidationFault) [概 要] 画面上に表示するバリデーションエラー数を設定します。
void	setUnexpectedErrorDialogMessage(java.lang.String unexpectedErrorDialogMessage) [概 要] 予期せぬ例外発生時に表示するダイアログメッセージを設定します。
void	setUnexpectedErrorDialogTitle(java.lang.String unexpectedErrorDialogTitle) [概 要] 予期せぬ例外発生時に表示するダイアログタイトルを設定します。
void	setWindowElementDefaultFocus(boolean windowElementDefaultFocus) [概 要] ui DOMにwindowエレメントが追加された時、focused="true"属性を自動で付与するかどうかのフラグを設定します。
void	setWindowLevelElementDefinition(java.util.List<java.lang.String> windowLevelElementDefinition) [概 要] フレームワークが「ウィンドウ」として認識するエレメント名のリストを設定します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ClientConfig

public ClientConfig()

[概 要]

デフォルトコンストラクタです。

[詳 細]

this.windowLevelElementDefinitionインスタンスを生成して、 "window"と"dialog"を追加します。

[備 考]

メソッドの詳細

isEnableValidationFaultProcessing

public boolean isEnableValidationFaultProcessing()

[概 要]

フレームワークによるデフォルトエラー処理を行うかどうかのフラグを取得します。

[詳 細]

enableValidationFaultProcessingフィールドを返却します。

[備 考]

戻り値:

フレームワークによるデフォルトエラー処理を行うかどうかのフラグ

setEnableValidationFaultProcessing

public void setEnableValidationFaultProcessing(boolean enableValidationFaultProcessing)

[概 要]

フレームワークによるデフォルトエラー処理を行うかどうかのフラグを設定します。

[詳 細]

EnableValidationFaultProcessingフィールドを引数EnableValidationFaultProcessingで設定します。

[備 考]

パラメータ:

enableValidationFaultProcessing - フレームワークによるデフォルトエラー処理を行うかどうかのフラグ

isComponentColorAndTipChangeOnValidationFault

public boolean isComponentColorAndTipChangeOnValidationFault()

[概 要]

コンポーネント背景色の変更、ツールチップのエラー文言化を行うかどうかのフラグを取得します。

[詳 細]

componentColorAndTipChangeOnValidationFaultフィールドを返却します。

[備 考]

戻り値:

コンポーネント背景色の変更、ツールチップのエラー文言化を行うかどうかのフラグ

setComponentColorAndTipChangeOnValidationFault

public void setComponentColorAndTipChangeOnValidationFault(boolean componentColorAndTipChangeOnValidationFault)

[概 要]

コンポーネント背景色の変更、ツールチップのエラー文言化を行うかどうかのフラグ

[詳 細]

componentColorAndTipChangeOnValidationFaultフィールドを引数ComponentColorAndTipChangeOnValidationFaultで設定します。

[備 考]

パラメータ:

componentColorAndTipChangeOnValidationFault - コンポーネント背景色の変更、ツールチップのエラー文言化を行うかどうかのフラグ

isDisplayDialogOnValidationFault

public boolean isDisplayDialogOnValidationFault()

[概 要]

エラー文言をダイアログ表示するかどうかのフラグを取得します。

[詳 細]

displayDialogOnValidationFaultフィールドを返却します。

[備 考]

戻り値:

エラー文言をダイアログ表示するかどうかのフラグ

setDisplayDialogOnValidationFault

public void setDisplayDialogOnValidationFault(boolean displayDialogOnValidationFault)

[概 要]

エラー文言をダイアログ表示するかどうかのフラグを設定します。

[詳 細]

displayDialogOnValidationFaultフィールドを引数displayDialogOnValidationFaultで設定します。

[備 考]

パラメータ:

displayDialogOnValidationFault - エラー文言をダイアログ表示するかどうかのフラグ

getComponentColorOnValidationFault

public java.lang.String getComponentColorOnValidationFault()

[概 要]

バリデーションエラー発生時の、コンポーネント背景色を取得します。

[詳 細]

componentColorOnValidationFaultフィールドを返却します。

[備 考]

戻り値:

バリデーションエラー発生時の、コンポーネント背景色

setComponentColorOnValidationFault

public void setComponentColorOnValidationFault(java.lang.String componentColorOnValidationFault)

[概 要]

バリデーションエラー発生時の、コンポーネント背景色を設定します。

[詳 細]

ComponentColorOnValidationFaultフィールドを引数ComponentColorOnValidationFaultで設定します。

[備 考]

パラメータ:

componentColorOnValidationFault - バリデーションエラー発生時の、コンポーネント背景色

getMaxDisplayCountOnValidationFault

public int getMaxDisplayCountOnValidationFault()

[概 要]

画面上に表示するバリデーションエラー数を取得します。

[詳 細]

maxDisplayCountOnValidationFaultフィールドを返却します。

[備 考]

戻り値:

画面上に表示するバリデーションエラー数

setMaxDisplayCountOnValidationFault

public void setMaxDisplayCountOnValidationFault(int maxDisplayCountOnValidationFault)

[概 要]

画面上に表示するバリデーションエラー数を設定します。

[詳 細]

maxDisplayCountOnValidationFaulｔフィールドを引数 maxDisplayCountOnValidationFaulｔで設定します。

[備 考]

パラメータ:

maxDisplayCountOnValidationFault - 画面上に表示するバリデーションエラー数

getLogConsumerClass

public java.lang.Class<? extends com.nexaweb.util.LogConsumer> getLogConsumerClass()

[概 要]

ログイベントを受信するコンシューマクラスを取得します。

[詳 細]

logConsumerClassフィールドを返却します。

[備 考]

戻り値:

ログイベントを受信するコンシューマクラス

setLogConsumerClass

public void setLogConsumerClass(java.lang.Class<? extends com.nexaweb.util.LogConsumer> logConsumerClass)

[概 要]

ログイベントを受信するコンシューマクラスを設定します。

[詳 細]

logConsumerClassフィールドを引数logConsumerClassで設定します。

[備 考]

パラメータ:

logConsumerClass - ログイベントを受信するコンシューマクラスです。

getLogDateFormat

public java.lang.String getLogDateFormat()

[概 要]

ログヘッダの日付、時間フォーマットを取得します。

[詳 細]

logDateFormatフィールドを返却します。

[備 考]

戻り値:

ログヘッダの日付、時間フォーマット

setLogDateFormat

public void setLogDateFormat(java.lang.String logDateFormat)

[概 要]

ログヘッダの日付、時間フォーマットを設定します。

[詳 細]

logDateFormatフィールドを引数logDateFormatで設定します。

[備 考]

パラメータ:

logDateFormat - ログヘッダの日付、時間フォーマット

getLogFileDir

public java.lang.String getLogFileDir()

[概 要]

ログファイルを格納するディレクトリ名を取得します。

[詳 細]

logFileDirフィールドを返却します。

[備 考]

戻り値:

ログファイルを格納するディレクトリ名

setLogFileDir

public void setLogFileDir(java.lang.String logFileDir)

[概 要]

ログファイルを格納するディレクトリ名を設定します。

[詳 細]

logFileDirフィールドを引数logFileDirで設定します。

[備 考]

パラメータ:

logFileDir - ログファイルを格納するディレクトリ名

getLogFileNamePrefix

public java.lang.String getLogFileNamePrefix()

[概 要]

ログファイル名の接頭文字を取得します。

[詳 細]

logFileNamePrefixフィールドを返却します。

[備 考]

戻り値:

ログファイル名の接頭文字

setLogFileNamePrefix

public void setLogFileNamePrefix(java.lang.String logFileNamePrefix)

[概 要]

ログファイル名の接頭文字を設定します。

[詳 細]

logFileNamePrefixフィールドを引数logFileNamePrefixで設定します。

[備 考]

パラメータ:

logFileNamePrefix - ログファイル名の接頭文字

getLogFileNameSuffix

public java.lang.String getLogFileNameSuffix()

[概 要]

ログファイル名の接尾文字を取得します。

[詳 細]

logFileNameSuffixフィールドを返却します。

[備 考]

戻り値:

ログファイル名の接尾文字

setLogFileNameSuffix

public void setLogFileNameSuffix(java.lang.String logFileNameSuffix)

[概 要]

ログファイル名の接尾文字を設定します。

[詳 細]

logFileNameSuffixフィールドを引数logFileNameSuffixで設定します。

[備 考]

パラメータ:

logFileNameSuffix - ログファイル名の接尾文字

getLogFileMaxExist

public int getLogFileMaxExist()

[概 要]

ディレクトリ内ログファイルの格納数上限を取得します。

[詳 細]

logFileMaxExistフィールドを返却します。

[備 考]

戻り値:

ディレクトリ内ログファイルの格納数上限

setLogFileMaxExist

public void setLogFileMaxExist(int logFileMaxExist)

[概 要]

ディレクトリ内ログファイルの格納数上限を設定します。

[詳 細]

logFileMaxExistフィールドを引数logFileMaxExistで設定します。

[備 考]

パラメータ:

logFileMaxExist - ディレクトリ内ログファイルの格納数上限

getLogFileMaxSize

public long getLogFileMaxSize()

[概 要]

ログファイルサイズ上限を取得します。

[詳 細]

logFileMaxSizeフィールドを返却します。

[備 考]

戻り値:

ログファイルサイズ上限

setLogFileMaxSize

public void setLogFileMaxSize(long logFileMaxSize)

[概 要]

ログファイルサイズ上限を設定します。

[詳 細]

logFileMaxSizeフィールドを引数logFileMaxSizeで設定します。

[備 考]

パラメータ:

logFileMaxSize - ログファイルサイズ上限

getLogFileMaxBackupIndex

public int getLogFileMaxBackupIndex()

[概 要]

ログファイルサイズローテーション時の最大バックアップファイル保持数を取得します。

[詳 細]

logFileMaxBackupIndexフィールドを返却します。

[備 考]

戻り値:

ログファイルサイズローテーション時の最大バックアップファイル保持数

setLogFileMaxBackupIndex

public void setLogFileMaxBackupIndex(int logFileMaxBackupIndex)

[概 要]

ログファイルサイズローテーション時の最大バックアップファイル保持数を設定します。

[詳 細]

logFileMaxBackupIndexフィールドを引数logFileMaxBackupIndexで設定します。

[備 考]

パラメータ:

logFileMaxBackupIndex - ログファイルサイズローテーション時の最大バックアップファイル保持数

getLogFileCharset

public java.lang.String getLogFileCharset()

[概 要]

ログファイルの文字エンコーディングを取得します。

[詳 細]

logFileCharsetフィールドを返却します。

[備 考]

戻り値:

ログファイルの文字エンコーディング

setLogFileCharset

public void setLogFileCharset(java.lang.String logFileCharset)

[概 要]

ログファイルの文字エンコーディングを設定します。

[詳 細]

logFileCharsetフィールドを引数logFileCharsetで設定します。

[備 考]

パラメータ:

logFileCharset - ログファイルの文字エンコーディング

getUnexpectedErrorDialogTitle

public java.lang.String getUnexpectedErrorDialogTitle()

[概 要]

予期せぬ例外発生時に表示するダイアログタイトルを取得します。

[詳 細]

unexpectedErrorDialogTitleフィールドを返却します。

[備 考]

戻り値:

予期せぬ例外発生時に表示するダイアログタイトル

setUnexpectedErrorDialogTitle

public void setUnexpectedErrorDialogTitle(java.lang.String unexpectedErrorDialogTitle)

[概 要]

予期せぬ例外発生時に表示するダイアログタイトルを設定します。

[詳 細]

unexpectedErrorDialogTitleフィールドを引数unexpectedErrorDialogTitleで設定します。

[備 考]

パラメータ:

unexpectedErrorDialogTitle - 予期せぬ例外発生時に表示するダイアログタイトル

getUnexpectedErrorDialogMessage

public java.lang.String getUnexpectedErrorDialogMessage()

[概 要]

予期せぬ例外発生時に表示するダイアログメッセージを取得します。

[詳 細]

unexpectedErrorDialogMessageフィールドを返却します。

[備 考]

戻り値:

予期せぬ例外発生時に表示するダイアログメッセージ

setUnexpectedErrorDialogMessage

public void setUnexpectedErrorDialogMessage(java.lang.String unexpectedErrorDialogMessage)

[概 要]

予期せぬ例外発生時に表示するダイアログメッセージを設定します。

[詳 細]

unexpectedErrorDialogMessageフィールドを引数unexpectedErrorDialogMessageで設定します。

[備 考]

パラメータ:

unexpectedErrorDialogTitle - 予期せぬ例外発生時に表示するダイアログメッセージ

isWindowElementDefaultFocus

public boolean isWindowElementDefaultFocus()

[概 要]

ui DOMにwindowエレメントが追加された時、focused="true"属性を自動で付与するかどうかのフラグを取得します。

[詳 細]

windowElementDefaultFocusフィールドを返却します。

[備 考]

戻り値:

ui DOMにwindowエレメントが追加された時、focused="true"属性を自動で付与するかどうかのフラグ

setWindowElementDefaultFocus

public void setWindowElementDefaultFocus(boolean windowElementDefaultFocus)

[概 要]

ui DOMにwindowエレメントが追加された時、focused="true"属性を自動で付与するかどうかのフラグを設定します。

[詳 細]

WindowElementDefaultFocusフィールドを引数WindowElementDefaultFocusで設定します。

[備 考]

パラメータ:

windowElementDefaultFocus - ui DOMにwindowエレメントが追加された時、focused="true"属性を自動で付与するかどうかのフラグ

getWindowLevelElementDefinition

public java.util.List<java.lang.String> getWindowLevelElementDefinition()

[概 要]

フレームワークが「ウィンドウ」として認識するエレメント名のリストを取得します。

[詳 細]

windowLevelElementDefinitionフィールドを返却します。

[備 考]

フレームワークが「ウィンドウ」として認識するエレメントは、 デフォルトでは「window」エレメントと「dialog」エレメントです。

このリストに入っている名前をローカル名として持つエレメントには、 parentId属性とcommunicateId属性が追加されます。
XalReturnPossibilityModel.addIdentifierToWindows(com.nexaweb.xml.Document)
又、AbstractAction.getAllWindows()等のウィンドウ 管理APIの対象エレメントになります。

戻り値:

フレームワークが「ウィンドウ」として認識するエレメント名のリスト

setWindowLevelElementDefinition

public void setWindowLevelElementDefinition(java.util.List<java.lang.String> windowLevelElementDefinition)

[概 要]

フレームワークが「ウィンドウ」として認識するエレメント名のリストを設定します。

[詳 細]

windowLevelElementDefinitionフィールドに引数windowLevelElementDefinitionを設定します。

[備 考]

フレームワークが「ウィンドウ」として認識するエレメントは、 デフォルトでは「window」エレメントと「dialog」エレメントです。

このリストに入っている名前をローカル名として持つエレメントには、 parentId属性とcommunicateId属性が追加されます。
XalReturnPossibilityModel.addIdentifierToWindows(com.nexaweb.xml.Document)
又、AbstractAction.getAllWindows()等のウィンドウ 管理APIの対象エレメントになります。

パラメータ:

windowLevelElementDefinition - フレームワークが「ウィンドウ」として認識するエレメント名のリスト

addWindowLevelElementDefinition

public void addWindowLevelElementDefinition(java.lang.String elementName)

[概 要]

フレームワークが「ウィンドウ」として認識するエレメント名のリストに追加します。

[詳 細]

フレームワークがウィンドウとして対処するAPIの対象エレメントローカル名を追加します。
window、dialogエレメントの他、ウィンドウとして認識させたいエレメント名を追加します。

[備 考]

フレームワークが「ウィンドウ」として認識するエレメントは、 デフォルトでは「window」エレメントと「dialog」エレメントです。

このリストに入っている名前をローカル名として持つエレメントには、 parentId属性とcommunicateId属性が追加されます。
XalReturnPossibilityModel.addIdentifierToWindows(com.nexaweb.xml.Document)
又、AbstractAction.getAllWindows()等のウィンドウ 管理APIの対象エレメントになります。

パラメータ:

elementName - ウィンドウとして認識させるエレメント名

isDuplicateActionInvoke

public boolean isDuplicateActionInvoke()

[概 要]

同一エレメントからのアクションを、同時に複数起動するかどうかのフラグを取得します。

[詳 細]

duplicateActionInvokeフィールドを返却します。

[備 考]

戻り値:

同一エレメントからのアクションを、同時に複数起動するかどうかのフラグ

setDuplicateActionInvoke

public void setDuplicateActionInvoke(boolean duplicateActionInvoke)

[概 要]

同一エレメントからのアクションを、同時に複数起動するかどうかのフラグを設定します。

[詳 細]

duplicateActionInvokeフィールドを引数duplicateActionInvokeで設定します。

[備 考]

true : 同時複数起動可。
false : 不可。二度押し制御が可能になります。
デフォルトはfalseです。

パラメータ:

duplicateActionInvoke - 同一エレメントからのアクションを、同時に複数起動するかどうかのフラグ

addDuplicateElementAndEvent

public void addDuplicateElementAndEvent(java.lang.String elementName,
                                        java.lang.String eventType)

[概 要]

指定したエレメントとイベントの組み合わせでアクション多重起動を許可するように設定をします。

[詳 細]

[備 考]

イベント種別には「onCommand」等、コントローラで定義するイベント名と同一のものを指定してください。

パラメータ:

elementName - アクション多重起動を許可するエレメント名

eventType - アクション多重起動を許可するイベント種別

isDuplicateElementAndEvent

public boolean isDuplicateElementAndEvent(java.lang.String elementName,
                                          java.lang.String eventType)

[概 要]

指定したエレメントとイベントの組み合わせでアクション多重起動が許可されているか取得します。

[詳 細]

[備 考]

パラメータ:

elementName - エレメント名

eventType - イベント種別