nablarch.common.web.tag

クラス CodeTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

nablarch.common.web.tag.CustomTagSupport

nablarch.common.web.tag.HtmlTagSupport

nablarch.common.web.tag.CodeTag

すべての実装されたインタフェース:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class CodeTag
extends HtmlTagSupport

コード値を出力するクラス。

関連項目:

直列化された形式

フィールドのサマリー

クラスから継承されたフィールド 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

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
CodeTag()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	doStartTag() name属性に対応する入力データが存在する場合は指定されたフォーマットで出力する。
void	setCodeId(java.lang.String codeId) コードIDを設定する。
void	setLabelPattern(java.lang.String labelPattern) ラベルを整形するパターンを設定する。
void	setListFormat(java.lang.String listFormat) リスト表示時に使用するフォーマットを設定する。
void	setName(java.lang.String name) XHTMLのname属性を設定する。
void	setOptionColumnName(java.lang.String optionColumnName) 取得するオプション名称のカラム名を設定する。
void	setPattern(java.lang.String pattern) 使用するパターンのカラム名を設定する。

クラスから継承されたメソッド nablarch.common.web.tag.HtmlTagSupport

doCatch, doFinally, getAttributes

クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

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

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

コンストラクタの詳細

CodeTag

public CodeTag()

メソッドの詳細

setName

public void setName(java.lang.String name)

XHTMLのname属性を設定する。

パラメータ:

name - XHTMLのname属性

setCodeId

public void setCodeId(java.lang.String codeId)

コードIDを設定する。

パラメータ:

codeId - コードID

setPattern

public void setPattern(java.lang.String pattern)

使用するパターンのカラム名を設定する。

パラメータ:

pattern - 使用するパターンのカラム名

setOptionColumnName

public void setOptionColumnName(java.lang.String optionColumnName)

取得するオプション名称のカラム名を設定する。

パラメータ:

optionColumnName - 取得するオプション名称のカラム名

setLabelPattern

public void setLabelPattern(java.lang.String labelPattern)

ラベルを整形するパターンを設定する。

 プレースホルダを下記に示す。
 
 $NAME$: コード値に対応するコード名称
 $SHORTNAME$: コード値に対応するコードの略称
 $OPTIONALNAME$: コード値に対応するコードのオプション名称
                 $OPTIONALNAME$を使用する場合は、optionColumnName属性の指定が必須となる。
 $VALUE$: コード値
 
 デフォルトは"$NAME$"。
 

パラメータ:

labelPattern - ラベルを整形するパターン

setListFormat

public void setListFormat(java.lang.String listFormat)

リスト表示時に使用するフォーマットを設定する。

 下記のいずれかを指定する。
 br(brタグ)
 div(divタグ)
 span(spanタグ)
 ul(ulタグ)
 ol(olタグ)
 sp(スペース区切り)
 
 デフォルトはbr。
 

パラメータ:

listFormat - リスト表示時に使用するフォーマット

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

 name属性に対応する入力データが存在する場合は指定されたフォーマットで出力する。
 ラベルはHTMLエスケープして出力する。
 

定義:

doStartTag インタフェース内 javax.servlet.jsp.tagext.Tag

オーバーライド:

doStartTag クラス内 javax.servlet.jsp.tagext.TagSupport

例外:

javax.servlet.jsp.JspException