javax.servlet.jsp.tagext
クラス TagSupport

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport

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

IterationTag, java.io.Serializable, Tag

直系の既知のサブクラス:

BodyTagSupport

public class TagSupport

extends java.lang.Object

implements IterationTag, java.io.Serializable

Tag を実装している新しいタグハンドラを定義するための基底クラスです。

TagSupport クラスは、新しいタグハンドラの基底クラスとして使用するユーティリティクラスです。TagSupport クラスは、Tag および IterationTag インタフェースを実装し、Tag 内のプロパティを取得するメソッドなどの簡易メソッドを追加します。TagSupport には、関連付けられているタグ間の連携を強化する静的なメソッドも組み込まれています。

タグハンドラは通常の場合、TagSupport を拡張し、いくつかのメソッドを再定義するだけで利用することができます。

関連項目:

直列化された形式

フィールドの概要

protected java.lang.String	id
protected PageContext	pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

コンストラクタの概要

TagSupport()
デフォルトのコンストラクタです。

メソッドの概要

int	doAfterBody() タグ本体のデフォルトの処理です。
int	doEndTag() 終了タグのデフォルトの処理です。
int	doStartTag() 開始タグのデフォルトの処理です。
static Tag	findAncestorWithClass(Tag from, java.lang.Class klass) 指定されたインスタンスにもっとも近く、かつ指定されたクラスと型が一致するインスタンスを検出します。
java.lang.String	getId() このタグの id 属性の値または null です。
Tag	getParent() このタグインスタンスをもっとも近くで囲む Tag インスタンスです。
java.lang.Object	getValue(java.lang.String k) キーに関連付けられた値を取得します。
java.util.Enumeration	getValues() このタグハンドラが保持している値を列挙します。
void	release() 状態を解放します。
void	removeValue(java.lang.String k) キーに関連付けられた値を削除します。
void	setId(java.lang.String id) このタグの id 属性を設定します。
void	setPageContext(PageContext pageContext) ページコンテキストを設定します。
void	setParent(Tag t) このタグの上位タグを設定します。
void	setValue(java.lang.String k, java.lang.Object o) 値を String のキーに関連付けます。

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

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

フィールドの詳細

id

protected java.lang.String id

pageContext

protected PageContext pageContext

コンストラクタの詳細

TagSupport

public TagSupport()

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

メソッドの詳細

findAncestorWithClass

public static final Tag findAncestorWithClass(Tag from,
                                              java.lang.Class klass)

指定されたインスタンスにもっとも近く、かつ指定されたクラスと型が一致するインスタンスを検出します。このメソッドは、Tag インタフェースの getParent メソッドを使用します。このメソッドは、関連付けられているタグ間の連携のために使用されます。

現在の仕様では、監視可能なタグハンドラを指定する正式な方法は 1 つしか用意されていません。つまり、タグハンドラ実装クラスを、tag 要素の下にある tag-class 要素に記述する必要があります。ほかに非公式な方法として、タグライブラリの作成者が tag 要素の下にある description の要素に監視可能なタグハンドラを指定する方式があります。このタグハンドラの型は、そのサブタイプまたは void にする必要があります。この設定は、JSP 標準タグライブラリなど、そのタグライブラリを認識する特別なコンテナで利用できます。

タグライブラリの作成者が監視可能なタグハンドラの情報を提供するときは、クライアントのプログラミングコードがその設定に準拠している必要があります。つまり、findAncestorWithClass へ渡すクラスは、監視可能なタグハンドラのサブタイプである必要があります。

パラメータ:

from - 検索を開始するインスタンス

klass - 照合される Tag またはインタフェースのサブクラス

戻り値:

そのインタフェースを実装しているか、指定されたクラスの型を持つ、もっとも近い上位のインスタンス

doStartTag

public int doStartTag()
               throws JspException

開始タグのデフォルトの処理です。SKIP_BODY を返します。

定義:

インタフェース Tag 内の doStartTag

戻り値:

SKIP_BODY

関連項目:

Tag.doStartTag()

doEndTag

public int doEndTag()
             throws JspException

終了タグのデフォルトの処理です。EVAL_PAGE を返します。

定義:

インタフェース Tag 内の doEndTag

戻り値:

EVAL_PAGE

関連項目:

Tag.doEndTag()

doAfterBody

public int doAfterBody()
                throws JspException

タグ本体のデフォルトの処理です。

定義:

インタフェース IterationTag 内の doAfterBody

戻り値:

SKIP_BODY

関連項目:

IterationTag.doAfterBody()

release

public void release()

状態を解放します。

定義:

インタフェース Tag 内の release

関連項目:

Tag.release()

setParent

public void setParent(Tag t)

このタグの上位タグを設定します。

定義:

インタフェース Tag 内の setParent

パラメータ:

t - 親の Tag

関連項目:

Tag.setParent(Tag)

getParent

public Tag getParent()

このタグインスタンスをもっとも近くで囲む Tag インスタンスです。

定義:

インタフェース Tag 内の getParent

戻り値:

親のタグインスタンスまたは null

関連項目:

Tag.getParent()

setId

public void setId(java.lang.String id)

このタグの id 属性を設定します。

パラメータ:

id - id の文字列

getId

public java.lang.String getId()

このタグの id 属性の値または null です。

戻り値:

id 属性の値または null

setPageContext

public void setPageContext(PageContext pageContext)

ページコンテキストを設定します。

定義:

インタフェース Tag 内の setPageContext

パラメータ:

pageContenxt - PageContext

関連項目:

Tag.setPageContext(javax.servlet.jsp.PageContext)

setValue

public void setValue(java.lang.String k,
                     java.lang.Object o)

値を String のキーに関連付けます。

パラメータ:

k - キーの String

o - 関連付ける値

getValue

public java.lang.Object getValue(java.lang.String k)

キーに関連付けられた値を取得します。

パラメータ:

k - 文字列のキー

戻り値:

キーに関連付けられた値または null

removeValue

public void removeValue(java.lang.String k)

キーに関連付けられた値を削除します。

パラメータ:

k - 文字列のキー

getValues

public java.util.Enumeration getValues()

このタグハンドラが保持している値を列挙します。

戻り値:

設定されているすべての値の列挙