Jakarta EE 11.0.0 · com.sun.faces.application.view.FaceletViewHandlingStrategy

Modifier and Type	Class and Description
private static class	FaceletViewHandlingStrategy.CompCompInterfaceMethodMetadata Utility class to encapsulate the ValueExpression evaluation of the various MethodExpression composite component properties.
private static class	FaceletViewHandlingStrategy.MethodMetadataIterator Provides iteration services over a composite component's MethodExpression-enabled `PropertyDescriptors`.
private static interface	FaceletViewHandlingStrategy.MethodRetargetHandler Implementations of this interface provide the `strategy` to properly retarget a method expression for a particular attribute.
private static class	FaceletViewHandlingStrategy.MethodRetargetHandlerManager Managed the `MethodRetargetHandler` implementations for the current `MethodExpression` enabled component attributes: action actionListener validator valueChangeListener
protected static class	FaceletViewHandlingStrategy.NullWriter Simple no-op writer.

Modifier and Type	Field and Description
private Map<String, List<String>>	contractMappings
private String[]	extensionsArray
private DefaultFaceletFactory	faceletFactory
public static final String	IS_BUILDING_METADATA
private static final Logger	LOGGER
private Cache<Resource, BeanInfo>	metadataCache
private String[]	prefixesArray
public static final String	RESOURCE_LIBRARY_CONTRACT_DATA_STRUCTURE_KEY
private int	responseBufferSize
private final FaceletViewHandlingStrategy.MethodRetargetHandlerManager	retargetHandlerManager
private ViewDeclarationLanguageFactory	vdlFactory

Access	Constructor and Description
public	FaceletViewHandlingStrategy()

Method Summary

Modifier and Type	Method and Description
public void	buildView(FacesContext the `FacesContext` for this request ctx, UIViewRoot the `UIViewRoot` to populate with children using techniques specific to this VDL implementation. view) Implements abstract jakarta.faces.view.ViewDeclarationLanguage.buildView. Take any actions specific to this VDL implementation to cause the argument `UIViewRoot` which must have been created via a call to `createView`, to be populated with children.
public List<String>	calculateResourceLibraryContracts(FacesContext the `FacesContext` for this request context, String the view id for which the applicable resource library contracts should be calculated. viewId) Overrides jakarta.faces.view.ViewDeclarationLanguage.calculateResourceLibraryContracts. Return the list of resource library contracts that will be made available for use in the view specified by the argument `viewId`.
public UIComponent	createComponent(FacesContext the `FacesContext` for this request context, String the fully qualified tag library URI that contains the component taglibURI, String the name of the tag within that library that exposes the component tagName, Map<String, Object> any name=value pairs that would otherwise have been given on the markup that would cause the creation of this component or `null` if no attributes need be given. attributes) Overrides jakarta.faces.view.ViewDeclarationLanguage.createComponent. Create a component given a `ViewDeclarationLanguage` specific tag library URI and tag name.
private BeanInfo	createComponentMetadata(FacesContext context, Resource ccResource)
protected ResponseWriter	Returns: a `ResponseWriter` for processing the request createResponseWriter(FacesContext the `FacesContext` for the current request context)
public UIViewRoot	createView(FacesContext the `FacesContext` for this request. ctx, String the identifier of an artifact that contains the VDL syntax that describes this view. viewId) Overrides com.sun.faces.application.view.ViewHandlingStrategy.createView. Create a `UIViewRoot` from the VDL contained in the artifact referenced by the argument `viewId`.
public BeanInfo	getComponentMetadata(FacesContext The `FacesContext` for this request. context, Resource The `Resource` that represents the component. ccResource) Implements abstract jakarta.faces.view.ViewDeclarationLanguage.getComponentMetadata. Called by Application._createComponent(Resource).
private String	getCompositeComponentName(UIComponent compositeComponent)
private String	getConfiguredPrefix(String viewId)
private String	getConfiguredSuffix(String viewId)
private DefaultFaceletFactory	Returns: the default faceletFactorys getFaceletFactory() Gets and if needed initializes the faceletFactory
public String	getId() Overrides jakarta.faces.view.ViewDeclarationLanguage.getId. Returns a non-null String that can be used to identify this view declaration language.
private String	getMatchedWithFaceletsSuffix(String viewId)
protected String	Returns: the content type to be used for this response getResponseContentType(FacesContext the `FacesContext` for the current request context, String the original contentType orig)
public Resource	getScriptComponentResource(FacesContext The `FacesContext` for this request. context, Resource The `Resource` that represents the component. componentResource) Implements abstract jakarta.faces.view.ViewDeclarationLanguage.getScriptComponentResource. Take implementation specific action to discover a `Resource` given the argument `componentResource`.
private HttpSession	Returns: the session, or null if we are not using server state saving. getSession(FacesContext the Faces context. context) Get a session (if we are using server state saving).
public StateManagementStrategy	getStateManagementStrategy(FacesContext the `FacesContext` for the current request. context, String the view id. viewId) Implements abstract jakarta.faces.view.ViewDeclarationLanguage.getStateManagementStrategy. For implementations that want to control the implementation of state saving and restoring, the `StateManagementStrategy` allows them to do so.
public ViewMetadata	getViewMetadata(FacesContext The `FacesContext` for this request. context, String the view id from which to extract the metadata viewId) Implements abstract jakarta.faces.view.ViewDeclarationLanguage.getViewMetadata. Return a reference to the view metadata for the view represented by the argument `viewId`, or `null` if the metadata cannot be found.
public Stream<String>	getViews(FacesContext The `FacesContext` for this request. context, String The initial path from which to start looking for views path, ViewVisitOption... The options to influence the traversal. See `ViewVisitOption` for details on those. options) Overrides jakarta.faces.view.ViewDeclarationLanguage.getViews. Return a `Stream` possibly lazily populated by walking the view tree rooted at a given initial path.
public Stream<String>	getViews(FacesContext The `FacesContext` for this request. context, String The initial path from which to start looking for views path, int The absolute maximum depth of nested directories to visit counted from the root (`/`). maxDepth, ViewVisitOption... The options to influence the traversal. See `ViewVisitOption` for details on those. options) Overrides jakarta.faces.view.ViewDeclarationLanguage.getViews. Return a `Stream` possibly lazily populated by walking the view tree rooted at a given initial path.
protected void	handleFaceletNotFound(FacesContext the `FacesContext` for the current request context, String the view ID that was to be mapped to a Facelet viewId, String optional message to include in the 404 message) Handles the case where a Facelet cannot be found.
protected void	handleRenderException(FacesContext the `FacesContext` for the current request context, Exception the caught Exception e) Handles the case where rendering throws an Exception.
private boolean	handlesByPrefixOrSuffix(String viewId)
public boolean	Returns: `true` if assuming a default configuration and the view ID's extension in `ViewHandler#FACELETS_SUFFIX_PARAM_NAME` Otherwise try to match the view ID based on the configured extensions and prefixes in `ViewHandler#FACELETS_VIEW_MAPPINGS_PARAM_NAME` handlesViewId(String the view ID to check viewId) Implements abstract com.sun.faces.application.view.ViewHandlingStrategy.handlesViewId.
protected void	initialize() Initialize the core Facelets runtime.
protected void	initializeMappings() Initialize mappings, during the first request.
public static boolean	isBuildingMetadata(FacesContext context)
private boolean	isMatchedWithFaceletsSuffix(String viewId)
private boolean	Returns: true if we are, false otherwise. isServerStateSaving() Are we saving state server side?
private boolean	isStateless(FacesContext context, String viewId)
private UIComponent	locateComponentByClientId(final FacesContext the Faces context. context, final UIComponent parent, final String the client id of the component to find. clientId, final boolean dynamic) Find the given component in the component tree.
private Stream<String>	Returns: The stream with views, possibly mapped if needed mapIfNeeded(Stream<String> The stream of views to potentially map views, ViewVisitOption... Options telling if and if so how to map options) Maps the element in the passed in stream of views according to the given options.
private void	markInitialState(FacesContext ctx, UIViewRoot root)
private void	markInitialState(final UIComponent component)
private void	markInitialStateIfNotMarked(UIComponent component) Mark the initial state if not already marked.
private void	reapplyDynamicActions(FacesContext the Faces context. context) Reapply the dynamic actions after Facelets reapply.
private void	reapplyDynamicAdd(FacesContext the Faces context. context, ComponentStruct the component struct. struct) Reapply the dynamic add after Facelets reapply.
private void	reapplyDynamicRemove(FacesContext the Faces context. context, ComponentStruct the component struct. struct) Reapply the dynamic remove after Facelets reapply.
public void	renderView(FacesContext the `FacesContext` for this request. ctx, UIViewRoot the `UIViewRoot` from an early call to `createView` or `restoreView`. viewToRender) Implements abstract jakarta.faces.view.ViewDeclarationLanguage.renderView. Render a view rooted at argument`view`.
public UIViewRoot	restoreView(FacesContext the `FacesContext` for this request. context, String the identifier for a previously rendered view. viewId) Overrides com.sun.faces.application.view.ViewHandlingStrategy.restoreView. If `UIDebug#debugRequest(jakarta.faces.context.FacesContext)`} is `true`, simply return a new UIViewRoot(), otherwise, call the default logic.
public void	retargetAttachedObjects(FacesContext the FacesContext for this request. context, UIComponent The UIComponent in the view to which the attached objects must be attached. This UIComponent must have its component metadata already associated and available from via the JavaBeans API. topLevelComponent, List<AttachedObjectHandler> the tag handlers for the attached objects handlers) Overrides jakarta.faces.view.ViewDeclarationLanguage.retargetAttachedObjects. Assuming the component metadata for argument `topLevelComponent` has been made available by an earlier call to `ViewDeclarationLanguage#getComponentMetadata`, leverage the component metadata for the purpose of re-targeting attached objects from the top level composite component to the individual `AttachedObjectTarget` instances inside the composite component.
private void	retargetHandler(FacesContext context, AttachedObjectHandler handler, UIComponent targetComponent)
public void	retargetMethodExpressions(FacesContext the FacesContext for this request. context, UIComponent The UIComponent in the view to which the attached objects must be attached. This UIComponent must have its component metadata already associated and available from via the JavaBeans API. topLevelComponent) Overrides jakarta.faces.view.ViewDeclarationLanguage.retargetMethodExpressions. Assuming the component metadata for argument `topLevelComponent` has been made available by an earlier call to `ViewDeclarationLanguage#getComponentMetadata`, leverage the component metadata for the purpose of re-targeting any method expressions from the top level component to the appropriate inner component.
private boolean	returnAsImplicitOutCome(ViewVisitOption... options)
private void	setResourceLibraryContracts(FacesContext ctx, String viewId)
private void	startTrackViewModifications(FacesContext ctx, UIViewRoot root)
private String	toImplicitOutcome(String viewId)
public boolean	viewExists(FacesContext The `FacesContext` for this request. context, String the view id to test viewId) Overrides jakarta.faces.view.ViewDeclarationLanguage.viewExists. Tests whether a physical resource corresponding to the specified viewId exists.

public Class FaceletViewHandlingStrategy

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary