nablarch.common.web.tag

Class CodeSelectTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

nablarch.common.web.tag.CustomTagSupport

nablarch.common.web.tag.HtmlTagSupport

nablarch.common.web.tag.GenericAttributesTagSupport

nablarch.common.web.tag.SelectTagSupport

nablarch.common.web.tag.CodeSelectTag

All Implemented Interfaces:

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

public class CodeSelectTag
extends SelectTagSupport

入力データ復元とHTMLエスケープを行うコード値の選択項目(selectタグ)を出力するクラス。

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
CodeSelectTag()

Method Summary

Modifier and Type	Method and Description
int	doStartTag()
protected java.lang.String	getTagName() タグ名を取得する。
void	setCodeId(java.lang.String codeId) コードIDを設定する。
void	setErrorCss(java.lang.String errorCss) エラーレベルのメッセージに使用するCSSクラス名を設定する。 デフォルトは"nablarch_error"。
void	setLabelPattern(java.lang.String labelPattern) ラベルを整形するパターンを設定する。
void	setListFormat(java.lang.String listFormat) リスト表示時に使用するフォーマットを設定する。
void	setNameAlias(java.lang.String nameAlias) name属性のエイリアスを設定する。 複数指定する場合はカンマ区切り。
void	setNoneOptionLabel(java.lang.String noneOptionLabel) リスト先頭に選択なしのオプションを追加する場合に使用するラベルを設定する。 この属性は、withNoneOptionにtrueを指定した場合のみ有効となる。 デフォルトは""。
void	setOptionColumnName(java.lang.String optionColumnName) 取得するオプション名称のカラム名を設定する。
void	setPattern(java.lang.String pattern) 使用するパターンのカラム名を設定する。
void	setWithNoneOption(boolean withNoneOption) リスト先頭に選択なしのオプションを追加するか否かを設定する。 デフォルトはfalse。

Methods inherited from class nablarch.common.web.tag.SelectTagSupport

setAutofocus, setDisabled, setMultiple, setName, setOnblur, setOnchange, setOnfocus, setSize, setTabindex

Methods inherited from class nablarch.common.web.tag.GenericAttributesTagSupport

checkChildElementsOfForm, setCssClass, setDir, setId, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setTitle, setXmlLang

Methods inherited from class nablarch.common.web.tag.HtmlTagSupport

doCatch, doFinally, getAttributes, setDynamicAttribute

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeSelectTag

public CodeSelectTag()

Method Detail

setCodeId

public void setCodeId(java.lang.String codeId)

コードIDを設定する。

Parameters:

codeId - コードID

setPattern

public void setPattern(java.lang.String pattern)

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

Parameters:

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

setOptionColumnName

public void setOptionColumnName(java.lang.String optionColumnName)

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

Parameters:

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

setLabelPattern

public void setLabelPattern(java.lang.String labelPattern)

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

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

Parameters:

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

setListFormat

public void setListFormat(java.lang.String listFormat)

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

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

Parameters:

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

setWithNoneOption

public void setWithNoneOption(boolean withNoneOption)

リスト先頭に選択なしのオプションを追加するか否かを設定する。
デフォルトはfalse。

Parameters:

withNoneOption - 追加する場合はtrue、追加しない場合はfalse

setNoneOptionLabel

public void setNoneOptionLabel(java.lang.String noneOptionLabel)

リスト先頭に選択なしのオプションを追加する場合に使用するラベルを設定する。 この属性は、withNoneOptionにtrueを指定した場合のみ有効となる。
デフォルトは""。

Parameters:

noneOptionLabel - リスト先頭に選択なしのオプションを追加する場合に使用するラベル

setErrorCss

public void setErrorCss(java.lang.String errorCss)

エラーレベルのメッセージに使用するCSSクラス名を設定する。
デフォルトは"nablarch_error"。

Parameters:

errorCss - エラーレベルのメッセージに使用するCSSクラス名

setNameAlias

public void setNameAlias(java.lang.String nameAlias)

name属性のエイリアスを設定する。
複数指定する場合はカンマ区切り。

Parameters:

nameAlias - name属性のエイリアス

doStartTag

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

 入力画面と確認画面で出力内容が異なる。
 
 入力画面：
 リストをoptionタグに展開したselectタグを出力する。
 
 selectタグ：
 指定された属性を使用してselectタグを出力する。
 属性はHTMLエスケープして出力する。
 選択なしオプションが指定された場合は、選択なしのoptionタグを出力する。
 選択なしオプションのvalue属性は常に空文字となる。
 
 optionタグ：
 リストから取得した値とラベルを使用してoptionタグを出力する。
 name属性に対応する入力データが存在する場合はselected属性を設定する。
 属性とラベルはHTMLエスケープして出力する。
 
 FormContextにname属性を設定する。
 
 確認画面：
 name属性に対応する入力データが存在する場合は指定されたフォーマットで出力する。
 ラベルはHTMLエスケープして出力する。
 

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

getTagName

protected java.lang.String getTagName()

タグ名を取得する。

Overrides:

getTagName in class SelectTagSupport

Returns:

タグ名