フィールドの詳細

• UNIQUE_ID_PREFIX

  protected static final StringSE UNIQUE_ID_PREFIX

  ID のプレフィックスとして使用されます。これは、一時的な逐語的コンポーネントとの一意性の競合を回避するために必要です。

  関連事項:

  定数フィールド値

• bodyContent

  protected BodyContent bodyContent

  このタグハンドラーの bodyContent。

• pageContext

  protected PageContext pageContext

  埋め込まれているページの Jakarta Server Pages PageContext。

コンストラクターの詳細

• UIComponentClassicTagBase

  public UIComponentClassicTagBase()

メソッドの詳細

• getDoStartValue

  protected int getDoStartValue()
                         throws JspException

  呼び出されたときに doStart() メソッドから返されるフラグ値を返します。サブクラスは、このメソッドをオーバーライドして適切な値を返す場合があります。

  戻り値:

  doStart() から返す値

  例外:

  JspException - doStart() に例外をスローさせる

• getDoEndValue

  protected int getDoEndValue()
                       throws JspException

  呼び出されたときに doEnd() メソッドから返されるフラグ値を返します。サブクラスは、このメソッドをオーバーライドして適切な値を返す場合があります。

  戻り値:

  doEnd() から返す値

  例外:

  JspException - doEnd() に例外をスローさせる

• encodeBegin

  protected void encodeBegin()
                      throws IOExceptionSE

  非推奨。Jakarta Server Pages ページの実行中にエンコードは行われません。エンコーディングは、ページの実行が完了するまで延期され、エンコーディングが発生する前にツリー全体を構築できるようにします。

  対応する UIComponent の encodeBegin() メソッドにデリゲートします。このメソッドは doStartTag() から呼び出されます。通常、委譲は無条件に行われます。ただし、このメソッドは抽象化されているため、高度なタグが条件付きでこの呼び出しを実行できます。

  例外:

  IOExceptionSE - 入出力エラーが発生した場合

• encodeChildren

  protected void encodeChildren()
                         throws IOExceptionSE

  非推奨。Jakarta Server Pages ページの実行中にエンコードは行われません。エンコーディングは、ページの実行が完了するまで延期され、エンコーディングが発生する前にツリー全体を構築できるようにします。

  対応する UIComponent の encodeChildren() メソッドにデリゲートします。このメソッドは doStartTag() から呼び出されます。通常、委譲は無条件に行われます。ただし、このメソッドは抽象化されているため、高度なタグが条件付きでこの呼び出しを実行できます。

  例外:

  IOExceptionSE - 入出力エラーが発生した場合

• encodeEnd

  protected void encodeEnd()
                    throws IOExceptionSE

  非推奨。Jakarta Server Pages ページの実行中にエンコードは行われません。エンコーディングは、ページの実行が完了するまで延期され、エンコーディングが発生する前にツリー全体を構築できるようにします。

  対応する UIComponent の encodeEnd() メソッドにデリゲートします。このメソッドは doStartTag() から呼び出されます。通常、委譲は無条件に行われます。ただし、このメソッドは抽象化されているため、高度なタグが条件付きでこの呼び出しを実行できます。

  例外:

  IOExceptionSE - 入出力エラーが発生した場合

• setPageContext

  public void setPageContext(PageContext pageContext)

  このタグインスタンスを含むページの PageContext を設定します。

  次で指定:

  インターフェース Tag の setPageContext 

  パラメーター:

  pageContext - 囲んでいる PageContext

• getParent

  public Tag getParent()

  このインスタンスの親である Tag を返します。

  次で指定:

  インターフェース Tag の getParent 

  戻り値:

  現在の親。ない場合は null

  関連事項:

  TagSupport.findAncestorWithClass(javax.servlet.jsp.tagext.Tag, java.lang.Class<?>)

• setParent

  public void setParent(Tag parent)

  このインスタンスの親である Tag を設定します。

  次で指定:

  インターフェース Tag の setParent 

  パラメーター:

  parent - 新しい親 Tag

• setupResponseWriter

  protected void setupResponseWriter()

  現在のレスポンスに対して ResponseWriter をセットアップします（まだ行っていない場合）。

  @deprecated。ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot) は、レスポンスライターのセットアップを担当します。このメソッドは何もしなくなりました。

• findComponent

  protected UIComponent findComponent(FacesContext context)
                               throws JspException

  このタグハンドラーインスタンスに対応する UIComponent をコンポーネントツリーから見つけて返します。そのような UIComponent がない場合は、UIComponent を作成し、最も近い外側の UIComponentTag に関連付けられている UIComponent の子またはファセットとして追加します。コンポーネントを検索または作成するプロセスは次のとおりです。

  1. 以前にこのコンポーネントを見つけた場合は、それを返します。
  2. 親 UIComponentTag インスタンスを探して親コンポーネントを見つけ、そのコンポーネントを要求します。親 UIComponentTag インスタンスがない場合、このタグはルートコンポーネントを表すため、現在の Tree から取得して返します。
  3. この UIComponentTag インスタンスに facetName 属性が設定されている場合は、親 UIComponent にこの名前のファセットを要求してください。見つからない場合は作成し、新しいコンポーネントをパラメーターとして setProperties() を呼び出し、この名前で登録します。見つかった、または作成されたファセット UIComponent を返します。
  4. 次のように、新しいコンポーネントに割り当てるコンポーネント ID を決定します。この UIComponentTag に id 属性が設定されている場合は、その値を使用します。それ以外の場合は、このページが処理されるたびにこの UIComponent で同じであることが保証されている識別子を生成します（つまり、id 属性が設定されていないすべての UIComponentTag インスタンスの場所に基づく識別子）。
  5. この識別子を持つ子を親 UIComponent に要求します。見つからない場合は作成し、新しいコンポーネントをパラメーターとして指定して setProperties() を呼び出し、それをこの ID の子として登録します。検索または作成された子 UIComponent を返します。

  コンポーネントを作成するときのプロセスは次のとおりです。

  1. UIComponentTagBase.getComponentType() を呼び出してコンポーネント型を取得する
  2. コンポーネントに binding 属性がある場合は、それから式を作成し、その式、FacesContext、コンポーネント型を使用して Application.createComponent(java.lang.String) を呼び出します。キー "binding" を使用して式を保存します。
  3. それ以外の場合は、コンポーネント型のみを指定して Application.createComponent(java.lang.String) を呼び出します。
  4. setProperties() を呼び出します。
  5. 新しいコンポーネントをその親の子またはファセットとして追加します

  パラメーター:

  context - 現在のリクエストの FacesContext。

  戻り値:

  見つかったコンポーネント

  例外:

  JspException - コンポーネントの検索中に予期しない状態が発生した場合

• getParentUIComponentClassicTagBase

  public static UIComponentClassicTagBase getParentUIComponentClassicTagBase(PageContext context)

  UIComponentClassicTagBase が存在する場合、最も近くにある UIComponentClassicTagBase を見つけて返します。それ以外の場合は、null を返します。

  パラメーター:

  context - 現在のページの PageContext 

  戻り値:

  親タグ

• getIndexOfNextChildTag

  protected int getIndexOfNextChildTag()

  クラスからコピーされた説明: UIComponentTagBase

  このタグの子として追加される次の子のインデックスを返します。デフォルトの実装は、作成されたコンポーネントのリストを維持し、リストのサイズを返します。

  次で指定:

  クラス UIComponentTagBase の getIndexOfNextChildTag 

  戻り値:

  インデックス

• addChild

  protected void addChild(UIComponent child)

  クラスからコピーされた説明: UIComponentTagBase

  指定された UIComponent のコンポーネント識別子を、このリクエストを処理するネストされた UIComponentTag によって作成または検索されたコンポーネント識別子のリストに追加します。

  次で指定:

  クラス UIComponentTagBase の addChild 

  パラメーター:

  child - 識別子を追加する必要がある新しい子

• addFacet

  protected void addFacet(StringSE name)

  クラスからコピーされた説明: UIComponentTagBase

  指定されたファセットのファセット名を、ネストされた UIComponentTag がこのリクエストを処理することによって作成または検索されたファセット名のリストに追加します。

  次で指定:

  クラス UIComponentTagBase の addFacet 

  パラメーター:

  name - 追加するファセット名

• createVerbatimComponentFromBodyContent

  protected UIComponent createVerbatimComponentFromBodyContent()

  このタグインスタンスの本文コンテンツから一時的な UIOutput コンポーネントを作成するか、本文コンテンツがない、本文コンテンツが空白である、本文コンテンツがコメントである場合は null を返します。

  戻り値:

  コンポーネント

• createVerbatimComponent

  protected UIOutput createVerbatimComponent()

  Application インスタンスを使用して、次の特性を持つ新しいコンポーネントを作成します。

  componentType は javax.faces.HtmlOutputText です。

  transient は true です。

  escape は false です。

  id は FacesContext.getViewRoot().createUniqueId() です

  戻り値:

  コンポーネント

• addVerbatimBeforeComponent

  protected void addVerbatimBeforeComponent(UIComponentClassicTagBase parentTag,
                                            UIComponent verbatim,
                                            UIComponent component)

  親の子リストのコンポーネントにコンポーネントの兄弟として逐語的に追加します。 コンポーネントの直前の位置で逐語的にリストに追加されます。

  パラメーター:

  parentTag - 親タグ

  verbatim - コンポーネントの前に追加する逐語的

  component - コンポーネントの後に追加されるコンポーネント

• addVerbatimAfterComponent

  protected void addVerbatimAfterComponent(UIComponentClassicTagBase parentTag,
                                           UIComponent verbatim,
                                           UIComponent component)

  親の子リスト内のコンポーネントで構成要素の兄弟として逐語的に追加します。 コンポーネントの直後の位置で逐語的にリストに追加されます。

  パラメーター:

  parentTag - 親タグ

  verbatim - コンポーネントの後に追加する逐語的

  component - コンポーネントの前に追加されるコンポーネント

• doStartTag

  public int doStartTag()
                 throws JspException

  ページ内のこのタグインスタンスに対応するビューで UIComponent インスタンスを検索（または作成）するために必要な処理を実行し、コンポーネントが作成された場合にのみ、ページ作成者が期待する適切な場所でツリーに挿入します。次に、一時的な UIOutput コンポーネントを作成し、このタグの UIComponent インスタンスの前にツリーに 配置します。この UIOutput コンポーネントの値には、クラスの説明に CASE 1 または CASE 2 でカバーされるものがすべて含まれている必要があります。

  ほとんどのコンポーネントで十分であることが意図されているデフォルトの実装は、getParentUIComponentClassicTagBase(javax.servlet.jsp.PageContext) を呼び出し、結果に対して createVerbatimComponentFromBodyContent() を呼び出すことによって、この 2 次要件を実装します。次に、addVerbatimBeforeComponent(javax.faces.webapp.UIComponentClassicTagBase, javax.faces.component.UIComponent, javax.faces.component.UIComponent) を呼び出して、返されたコンポーネントをこのタグインスタンスインスタンスの実際のコンポーネントの前にツリーに 追加します。

  戻る前に、コンポーネントはこのレスポンスのためにコンポーネントスタックにプッシュされ、getParentUIComponentClassicTagBase(javax.servlet.jsp.PageContext) メソッドが正しく機能できるようになります。

  返されるフラグ値は、getDoStartValue() メソッドを呼び出すことによって取得されます。このメソッドは、デフォルト値が必要ない場合にタグサブクラスがオーバーライドする可能性があります。

  次で指定:

  インターフェース Tag の doStartTag 

  戻り値:

  タグが本文を処理する場合は EVAL_BODY_INCLUDE、処理しない場合は SKIP_BODY。

  例外:

  JspException - エラーが発生した場合

  関連事項:

  BodyTag

• doEndTag

  public int doEndTag()
               throws JspException

  クラスの説明で CASE 3 の内容の影響を処理するために必要な処理を実行します。

  ほとんどのコンポーネントで十分であることが意図されているデフォルトの実装は、このインスタンスで createVerbatimComponentFromBodyContent() を呼び出し、子リストの最後にあるこのタグのコンポーネントのコンポーネントの子として追加します。さらに、以下のハウスキーピング手順が実行されます。

  • このページが最後に処理されたときに UIComponentTag インスタンスによって作成された子コンポーネントのコンポーネント ID のセットを UIComponent から取得します（存在する場合）。このページ処理パス中に作成された子のリストと比較し、古いリストに存在するが新しいリストには存在しないすべての子を削除します。新しいリストをコンポーネント属性として保存して、コンポーネントの状態の一部として保存されるようにします。
  • このページが最後に処理されたときに UIComponentTag インスタンスによって作成されたファセットのファセット名のセットを UIComponent から取得します（存在する場合）。このページ処理パス中に作成されたファセットのリストと比較し、古いリストに存在するが新しいリストには存在しないすべてのファセットを削除します。新しいリストをコンポーネント属性として保存して、コンポーネントの状態の一部として保存されるようにします。
  • コンポーネントへのすべての参照を解放し、このレスポンスのコンポーネントスタックからポップして、これが最も外側のコンポーネントである場合はスタックを削除します。

  返されるフラグ値は、getDoEndValue() メソッドを呼び出すことによって取得されます。このメソッドは、デフォルト値が必要ない場合にタグサブクラスがオーバーライドする可能性があります。

  次で指定:

  インターフェース Tag の doEndTag 

  戻り値:

  JSP ページの評価を続行するかどうかの指示。

  例外:

  JspException - エラーが発生した場合

• release

  public void release()

  このタグハンドラーの実行中に割り当てられたリソースを解放します。

  次で指定:

  インターフェース Tag の release 

• getDoAfterBodyValue

  protected int getDoAfterBodyValue()
                             throws JspException

  呼び出されたときに doAfterBody() メソッドから返されるフラグ値を返します。サブクラスは、このメソッドをオーバーライドして適切な値を返す場合があります。

  戻り値:

  doAfterBody() から返す値

  例外:

  JspException - 値の取得中に予期しない状態が発生した場合

• setBodyContent

  public void setBodyContent(BodyContent bodyContent)

  このタグハンドラーに bodyContent を設定します。このメソッドは、doInitiBody() の前に、アクション呼び出しごとに最大 1 回 Jakarta Server Pages ページ実装オブジェクトによって呼び出されます。このメソッドは、doStartTag() メソッドが SKIP_BODY または EVAL_BODY_INCLUDE を返す空のタグまたは空でないタグに対しては呼び出されません。

  次で指定:

  インターフェース BodyTag の setBodyContent 

  パラメーター:

  bodyContent - このタグの新しい BodyContent 

  関連事項:

  BodyTag.doInitBody(), IterationTag.doAfterBody()

• getPreviousOut

  public JspWriter getPreviousOut()

  BodyContent から JspWriter を取得します。

  戻り値:

  ライター

• getBodyContent

  public BodyContent getBodyContent()

• doInitBody

  public void doInitBody()
                  throws JspException

  体の評価の準備をします。このメソッドは、setBodyContent() の後、本体が最初に評価される前に、Jakarta Server Pages ページ実装オブジェクトによって呼び出されます。このメソッドは、空のタグ、または doStartTag() メソッドが SKIP_BODY または EVAL_BODY_INCLUDE を返す空でないタグに対しては呼び出されません。

  次で指定:

  インターフェース BodyTag の doInitBody 

  例外:

  JspException - エラーが発生した場合

  関連事項:

  IterationTag.doAfterBody()

• doAfterBody

  public int doAfterBody()
                  throws JspException

  クラスの説明で CASE 4 の内容の影響を処理するために必要な処理を実行します。

  getDoAfterBodyValue() から結果を返す

  次で指定:

  インターフェース IterationTag の doAfterBody 

  戻り値:

  身体の追加評価が必要かどうか

  例外:

  JspException - エラーが発生した場合

• setId

  public void setId(StringSE id)

  コンポーネントのコンポーネント識別子を設定します。引数が UIViewRoot.UNIQUE_ID_PREFIX で始まる場合は、IllegalArgumentException をスローします

  次で指定:

  クラス UIComponentTagBase の setId 

  パラメーター:

  id - 新しいコンポーネント識別子。これは UIViewRoot.UNIQUE_ID_PREFIX で始まらない場合があります。

  例外:

  IllegalArgumentExceptionSE - 引数が非 null で、UIViewRoot.UNIQUE_ID_PREFIX で始まる場合。

• getId

  protected StringSE getId()

  ページ作成者によって割り当てられた id 値を返します。

  戻り値:

  このタグの ID

• getFacesJspId

  protected StringSE getFacesJspId()

  このタグの有効期間（release() が呼び出される前）にこのメソッドが以前に呼び出された場合は、以前に返された値を返します。それ以外の場合、getJspId() が非 null を返す場合は、UNIQUE_ID_PREFIX を jspId の前に付加して、結果を返します。

  戻り値:

  上記で指定された値

• getCreatedComponents

  protected ListSE<StringSE> getCreatedComponents()

  現在のリクエストの処理中にネストされた UIComponentTag によって作成または検索された UIComponent ID の List を返します。

  戻り値:

  作成されたコンポーネント

• setJspId

  public void setJspId(StringSE id)

  JspIdConsumer で定義されています。このメソッドは、doStartTag() の前にコンテナーによって呼び出されます。引数はページ内で一意であることが保証されています。

  IMPLEMENTATION NOTE: このメソッドは、インクルード内の場所を検出し、特定の「論理ページ」内の各インクルードに一意の ID を割り当てます。これにより、明示的な ID のないコンポーネントを持つインクルードページで ID が重複する可能性を回避できます。

  次で指定:

  インターフェース JspIdConsumer の setJspId 

  パラメーター:

  id - このタグのコンテナー生成 ID。ページ内で一意であることが保証されています。

• getJspId

  public StringSE getJspId()

• setProperties

  protected abstract void setProperties(UIComponent component)

  このタグハンドラーインスタンスの対応するプロパティが明示的に設定されている場合、指定されたコンポーネントのプロパティと属性をオーバーライドします。このメソッドは、指定された UIComponent がこのタグハンドラーインスタンスの実行中に実際に作成された場合にのみ呼び出す必要があり、この呼び出しは UIComponent がビューに追加される前に発生します。

  追加のセットプロパティをサポートするタグサブクラスは、ベースクラス setProperties() メソッドが引き続き呼び出されることを確認する必要があります。追加のプロパティ foo および bar をサポートする典型的な実装は、次のようになります。

   protected void setProperties(UIComponent component) {
     super.setProperties(component);
     if (foo != null) {
       component.setAttribute("foo", foo);
     }
     if (bar != null) {
       component.setAttribute("bar", bar);
     }
   }
   

  デフォルトの実装は、次のプロパティをオーバーライドします。

  • rendered - このタグハンドラーインスタンスに rendered プロパティの値が指定されている場合に設定します。
  • rendererType - getRendererType() メソッドが null 以外の値を返す場合に設定します。

  パラメーター:

  component - プロパティがオーバーライドされる UIComponent

• createComponent

  protected abstract UIComponent createComponent(FacesContext context,
                                                 StringSE newId)
                                          throws JspException

  getComponentType() を呼び出すことによって返される型の新しい子コンポーネントを作成して返します。この UIComponentTag に NULL 以外の binding 属性がある場合、これは binding 属性用に作成された式を使用して Application.createComponent(java.lang.String) を呼び出すことによって実行され、式はコンポーネントに保管されます。それ以外の場合、Application.createComponent(java.lang.String) はコンポーネント型のみで呼び出されます。最後に、コンポーネント ID とその他のプロパティを初期化します。

  パラメーター:

  context - 現在のリクエストの FacesContext

  newId - コンポーネントの ID

  戻り値:

  作成されたコンポーネント

  例外:

  JspException - コンポーネントを作成できない場合

• hasBinding

  protected abstract boolean hasBinding()

  このコンポーネントに非 null バインディング属性がある場合、true を返します。このメソッドは、binding プロパティを Faces 1.1 スタイルの式言語プロパティとして公開するサブクラスと、Jakarta Expression Language API プロパティとして公開するサブクラスを許可するために必要です。

  戻り値:

  このコンポーネントにバインディング属性があるかどうか

• getComponentInstance

  public UIComponent getComponentInstance()

  このタグインスタンスに関連付けられている UIComponent インスタンスを返します。このメソッドは、このタグ内にネストされたタグで使用するように設計されており、このタグインスタンスでの doStartTag() と doEndTag() の実行の間にのみ有用な結果を返します。

  次で指定:

  クラス UIComponentTagBase の getComponentInstance 

  戻り値:

  コンポーネント

• getCreated

  public boolean getCreated()

  このタグの実行中に新しいコンポーネントインスタンスを動的に作成した場合は、true を返します。このメソッドは、このタグ内にネストされたタグで使用するように設計されており、このタグインスタンスでの doStartTag() と doEndTag() の実行の間にのみ有用な結果を返します。

  次で指定:

  クラス UIComponentTagBase の getCreated 

  戻り値:

  上記の結果

• getFacesContext

  protected FacesContext getFacesContext()

  クラスからコピーされた説明: UIComponentTagBase

  現在のリクエストの FacesContext インスタンスを返します。この値は、各タグインスタンスの doStartTag() の開始から doEndTag() の終了までのみ非 null になります。

  次で指定:

  クラス UIComponentTagBase の getFacesContext 

  戻り値:

  現在のリクエストの FacesContext 

• getFacetName

  protected StringSE getFacetName()

  保存するファセット名があれば、それを返します。それ以外の場合は、null を返します（子コンポーネントになることを示します）。

  戻り値:

  ファセットの名前