jp.terasoluna.fw.web.struts.plugins
クラス ResetterPlugIn

java.lang.Object
  上位を拡張 jp.terasoluna.fw.web.struts.plugins.ResetterPlugIn

public class ResetterPlugIn
extends java.lang.Object

フォームのリセット設定をロードするプラグイン。 PlugIn機能を使用し、サーブレット初期化時にフォームのリセット機能の 設定を読み込み、サーブレットコンテキストに保存する。

フォームリセット定義ファイル(reset.xml)の設定情報は ResetterResources のインスタンスとしてサーブレットコンテキストに保存される。
実行時には、 FormEx#reset() メソッドから任意の Resetter が呼び出され、 ResetterResources に格納されている設定情報に従ってリセット処理を行なう。
リセット処理を委譲するクラスは 、 Resetter を実装した任意のクラス。


使用方法
この機能を使用するには Struts設定ファイル(struts-config.xml) に以下のように設定する。
resetter はリセット処理を行なう実装クラス (※ resetter は省略可。省略時はデフォルトを使用。 デフォルト="jp.terasoluna.fw.web.struts.reset.ResetterImpl") resources にはフォームリセット定義ファイル(reset.xml)、 digesterRulesには、フォームリセットルール定義ファイル(reset-rules.xml) を指定する。 (digesterRulesは省略可。)
 <plug-in className="jp.terasoluna.fw.web.struts.plugins.ResetterPlugIn">
   <set-property
     property="resetter"
     value="jp.terasoluna.fw.web.struts.reset.ResetterImpl"/>
   <set-property
     property="resources"
     value="/WEB-INF/reset.xml"/>
   <set-property
     property="digesterRules"
     value="/WEB-INF/reset-rules.xml"/>
 </plug-in>
 

フォームリセット定義ファイル(reset.xml)にはアクションごとに リセット対象フィールドを設定する。
指定範囲リセット機能を使用する場合は、select 属性を true に設定する。(詳細については Resetter を参照。)
 <reset>
   <action path="/resetAction">
     <property-reset name="field1" />
     <property-reset name="field2" select="true" />
   </action>
   ・・・
 </reset>
 

公開識別子、およびDTDのURLを変更する場合は、
getPublicIdentifier()とgetDtdUrl()をオーバーライドすること。

関連項目:
ActionReset, FieldReset, Resetter, ResetterResources, FormEx, DynaValidatorActionFormEx, ValidatorActionFormEx

フィールドの概要
private static java.lang.String DEFAULT_RESETTER
          デフォルトリセッタクラスの完全修飾クラス名
private static Digester digester
          フォームリセットルール定義ファイル(reset-rules.xml) の情報を設定済みの Digesterインスタンスの参照
private static java.lang.String DIGESTER_RULES_PATH
          デフォルトの フォームリセット定義ファイル(reset.xml) のパス。
private  java.lang.String digesterRules
          フォームリセットルール定義ファイル(reset-rules.xml) のパス。
private  java.lang.String dtdUrl
          DTDパス。
private static Log log
          ログクラス。
private  java.lang.String publicIdentifier
          DTDの公開識別子。
private  java.lang.String resetter
          リセッタクラスの完全修飾クラス名。
private  java.lang.String resourcesPath
          フォームリセット定義ファイル(reset.xml) のパス。
 
コンストラクタの概要
ResetterPlugIn()
           
 
メソッドの概要
 void destroy()
          終了時処理。
 java.lang.String getDtdUrl()
          DTDのURLを返却する。
 java.lang.String getPublicIdentifier()
          公開識別子を返却する。
 void init(ActionServlet servlet, ModuleConfig config)
          初期化時処理。
protected  void initResetter(ActionServlet servlet, ModuleConfig config)
          リセット処理クラスの初期化処理。
protected  void initResources(ActionServlet servlet, ModuleConfig config)
          リセット初期化処理。
 void setDigesterRules(java.lang.String digesterRules)
          フォームリセットルール定義ファイル(reset-rules.xml)を設定する。
 void setDtdUrl(java.lang.String dtdUrl)
          DTDのURLを設定する。
 void setPublicIdentifier(java.lang.String publicIdentifier)
          公開識別子を設定する。
 void setResetter(java.lang.String string)
          Struts設定ファイル(struts-config.xml) に設定されているリセッタの完全修飾名を 設定する。
 void setResources(java.lang.String string)
          フォームリセット定義ファイル(reset.xml)のパス名を設定する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

log

private static Log log
ログクラス。


DIGESTER_RULES_PATH

private static final java.lang.String DIGESTER_RULES_PATH
デフォルトの フォームリセット定義ファイル(reset.xml) のパス。

関連項目:
定数フィールド値

digester

private static Digester digester
フォームリセットルール定義ファイル(reset-rules.xml) の情報を設定済みの Digesterインスタンスの参照


DEFAULT_RESETTER

private static final java.lang.String DEFAULT_RESETTER
デフォルトリセッタクラスの完全修飾クラス名


publicIdentifier

private java.lang.String publicIdentifier
DTDの公開識別子。


dtdUrl

private java.lang.String dtdUrl
DTDパス。


resetter

private java.lang.String resetter
リセッタクラスの完全修飾クラス名。


resourcesPath

private java.lang.String resourcesPath
フォームリセット定義ファイル(reset.xml) のパス。


digesterRules

private java.lang.String digesterRules
フォームリセットルール定義ファイル(reset-rules.xml) のパス。

コンストラクタの詳細

ResetterPlugIn

public ResetterPlugIn()
メソッドの詳細

destroy

public void destroy()
終了時処理。


init

public void init(ActionServlet servlet,
                 ModuleConfig config)
          throws javax.servlet.ServletException
初期化時処理。

パラメータ:
servlet - このPlugInを起動した ActionServlet。
config - この PlugIn の属する ModuleConfig。
例外:
javax.servlet.ServletException - 初期化時に発生した例外をラップした例外。

initResetter

protected void initResetter(ActionServlet servlet,
                            ModuleConfig config)
                     throws javax.servlet.ServletException
リセット処理クラスの初期化処理。 Struts設定ファイル(struts-config.xml) に設定したリセット処理クラスを取得する。 未設定の場合はデフォルトリセット処理クラスを取得する。

パラメータ:
servlet - このプラグインを起動したサーブレット。
config - モジュールコンフィグ
例外:
javax.servlet.ServletException - リセット処理クラスの初期化処理時に発生する例外

initResources

protected void initResources(ActionServlet servlet,
                             ModuleConfig config)
                      throws javax.servlet.ServletException
リセット初期化処理。 フォームリセット定義ファイル(reset.xml)、 フォームリセットルール定義ファイル(reset-rules.xml)を利用して、 設定情報を ResetterResources に読み込む。

パラメータ:
servlet - このプラグインを起動したサーブレット。
config - モジュールコンフィグ
例外:
javax.servlet.ServletException - リソースファイルが見つからない時に 発生する例外

getPublicIdentifier

public java.lang.String getPublicIdentifier()
公開識別子を返却する。 公開識別子を変更する場合は、このメソッドをオーバーライドする。

戻り値:
公開識別子

getDtdUrl

public java.lang.String getDtdUrl()
DTDのURLを返却する。 DTDのURLを変更する場合は、このメソッドをオーバーライドする。

戻り値:
DTDのURL

setResetter

public void setResetter(java.lang.String string)
Struts設定ファイル(struts-config.xml) に設定されているリセッタの完全修飾名を 設定する。

パラメータ:
string - リセッタの完全修飾名

setResources

public void setResources(java.lang.String string)
フォームリセット定義ファイル(reset.xml)のパス名を設定する。

パラメータ:
string - フォームリセット定義ファイル(reset.xml)のパス名

setDigesterRules

public void setDigesterRules(java.lang.String digesterRules)
フォームリセットルール定義ファイル(reset-rules.xml)を設定する。

パラメータ:
digesterRules - フォームリセットルール定義ファイル(reset-rules.xml) のパス名

setPublicIdentifier

public void setPublicIdentifier(java.lang.String publicIdentifier)
公開識別子を設定する。

パラメータ:
publicIdentifier - 公開識別子

setDtdUrl

public void setDtdUrl(java.lang.String dtdUrl)
DTDのURLを設定する。

パラメータ:
dtdUrl - DTDのURL