Package org.apache.myfaces.view.facelets

Public Facelet API.

See: Description

Interface Summary

Interface	Description
PassthroughRule
TemplateClient	FaceletHandlers can implement this contract and push themselves into the FaceletContext for participating in templating.

Class Summary

Class	Description
AbstractFacelet
AbstractFaceletCache<V>	Extended FaceletCache contract that supports additional Myfaces specific concepts that are necessary to implement.
AbstractFaceletContext	This class contains methods that belongs to original FaceletContext shipped in facelets code before 2.0, but does not take part from api, so are considered implementation details.
AttachedFullStateWrapper
DefaultFaceletsStateManagementStrategy	This class implements partial state saving feature when facelets is used to render pages.
DefaultFaceletsStateManagementStrategy.AddComponentCallback
DefaultFaceletsStateManagementStrategy.PostAddPreRemoveFromViewListener
DefaultFaceletsStateManagementStrategy.RemoveComponentCallback
DefaultFaceletsStateManagementStrategy.TreeStructComponent
DynamicComponentRefreshTransientBuildEvent
FaceletCompositionContext
FaceletDynamicComponentRefreshTransientBuildEvent
FaceletFactory	FaceletFactory for producing Facelets relative to the context of the underlying implementation.
FaceletsVDLUtils
FaceletsVDLUtils.KeyComparator
FaceletsVDLUtils.NullWriter
FaceletViewDeclarationLanguage	This class represents the abstraction of Facelets as a ViewDeclarationLanguage.
FaceletViewDeclarationLanguageBase
FaceletViewDeclarationLanguageStrategy
PageContext	This class is used to encapsulate the information required at page scope.
PostBuildComponentTreeOnRestoreViewEvent	TODO: Remove it since after MYFACES-2389 this is not necessary anymore.
PublishDynamicComponentRefreshTransientBuildCallback
StateWriter	A class for handling state insertion.
TemplateContext	This class is used to encapsulate the information required to resolve facelets templates.
TemplateManager
ViewPoolProcessor	This class is reponsible for all processing tasks related to the view pool.

Enum Summary

Enum	Description
ComponentState	Enum used inside the key DefaultFaceletsStateManagementStrategy.COMPONENT_ADDED_AFTER_BUILD_VIEW on the component attribute map to indicate if the component should be add, removed and add o it was already added to DefaultFaceletsStateManagementStrategy.CLIENTIDS_ADDED and DefaultFaceletsStateManagementStrategy.CLIENTIDS_REMOVED
ELExpressionCacheMode

Package org.apache.myfaces.view.facelets Description

Public Facelet API. Most developers should be able to utilizing the framework using the public classes and interfaces.

An application that wishes to use Facelets as a ViewHandler, they must specify the following in their faces-config.xml (@see com.sun.facelets.FaceletViewHandler).

<application>
  <view-handler>com.sun.facelets.FaceletViewHandler</view-handler>
</application>

Below is sample code for using Facelets at the API level with JavaServer Faces.

// get the view to render
FacesContext context = FacesContext.getCurrentInstance();
UIViewRoot viewToRender = context.getViewRoot();

// grab our FaceletFactory and create a Facelet
FaceletFactory factory = FaceletFactory.getInstance();
Facelet f = factory.getFacelet(viewToRender.getViewId());

// populate UIViewRoot
f.apply(context, viewToRender);