パッケージ jakarta.servlet.jsp.tagext

クラス TagSupport

  • 実装されたすべてのインターフェース:
    IterationTag、JspTag、Tag、SerializableSE
    既知の直属サブクラス
    BodyTagSupport、ConditionalTagSupport、LoopTagSupport
    public class TagSupport
extends ObjectSE
implements IterationTag, SerializableSE
    Tag を実装する新しいタグハンドラーを定義するための基本クラス。

    TagSupport クラスは、新しいタグハンドラーの基本クラスとして使用することを目的としたユーティリティクラスです。TagSupport クラスは、Tag および IterationTag インターフェースを実装し、Tag のプロパティ用の getter メソッドを含む追加の便利なメソッドを追加します。TagSupport には、連携するタグ間の調整を容易にするために含まれる 1 つの静的メソッドがあります。

    多くのタグハンドラーは TagSupport を継承し、少数のメソッドのみを再定義します。

    関連事項:
    直列化された形式

    • フィールドの詳細

      • id

        protected StringSE id
        このタグの id 属性の値。または null。

      • pageContext

        protected PageContext pageContext
        PageContext。

    • コンストラクターの詳細

      • TagSupport

        public TagSupport()
        デフォルトのコンストラクター。すべてのサブクラスは、同じシグネチャーを持つ public コンストラクターのみを定義し、スーパークラスコンストラクターを呼び出す必要があります。このコンストラクターは、JSP トランスレーターによって生成されたコードによって呼び出されます。

    • メソッドの詳細

      • findAncestorWithClass

        public static final Tag findAncestorWithClass​(Tag from,
                                              ClassSE<?> klass)
        特定のインスタンスに最も近い特定のクラス型のインスタンスを検索します。このメソッドは、タグインターフェースの getParent メソッドを使用します。このメソッドは、連携するタグ間の調整に使用されます。

        仕様の現在のバージョンは、タグハンドラーの監視可能な型を示す 1 つの正式な方法のみを提供しています。タグハンドラーの実装クラスは、タグ要素の tag-class サブ要素で説明されます。これは、タグライブラリの作成者が記述サブ要素でオブザーバブル型を指定できるようにすることにより、非公式な方法で拡張されます。型は、タグハンドラー実装クラスのサブ型または void である必要があります。この追加の制約は、JSP 標準タグライブラリの場合のように、その特定のタグライブラリについて知っている特殊なコンテナーによって悪用される可能性があります。

        タグライブラリの作成者がタグハンドラーの監視可能な型に関する情報を提供する場合、クライアントのプログラムコードはその制約に従う必要があります。具体的には、findAncestorWithClass に渡されるクラスは、監視可能な型のサブ型である必要があります。

        パラメーター:
        from - 検索を開始するインスタンス。
        klass - 一致するタグまたはインターフェースのサブクラス
        戻り値:
        インターフェースを実装するか、指定されたクラスのインスタンスである最も近い祖先

      • doStartTag

        public int doStartTag()
               throws JspException
        開始タグのデフォルト処理。SKIP_BODY を返します。
        次で指定:
        インターフェース Tag の doStartTag 
        戻り値:
        SKIP_BODY
        例外:
        JspException - このタグの処理中にエラーが発生した場合
        関連事項:
        Tag.doStartTag()

      • doEndTag

        public int doEndTag()
             throws JspException
        EVAL_PAGE を返す終了タグのデフォルト処理。
        次で指定:
        インターフェース Tag の doEndTag 
        戻り値:
        EVAL_PAGE
        例外:
        JspException - このタグの処理中にエラーが発生した場合
        関連事項:
        Tag.doEndTag()

      • release

        public void release()
        リリース状態。
        次で指定:
        インターフェース Tag の release 
        関連事項:
        Tag.release()

      • setParent

        public void setParent​(Tag t)
        このタグのネストタグを設定します。
        次で指定:
        インターフェース Tag の setParent 
        パラメーター:
        t - 親タグ。
        関連事項:
        Tag.setParent(Tag)

      • getParent

        public Tag getParent()
        このタグインスタンスを最も密接に囲むタグインスタンス。
        次で指定:
        インターフェース Tag の getParent 
        戻り値:
        親タグインスタンスまたは null
        関連事項:
        Tag.getParent()

      • setId

        public void setId​(StringSE id)
        このタグの id 属性を設定します。
        パラメーター:
        id - ID の文字列。

      • getId

        public StringSE getId()
        このタグの id 属性の値。または null。
        戻り値:
        id 属性の値、または null

      • setValue

        public void setValue​(StringSE k,
                     ObjectSE o)
        値を文字列キーに関連付けます。
        パラメーター:
        k - キー文字列。
        o - 関連付ける値。

      • getValue

        public ObjectSE getValue​(StringSE k)
        キーに関連付けられた値を取得します。
        パラメーター:
        k - 文字列キー。
        戻り値:
        キーに関連付けられた値、または null。

      • removeValue

        public void removeValue​(StringSE k)
        キーに関連付けられた値を削除します。
        パラメーター:
        k - 文字列キー。

      • getValues

        public EnumerationSE<StringSE> getValues()
        このタグハンドラーが保持する値のキーを列挙します。
        戻り値:
        値セットのすべてのキーの列挙、または値が設定されていない場合は null または空の列挙。