パッケージ org.springframework.webflow.engine

クラス ViewState

java.lang.ObjectSE
org.springframework.webflow.core.AnnotatedObject
org.springframework.webflow.engine.State
org.springframework.webflow.engine.TransitionableState
org.springframework.webflow.engine.ViewState
実装されたすべてのインターフェース:
Annotated、StateDefinition、TransitionableStateDefinition
public class ViewState extends TransitionableState
ビューステートは、フォーム入力を求めるなど、ユーザーにレスポンスを発行する状態です。これを実現するために、ViewState は ViewFactory に委譲します。
作成者:
Keith Donald, Erwin Vervaet
関連事項:

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

    • ViewState

      public ViewState(Flow flow, StringSE id, ViewFactory viewFactory) throws IllegalArgumentExceptionSE
      新しいビューステートを作成します。
      パラメーター:
      flow - 所有の流れ
      id - 状態識別子 (フローごとに一意である必要があります)
      viewFactory - ビューファクトリ
      例外:
      IllegalArgumentExceptionSE - この状態を特定のフローに追加できない場合（例: ID が一意ではないため）

  • メソッドの詳細

    • isViewState

      public boolean isViewState()
      インターフェースからコピーされた説明: StateDefinition
      この状態がビュー状態である場合は true を返します。
      次で指定:
      インターフェース StateDefinition の isViewState 
      オーバーライド:
      クラス State の isViewState 
      戻り値:
      ビュー状態の場合は true、それ以外の場合は false

    • addVariable

      public void addVariable(ViewVariable variable)
      ビュー変数を追加します。
      パラメーター:
      variable - 変数

    • addVariables

      public void addVariables(ViewVariable... variables)
      ビュー変数のセットを追加します。
      パラメーター:
      variables - 変数

    • getVariable

      public ViewVariable getVariable(StringSE name)
      指定された名前のビュー変数を返します。
      パラメーター:
      name - 変数の名前

    • getVariables

      public ViewVariable[] getVariables()
      設定されたビュー変数を返します。

    • getRedirect

      public boolean getRedirect()
      このビューステートに入ったときにフロー実行リダイレクトをリクエストするかどうかを返します。

    • setRedirect

      public void setRedirect(BooleanSE redirect)
      このビューステートに入ったときにフロー実行リダイレクトをリクエストするかどうかを設定します。
      パラメーター:
      redirect - リダイレクトフラグ

    • getPopup

      public boolean getPopup()
      このビューステートをポップアップとしてレンダリングするかどうかを返します。

    • setPopup

      public void setPopup(boolean popup)
      このビューステートをポップアップとしてレンダリングするかどうかを設定します。
      パラメーター:
      popup - ポップアップフラグ

    • getViewFactory

      public ViewFactory getViewFactory()
      ビューファクトリを返します。

    • getRenderActionList

      public ActionList getRenderActionList()
      エントリ時およびリフレッシュ時にこのビューステートによって実行可能なアクションのリストを返します。返されるリストは変更可能です。
      戻り値:
      状態の行動リスト

    • doPreEntryActions

      protected void doPreEntryActions(RequestControlContext context) throws FlowExecutionException
      クラスからコピーされた説明: State
      状態に入るときに状態に入るアクションを実行する前に実行するフックメソッド。デフォルトでは何もしません。サブクラスでオーバーライドできます。
      オーバーライド:
      クラス State の doPreEntryActions 
      パラメーター:
      context - リクエスト制御コンテキスト
      例外:
      FlowExecutionException - 例外が発生した場合

    • doEnter

      protected void doEnter(RequestControlContext context) throws FlowExecutionException
      クラスからコピーされた説明: State
      この状態に入った結果としてカスタム動作を実行するためのフックメソッド。このメソッドを実装することにより、サブクラスは状態の動作を特化します。
      次で指定:
      クラス State の doEnter 
      パラメーター:
      context - 現在実行中のフローの制御コンテキスト。この状態によってフロー実行を操作するために使用されます
      例外:
      FlowExecutionException - この状態で例外が発生した場合

    • resume

      public void resume(RequestControlContext context)

    • exit

      public void exit(RequestControlContext context)
      クラスからコピーされた説明: TransitionableState
      この状態を終了します。これは通常、遷移によってフローがこの状態から別の状態に移行するときに呼び出されます。デフォルトでは、登録されている終了アクションを実行するだけです。
      オーバーライド:
      クラス TransitionableState の exit 
      パラメーター:
      context - フロー制御コンテキスト

    • appendToString

      protected void appendToString(org.springframework.core.style.ToStringCreator creator)
      クラスからコピーされた説明: State
      サブクラスはこのフックメソッドをオーバーライドして、内部状態を文字列に出力できます。このデフォルトの実装では何も行われません。
      オーバーライド:
      クラス TransitionableState の appendToString 
      パラメーター:
      creator - toString クリエーターは、プロパティを文字列に出力します
      関連事項: