CodeCheckboxTag (Nablarch-API)

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.FocusAttributesTagSupport
        
        nablarch.common.web.tag.InputTagSupport
        
        nablarch.common.web.tag.CheckedInputTagSupport
        
        nablarch.common.web.tag.CheckboxTagSupport
        
        nablarch.common.web.tag.CodeCheckboxTag

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

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 CodeCheckboxTag
extends CheckboxTagSupport
```
入力データ復元とHTMLエスケープを行うコード値の単一入力項目(inputタグ(type="checkbox"))を出力するクラス。

関連項目:

直列化された形式

フィールドのサマリー
- クラスから継承されたフィールド nablarch.common.web.tag.CheckboxTagSupport
  CHECKBOX_OFF_PARAM_PREFIX
- クラスから継承されたフィールド 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

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

コンストラクタ
コンストラクタと説明

CodeCheckboxTag()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected java.lang.String`	`getLabel()` ラベルを取得する。
`protected java.lang.String`	`getOffLabel()` チェックなしの場合に使用するラベルを取得する。
`protected java.lang.String`	`getOffValue()` チェックなしの場合に使用する値を取得する。
`protected java.lang.String`	`getTagName()` タグ名を取得する。
`void`	`setCodeId(java.lang.String codeId)` コードIDを設定する。
`void`	`setLabelPattern(java.lang.String labelPattern)` ラベルを整形するパターンを設定する。
`void`	`setOffCodeValue(java.lang.String offCodeValue)` チェックなしの場合に使用するコード値を設定する。
`void`	`setOptionColumnName(java.lang.String optionColumnName)` 取得するオプション名称のカラム名を設定する。

クラスから継承されたメソッド nablarch.common.web.tag.CheckboxTagSupport
createInputTag, createOutputTag, getType, getUseOffValue, getValue

クラスから継承されたメソッド nablarch.common.web.tag.CheckedInputTagSupport
doStartTag, isChecked, setErrorCss, setLabel, setNameAlias, setOnchange, setValue

クラスから継承されたメソッド nablarch.common.web.tag.InputTagSupport
setAutofocus, setDisabled, setName

クラスから継承されたメソッド nablarch.common.web.tag.FocusAttributesTagSupport
setAccesskey, setOnblur, setOnfocus, setTabindex

クラスから継承されたメソッド nablarch.common.web.tag.GenericAttributesTagSupport
checkChildElementsOfForm, setCssClass, setDir, setId, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setTitle, setXmlLang

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

クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - CodeCheckboxTag
```
public CodeCheckboxTag()
```
- メソッドの詳細
  - setCodeId
```
public void setCodeId(java.lang.String codeId)
```
    コードIDを設定する。
    
    パラメータ:
    
    codeId - コードID
  - 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 - ラベルを整形するパターン
  - setOffCodeValue
```
public void setOffCodeValue(java.lang.String offCodeValue)
```
    チェックなしの場合に使用するコード値を設定する。
    
    パラメータ:
    
    offCodeValue - チェックなしの場合に使用するコード値
  - getOffLabel
```
protected java.lang.String getOffLabel()
```
    クラスからコピーされた説明: CheckboxTagSupport
    
    チェックなしの場合に使用するラベルを取得する。
    
    定義:
    
    getOffLabel クラス内 CheckboxTagSupport
    
    戻り値:
    
    チェックなしの場合に使用するラベル
  - getOffValue
```
protected java.lang.String getOffValue()
```
    チェックなしの場合に使用する値を取得する。
    デフォルト実装では、デフォルトの値(CustomTagConfig.getCheckboxOffValue())を返す。
    offCodeValue属性が指定されない場合は、 codeId属性の値からチェックなしの場合に使用するコード値を検索する。検索結果が2件、かつ1件がvalue属性の値である場合は、残りの1件をチェックなしのコード値として使用する。検索で見つからない場合は、デフォルト値を返す。
    
    オーバーライド:
    
    getOffValue クラス内 CheckboxTagSupport
    
    戻り値:
    
    チェックなしの場合に使用する値
  - getLabel
```
protected java.lang.String getLabel()
```
    クラスからコピーされた説明: CheckedInputTagSupport
    
    ラベルを取得する。
    
    オーバーライド:
    
    getLabel クラス内 CheckedInputTagSupport
    
    戻り値:
    
    ラベル
  - getTagName
```
protected java.lang.String getTagName()
```
    タグ名を取得する。
    
    定義:
    
    getTagName クラス内 GenericAttributesTagSupport
    
    戻り値:
    
    タグ名

クラス CodeCheckboxTag

フィールドのサマリー

クラスから継承されたフィールド nablarch.common.web.tag.CheckboxTagSupport

クラスから継承されたフィールド javax.servlet.jsp.tagext.TagSupport

インタフェースから継承されたフィールド javax.servlet.jsp.tagext.IterationTag

インタフェースから継承されたフィールド javax.servlet.jsp.tagext.Tag

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

メソッドのサマリー

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

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

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

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

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

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

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

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

コンストラクタの詳細

CodeCheckboxTag

メソッドの詳細

setCodeId

setOptionColumnName

setLabelPattern

setOffCodeValue

getOffLabel

getOffValue

getLabel

getTagName