Package com.sun.faces.application.view

Class JspViewHandlingStrategy

java.lang.Object

jakarta.faces.view.ViewDeclarationLanguage

com.sun.faces.application.view.ViewHandlingStrategy

com.sun.faces.application.view.JspViewHandlingStrategy

public class JspViewHandlingStrategy
extends ViewHandlingStrategy

This ViewHandlingStrategy handles JSP-based views.

Field Summary

Fields inherited from class com.sun.faces.application.view.ViewHandlingStrategy

associate, webConfig

Fields inherited from class jakarta.faces.view.ViewDeclarationLanguage

FACELETS_VIEW_DECLARATION_LANGUAGE_ID, JSP_VIEW_DECLARATION_LANGUAGE_ID

Constructor Summary

Constructors

Constructor	Description
JspViewHandlingStrategy()

Method Summary

Modifier and Type	Method	Description
void	buildView(FacesContext context, UIViewRoot view)	Take any actions specific to this VDL implementation to cause the argument UIViewRoot which must have been created via a call to ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String), to be populated with children.
BeanInfo	getComponentMetadata(FacesContext context, Resource componentResource)	Not supported in JSP-based views.
String	getId()	Returns a non-null String that can be used to identify this view declaration language.
Resource	getScriptComponentResource(FacesContext context, Resource componentResource)	Not supported in JSP-based views.
StateManagementStrategy	getStateManagementStrategy(FacesContext context, String viewId)	For implementations that want to control the implementation of state saving and restoring, the StateManagementStrategy allows them to do so.
ViewMetadata	getViewMetadata(FacesContext context, String viewId)	Not supported in JSP-based views.
Stream<String>	getViews(FacesContext context, String path, int maxDepth, ViewVisitOption... options)	Not supported in JSP-based views.
Stream<String>	getViews(FacesContext context, String path, ViewVisitOption... options)	Not supported in JSP-based views.
boolean	handlesViewId(String viewId)	This ViewHandlingStrategy should be the last one queried and as such we return true.
void	renderView(FacesContext context, UIViewRoot view)	Render a view rooted at argumentview.

Methods inherited from class com.sun.faces.application.view.ViewHandlingStrategy

createView, restoreView

Methods inherited from class jakarta.faces.view.ViewDeclarationLanguage

calculateResourceLibraryContracts, createComponent, retargetAttachedObjects, retargetMethodExpressions, viewExists

Methods inherited from class java.lang.Object

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

Constructor Details

JspViewHandlingStrategy

public JspViewHandlingStrategy()

Method Details

getViewMetadata

public ViewMetadata getViewMetadata(FacesContext context, String viewId)

Not supported in JSP-based views.

Specified by:

getViewMetadata in class ViewDeclarationLanguage

Parameters:

context - The FacesContext for this request.

viewId - the view id from which to extract the metadata

Returns:

the view metadata

See Also:

ViewDeclarationLanguage.getViewMetadata(jakarta.faces.context.FacesContext, String)

buildView

public void buildView(FacesContext context, UIViewRoot view) throws IOException

Description copied from class: ViewDeclarationLanguage

Take any actions specific to this VDL implementation to cause the argument UIViewRoot which must have been created via a call to ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String), to be populated with children.

The Facelets implementation must insure that markup comprising the view must be executed, with the UIComponent instances in the view being encountered in the same depth-first order as in other lifecycle methods defined on UIComponent, and added to the view (but not rendered) during the traversal. The runtime must guarantee that the view must be fully populated before any of the following happen.

• The PhaseListener.afterPhase(jakarta.faces.event.PhaseEvent) method of any PhaseListeners attached to the application is called

• The UIViewRoot phase listener installed via UIViewRoot.setAfterPhaseListener(jakarta.el.MethodExpression) or UIViewRoot.addPhaseListener(jakarta.faces.event.PhaseListener) are called.

If the root is already populated with children, the view must still be re-built, but care must be taken to ensure that the existing components are correctly paired up with their VDL counterparts in the VDL page. Also, any system events that would normally be generated during the adding or removing of components from the view must be temporarily disabled during the creation of the view and then re-enabled when the view has been built.

Specified by:

buildView in class ViewDeclarationLanguage

Parameters:

context -

view -

Throws:

IOException

See Also:

ViewDeclarationLanguage.buildView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)

renderView

public void renderView(FacesContext context, UIViewRoot view) throws IOException

Description copied from class: ViewDeclarationLanguage

Render a view rooted at argumentview. See section JSF.7.7.2 for the specification of the default implementation.

Specified by:

renderView in class ViewDeclarationLanguage

Parameters:

context - the FacesContext for this request.

view - the UIViewRoot from an early call to ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String) or ViewDeclarationLanguage.restoreView(jakarta.faces.context.FacesContext, java.lang.String).

Throws:

IOException - if the view cannot be rendered for any reason

See Also:

ViewDeclarationLanguage.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)

getStateManagementStrategy

public StateManagementStrategy getStateManagementStrategy(FacesContext context, String viewId)

Description copied from class: ViewDeclarationLanguage

For implementations that want to control the implementation of state saving and restoring, the StateManagementStrategy allows them to do so. Returning null indicates that the implementation wishes the runtime to handle the state saving and restoring. Implementations that provide the VDL for Facelets for Jakarta Server Faces 2.0 and later must return non-null from this method.

Specified by:

getStateManagementStrategy in class ViewDeclarationLanguage

Parameters:

context - the FacesContext for the current request.

viewId - the view id.

Returns:

the strategy as specified above

getComponentMetadata

public BeanInfo getComponentMetadata(FacesContext context, Resource componentResource)

Not supported in JSP-based views.

Specified by:

getComponentMetadata in class ViewDeclarationLanguage

Parameters:

context - The FacesContext for this request.

componentResource - The Resource that represents the component.

Returns:

the component metadata

See Also:

ViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource)

getScriptComponentResource

public Resource getScriptComponentResource(FacesContext context, Resource componentResource)

Not supported in JSP-based views.

Specified by:

getScriptComponentResource in class ViewDeclarationLanguage

Parameters:

context - The FacesContext for this request.

componentResource - The Resource that represents the component.

Returns:

the Resource corresponding to the argument componentResource

See Also:

ViewDeclarationLanguage.getScriptComponentResource(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource)

getViews

public Stream<String> getViews(FacesContext context, String path, ViewVisitOption... options)

Not supported in JSP-based views.

Overrides:

getViews in class ViewDeclarationLanguage

Parameters:

context - The FacesContext for this request.

path - The initial path from which to start looking for views

options - The options to influence the traversal. See ViewVisitOption for details on those.

Returns:

the Stream of view ids

See Also:

ViewDeclarationLanguage.getViews(FacesContext, String, ViewVisitOption...)

getViews

public Stream<String> getViews(FacesContext context, String path, int maxDepth, ViewVisitOption... options)

Not supported in JSP-based views.

Overrides:

getViews in class ViewDeclarationLanguage

Parameters:

context - The FacesContext for this request.

path - The initial path from which to start looking for views

maxDepth - The absolute maximum depth of nested directories to visit counted from the root (/).

options - The options to influence the traversal. See ViewVisitOption for details on those.

Returns:

the Stream of view ids

See Also:

ViewDeclarationLanguage.getViews(FacesContext, String, int, ViewVisitOption...)

handlesViewId

public boolean handlesViewId(String viewId)

This ViewHandlingStrategy should be the last one queried and as such we return true.

Specified by:

handlesViewId in class ViewHandlingStrategy

Parameters:

viewId - the view ID

Returns:

true if this ViewHandlingStrategy handles the the view type represented by viewId

See Also:

ViewHandlingStrategy.handlesViewId(String)

getId

public String getId()

Description copied from class: ViewDeclarationLanguage

Returns a non-null String that can be used to identify this view declaration language.

The default implementation returns the fully qualified class name of the view declaration language implementation. Subclasses may override to provide a more meaningful id.

Overrides:

getId in class ViewDeclarationLanguage

Returns:

the id of this view declaration language