jp.terasoluna.fw.web.taglib
クラス WriteCodeValueTag

java.lang.Object
  上位を拡張 javax.servlet.jsp.tagext.TagSupport
      上位を拡張 jp.terasoluna.fw.web.taglib.WriteCodeValueTag
すべての実装されたインタフェース:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class WriteCodeValueTag
extends javax.servlet.jsp.tagext.TagSupport

WriteCodeValue タグ。

サーブレットコンテキストから 属性 codeList で指定された CodeListLoader を探し出し、 その中に保存されているコードリストから値を取得し、出力する。 見つからない場合は何も出力しない。

コードリストの読み込みは、 CodeListLoader インタフェースの実装クラスを参照のこと。 タグがサポートする属性

writeCodeValue タグでは、以下の属性をサポートする。

属性名 デフォルト値 必須性 実行時式 概要
codeList - true true この属性からCodeListLoaderを検索する。つまり CodeListLoader インタフェースを実装したbeanの名前を指定する。
key - false true 取得したコードリストから値を取得するためのキーを直接指定する。
name - false true 取得したコードリストから値を取得するためのキーを保持するBeanの名前。 key属性が指定されていた場合は、無効。
property - false true 取得したコードリストから値を取得するためのキーを保持するBeanのプロパティ。 key属性が指定されていた場合は、無効。
scope - false true 取得したコードリストから値を取得するためのキーを保持するBeanが 存在するスコープ。

カスタムタグのスクリプティング変数

このタグによって設定されるスクリプティング変数はありません。


使用方法

以下の例は、CodeListLoader インタフェースを実装したクラスの bean が "loader1"と言う名前で定義されており、 その中から"key1"というキーで取得できる値を 出力する場合の設定例である。
定義の方法は DBCodeListLoader、 及び MappedCodeListLoader を参照。

JSP 内での記述例。
  <t:writeCodeValue codeList="loader1" key="key1" />
 
コードリストのサイズ取得に関しては、WriteCodeCountTag を参照

関連項目:
CodeListLoader, DBCodeListLoader, MappedCodeListLoader, DefineCodeListTag, WriteCodeCountTag, 直列化された形式

フィールドの概要
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
id, pageContext
 
インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
EVAL_BODY_AGAIN
 
インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
コンストラクタの概要
WriteCodeValueTag()
           
 
メソッドの概要
 int doEndTag()
          タグ評価終了時に呼ばれるメソッド。
 int doStartTag()
          タグ評価開始時に呼ばれるメソッド。
 void release()
          タグハンドラ解放時の処理。
 void setCodeList(String codeList)
          コードリスト名を設定する。
 void setKey(String key)
          キーを設定する。
 void setName(String name)
          Bean名を設定する。
 void setProperty(String property)
          プロパティ名を設定する。
 void setScope(String scope)
          スコープを設定する。
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

WriteCodeValueTag

public WriteCodeValueTag()
メソッドの詳細

setName

public void setName(String name)
Bean名を設定する。

パラメータ:
name - Bean名

setProperty

public void setProperty(String property)
プロパティ名を設定する。

パラメータ:
property - プロパティ名

setScope

public void setScope(String scope)
スコープを設定する。

パラメータ:
scope - スコープ

setKey

public void setKey(String key)
キーを設定する。

パラメータ:
key - コードリストのキー

setCodeList

public void setCodeList(String codeList)
コードリスト名を設定する。

パラメータ:
codeList - コードリスト名

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
タグ評価開始時に呼ばれるメソッド。

サーブレットコンテキストから、ApplicationContextを取得し、 "codeList" 属性で指定された id で CodeListLoader を取得し、その中のコードリストから 値を取得し、出力する。 "key" 属性が指定されていれば、そのキー値を取得し、 指定されなければ、"name" 属性で指定されるbeanから キーを取得して用いる。 コードリストが発見できない場合や、 キーが存在しない場合は、何も出力しない。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の doStartTag
オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の doStartTag
戻り値:
処理制御指示。常に EVAL_BODY_INCLUDE
例外:
javax.servlet.jsp.JspException - JSP 例外

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
タグ評価終了時に呼ばれるメソッド。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の doEndTag
オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の doEndTag
戻り値:
処理制御指示。常に EVAL_PAGE
例外:
javax.servlet.jsp.JspException - JSP 例外

release

public void release()
タグハンドラ解放時の処理。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の release
オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の release


Copyright © 2012. All Rights Reserved.