Package org.springframework.faces.webflow

Class JsfView

java.lang.Object
org.springframework.faces.webflow.JsfView
All Implemented Interfaces:
View
public class JsfView extends Object implements View
JSF-specific View implementation.
Author:
Jeremy Grelle, Phillip Webb

  • Field Details

  • Constructor Details

    • JsfView

      public JsfView(jakarta.faces.component.UIViewRoot viewRoot, jakarta.faces.lifecycle.Lifecycle facesLifecycle, RequestContext context)
      Creates a new JSF view.
      Parameters:
      viewRoot - the view root
      facesLifecycle - the flow faces lifecycle
      context - the current flow request

  • Method Details

    • getViewRoot

      public jakarta.faces.component.UIViewRoot getViewRoot()
      Returns the underlying view root.
      Returns:
      the view root

    • setViewRoot

      public void setViewRoot(jakarta.faces.component.UIViewRoot viewRoot)

    • render

      public void render() throws IOException
      Performs the standard duties of the JSF RENDER_RESPONSE phase.
      Specified by:
      render in interface View
      Throws:
      IOException - if an IO Exception occured rendering the view

    • userEventQueued

      public boolean userEventQueued()
      Description copied from interface: View
      True if there is a user event queued this view should process.
      Specified by:
      userEventQueued in interface View
      Returns:
      true if a user event is queued, false if not

    • processUserEvent

      public void processUserEvent()
      Executes postback-processing portions of the standard JSF lifecycle including APPLY_REQUEST_VALUES through INVOKE_APPLICATION.
      Specified by:
      processUserEvent in interface View
      See Also:

    • saveState

      public void saveState()
      Updates the component state stored in View scope so that it remains in sync with the updated flow execution snapshot
      Specified by:
      saveState in interface View

    • getUserEventState

      public Serializable getUserEventState()
      Description copied from interface: View
      A memento holding the results of processing a user event. Used to allow transient view state such as binding and validation errors to survive a flow execution redirect.
      Specified by:
      getUserEventState in interface View
      Returns:
      the serializable user event state object, or null if no event state needs managing
      See Also:

    • hasFlowEvent

      public boolean hasFlowEvent()
      Description copied from interface: View
      True if a call to View.processUserEvent() raised a flow event the current state should handle. Call View.getFlowEvent() to access the Event.
      Specified by:
      hasFlowEvent in interface View
      Returns:
      true if yes, false otherwise

    • getFlowEvent

      public Event getFlowEvent()
      Description copied from interface: View
      Get the flow event the current state should handle. Returns an Event object when View.hasFlowEvent() returns true. Returns null otherwise.
      Specified by:
      getFlowEvent in interface View
      Returns:
      the event, or null if there is no event for the flow system to handle

    • toString

      public String toString()
      Overrides:
      toString in class Object