javax.servlet.jsp.tagext
クラス TagSupport

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

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

IterationTag, Serializable, Tag

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

BodyTagSupport

public class TagSupport

extends Object

implements IterationTag, Serializable

Tagを実装している新しいタグハンドラを定義する基本クラス。

TagSupportクラスは、新しいタグハンドラのための基底クラスとして使われることを想定したユーティリティクラスです。 TagSupportクラスは、TagインタフェースとIterationTagインタフェース、Tagインタフェースのプロパティを取得するメソッドを含む便利な追加メソッドが実装されています。 TagSupportには、協調するタグ間での調整を促進するためにあるスタティックメソッドがひとつあります。

多くのタグハンドラは、TagSupportを継承し、2,3のメソッドを再定義しているだけです。

関連項目:

直列化された形式

フィールドの概要

protected 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() 終了タグの標準処理、EVAL_PAGEを返します。
int	doStartTag() 開始タグの標準処理、SKIP_BODYを返します。
static Tag	findAncestorWithClass(Tag from, Class klass) 与えられたインスタンスに最も近い与えられたクラスタイプのインスタンスを探します。
String	getId() タグのid属性の値、または、null
Tag	getParent() Tagインスタンスはこのタグインスタンスに近くで囲まなければなりません。
Object	getValue(String k) キーに関連付けられた値を取得します。
Enumeration	getValues() タグハンドラが保持している値の列挙。
void	release() 状態の開放
void	removeValue(String k) キーに関連付けられた値を削除します。
void	setId(String id) タグのid属性を設定します。
void	setPageContext(PageContext pageContext) ページコンテキストを設定します。
void	setParent(Tag t) このタグのネストしているタグを設定します。
void	setValue(String k, Object o) Stringのキーと値を関連付けます。

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

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

フィールドの詳細

id

protected String id

pageContext

protected PageContext pageContext

コンストラクタの詳細

TagSupport

public TagSupport()

標準コンストラクタ、全てのサブクラスで、同じ構造のパブリックコンストラクタが定義する必要があります。 そしてスーパークラスのコンストラクタを呼びます。 このコンストラクタは、JSPトランスレーターによって生成されたコードから呼び出されます。

メソッドの詳細

findAncestorWithClass

public static final Tag findAncestorWithClass(Tag from,
                                              Class klass)

与えられたインスタンスに最も近い与えられたクラスタイプのインスタンスを探します。 このメソッドはTagインタフェースのgetParentメソッドを使います。 このメソッドは、協調するタグ間で調整するために使用されます。

仕様の現バージョンでは、正式なタグハンドラの観測タイプを指定する方法をひとつ提供するだけです: タグ要素のtag-classサブ要素に記述されている、そのタグハンドラ実装クラス。 これは、観測タイプの記述サブ要素で指定するタグライブラリ著者に許可することによって非公式マナーとして展開します。 タイプは、タグハンドラ実装クラスのサブタイプであるか、voidであるべきです。 この追加制約は、JSP標準タグライブラリの場合は、特別なタグライブラリについて知っている特別なコンテナによって利用させることができます。

タグライブラリの著者が観測タイプのタグハンドラに関する情報を提供する時、クライアントプログラムコードは、この制約を固持するべきです。 特に、ClassをパスしたfindAncestorWithClassは観測タイプのサブタイプであるべきです。

パラメータ:

from - 探し始めるインスタンス

klass - Tagのサブクラス、または、一致されたインタフェース

戻り値:

インタフェースを実装しているか、特化されたクラスのインスタンスであるもっとも近い親

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()

doAfterBody

public int doAfterBody()
                throws JspException

ボディの標準処理

定義:

インタフェース IterationTag 内の doAfterBody

戻り値:

SKIP_BODY

例外:

JspException

関連項目:

IterationTag.doAfterBody()

release

public void release()

状態の開放

定義:

インタフェース Tag 内の release

関連項目:

Tag.release()

setParent

public void setParent(Tag t)

このタグのネストしているタグを設定します。

定義:

インタフェース Tag 内の setParent

パラメータ:

t - The parent Tag.親タグ

関連項目:

Tag.setParent(Tag)

getParent

public Tag getParent()

Tagインスタンスはこのタグインスタンスに近くで囲まなければなりません。

定義:

インタフェース Tag 内の getParent

戻り値:

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

関連項目:

Tag.getParent()

setId

public void setId(String id)

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

パラメータ:

id - Stringのid

getId

public String getId()

タグのid属性の値、または、null

戻り値:

id属性の値、または、null

setPageContext

public void setPageContext(PageContext pageContext)

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

定義:

インタフェース Tag 内の setPageContext

パラメータ:

pageContext - このタグハンドラのページコンテキスト。

関連項目:

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

setValue

public void setValue(String k,
                     Object o)

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

パラメータ:

k - Stringのキー。

o - 関連付ける値。

getValue

public Object getValue(String k)

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

パラメータ:

k - キー文字列

戻り値:

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

removeValue

public void removeValue(String k)

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

パラメータ:

k - キー文字列

getValues

public Enumeration getValues()

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

戻り値:

全ての値セットの列挙。