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

クラス SimpleTagSupport

  • 実装されたすべてのインターフェース:
    JspTag, SimpleTag
    public class SimpleTagSupport
extends ObjectSE
implements SimpleTag
    SimpleTag を実装するタグハンドラーを定義するための基本クラス。

    SimpleTagSupport クラスは、新しい単純なタグハンドラーの基本クラスとして使用することを目的としたユーティリティクラスです。SimpleTagSupport クラスは SimpleTag インターフェースを実装し、SimpleTag のプロパティ用の getter メソッドを含む追加の便利なメソッドを追加します。

    導入:
    JSP 2.0

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

      • SimpleTagSupport

        public SimpleTagSupport()
        唯一のコンストラクター。(サブクラスコンストラクターによる呼び出しの場合、通常は暗黙的です。)

    • メソッドの詳細

      • doTag

        public void doTag()
           throws JspException,
                  IOExceptionSE
        タグのデフォルト処理は何もしません。
        次で指定:
        インターフェース SimpleTag の doTag 
        例外:
        JspException - サブクラスは JspException をスローして、このタグの処理中にエラーが発生したことを示すことができます。
        SkipPageException - このタグを（直接または間接的に）呼び出したページが評価を中止する場合。呼び出されたクラシックタグハンドラーが SKIP_PAGE を返した場合、または呼び出されたシンプルタグハンドラーが SkipPageException をスローした場合、または呼び出された Jsp フラグメントが SkipPageException をスローした場合、タグファイルから生成されるシンプルタグハンドラーはこの例外をスローする必要があります。
        IOExceptionSE - 出力ストリームへの書き込みエラーが発生した場合、サブクラスは IOException をスローできます
        関連事項:
        SimpleTag.doTag()

      • setParent

        public void setParent​(JspTag parent)
        コラボレーションのために、このタグの親を設定します。

        コンテナーは、このタグ呼び出しが別のタグ呼び出し内にネストされている場合にのみ、このメソッドを呼び出します。

        次で指定:
        インターフェース SimpleTag の setParent 
        パラメーター:
        parent - このタグを囲むタグ

      • getParent

        public JspTag getParent()
        コラボレーションの目的で、このタグの親を返します。
        次で指定:
        インターフェース SimpleTag の getParent 
        戻り値:
        このタグの親

      • setJspContext

        public void setJspContext​(JspContext pc)
        提供された JSP コンテキストをプライベート jspContext フィールドに保存します。サブクラスは getJspContext() を介して JspContext にアクセスできます。
        次で指定:
        インターフェース SimpleTag の setJspContext 
        パラメーター:
        pc - この呼び出しのページコンテキスト
        関連事項:
        SimpleTag.setJspContext(jakarta.servlet.jsp.JspContext)

      • getJspContext

        protected JspContext getJspContext()
        setJspContext 経由でコンテナーから渡されたページコンテキストを返します。
        戻り値:
        この呼び出しのページコンテキスト

      • setJspBody

        public void setJspBody​(JspFragment jspBody)
        提供された JspFragment を保存します。
        次で指定:
        インターフェース SimpleTag の setJspBody 
        パラメーター:
        jspBody - このタグの本体をカプセル化するフラグメント。ページ内のアクション要素が空の場合、このメソッドはまったく呼び出されません。
        関連事項:
        SimpleTag.setJspBody(jakarta.servlet.jsp.tagext.JspFragment)

      • getJspBody

        protected JspFragment getJspBody()
        setJspBody 経由でコンテナーから渡された本体を返します。
        戻り値:
        このタグの本文をカプセル化するフラグメント。アクション要素がページ内で空の場合は null。

      • findAncestorWithClass

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

        祖先をトラバースする際に遭遇する TagAdapter のインスタンスごとに、TagAdpater 自体ではなく、TagAdapter.getAdaptee() によって返されるタグハンドラーが klass と比較されます。タグハンドラーが一致する場合、その TagAdapter ではなく、それが返されます。

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

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

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