パッケージ jakarta.faces.component

クラス UIMessages

java.lang.ObjectSE
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIMessages
実装済みのインターフェース一覧:
PartialStateHolder、StateHolder、TransientStateHolder、ComponentSystemEventListener、FacesListener、SystemEventListenerHolder、EventListenerSE
既知の直属サブクラス
HtmlMessages
public class UIMessages extends UIComponentBase

このコンポーネントのレンダラーは、FacesContext からメッセージを取得してユーザーに表示する責任があります。

このコンポーネントは、Messages レンダラー型をサポートします。

デフォルトでは、rendererType プロパティを "jakarta.faces.Messages" に設定する必要があります。この値は、setRendererType() メソッドを呼び出すことで変更できます。

  • フィールドの詳細

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

    • UIMessages

      public UIMessages()

      デフォルトのプロパティ値で新しい UIMessages インスタンスを作成します。

  • メソッドの詳細

    • getFamily

      public StringSE getFamily()
      クラスからコピーされた説明: UIComponent

      このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、rendererType プロパティの値と組み合わせて、このコンポーネントインスタンスに適切な Renderer を選択するために使用できます。このメソッドは null を返すべきではないことに注意してください

      次で指定:
      クラス UIComponent の getFamily 
      戻り値:
      コンポーネントファミリ（null 以外）。

    • getFor

      public StringSE getFor()

      このコンポーネントが関連するメッセージを表すコンポーネントのクライアント識別子を返します（存在する場合）。

      戻り値:
      for クライアント識別子。

    • setFor

      public void setFor(StringSE newFor)

      このコンポーネントが関連するメッセージを表すコンポーネントのクライアント識別子を設定します（存在する場合）。このプロパティは、メッセージを表示する前に設定する必要があります。

      パラメーター:
      newFor - 新しいクライアント ID

    • isGlobalOnly

      public boolean isGlobalOnly()

      グローバルメッセージ（つまり、クライアント識別子が関連付けられていないメッセージ）のみをレンダリングするかどうかを示すフラグを返します。優先される "for" プロパティと相互に排他的です。デフォルトは false です。

      戻り値:
      グローバルメッセージのみを表示する場合は true、それ以外の場合は false。

    • setGlobalOnly

      public void setGlobalOnly(boolean globalOnly)

      グローバルメッセージ（つまり、クライアント識別子が関連付けられていないメッセージ）のみをレンダリングするかどうかを示すフラグを設定します。

      パラメーター:
      globalOnly - 新しいフラグ値

    • isShowDetail

      public boolean isShowDetail()

      関連するメッセージの detail プロパティを表示するかどうかを示すフラグを返します。デフォルトは false です。

      戻り値:
      詳細を表示する場合は true、それ以外の場合は false。

    • setShowDetail

      public void setShowDetail(boolean showDetail)

      関連するメッセージの detail プロパティを表示するかどうかを示すフラグを設定します。

      パラメーター:
      showDetail - 新しい旗

    • isShowSummary

      public boolean isShowSummary()

      関連するメッセージの summary プロパティを表示するかどうかを示すフラグを返します。デフォルトは true です。

      戻り値:
      要約を表示する場合は true、それ以外の場合は false。

    • setShowSummary

      public void setShowSummary(boolean showSummary)

      関連するメッセージの summary プロパティを表示するかどうかを示すフラグを設定します。

      パラメーター:
      showSummary - 新しいフラグ値

    • isRedisplay

      public boolean isRedisplay()
      戻り値:
      この UIMessage インスタンスがすでに処理された FacesMessage を再表示する必要がある場合は、true。それ以外の場合は、false を返します。デフォルトでは、setRedisplay(boolean) が呼び出されていない場合、このメソッドは常に true を返します。
      導入:
      2.0

    • setRedisplay

      public void setRedisplay(boolean redisplay)

      関連するメッセージの detail プロパティを表示するかどうかを示すフラグを設定します。

      パラメーター:
      redisplay - 以前に処理されたメッセージが再表示されるかどうかを示すフラグ
      導入:
      2.0