Package jakarta.faces.view

Class ViewDeclarationLanguage

java.lang.Object

jakarta.faces.view.ViewDeclarationLanguage

Direct Known Subclasses:

ViewDeclarationLanguageWrapper

public abstract class ViewDeclarationLanguage
extends Object

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	FACELETS_VIEW_DECLARATION_LANGUAGE_ID

Constructor Summary

Constructors

Constructor	Description
ViewDeclarationLanguage()

Method Summary

Modifier and Type	Method	Description
abstract void	buildView(FacesContext context, UIViewRoot view)
List<String>	calculateResourceLibraryContracts(FacesContext context, String viewId)
UIComponent	createComponent(FacesContext context, String taglibURI, String tagName, Map<String,Object> attributes)
abstract UIViewRoot	createView(FacesContext context, String viewId)
abstract BeanInfo	getComponentMetadata(FacesContext context, Resource componentResource)
String	getId()
abstract Resource	getScriptComponentResource(FacesContext context, Resource componentResource)
abstract StateManagementStrategy	getStateManagementStrategy(FacesContext context, String viewId)
abstract ViewMetadata	getViewMetadata(FacesContext context, String viewId)
Stream<String>	getViews(FacesContext facesContext, String path, int maxDepth, ViewVisitOption... options)
Stream<String>	getViews(FacesContext facesContext, String path, ViewVisitOption... options)
abstract void	renderView(FacesContext context, UIViewRoot view)
abstract UIViewRoot	restoreView(FacesContext context, String viewId)
void	retargetAttachedObjects(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers)
void	retargetMethodExpressions(FacesContext context, UIComponent topLevelComponent)
boolean	viewExists(FacesContext facesContext, String viewId)

Methods inherited from class java.lang.Object

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

Field Detail

FACELETS_VIEW_DECLARATION_LANGUAGE_ID

public static final String FACELETS_VIEW_DECLARATION_LANGUAGE_ID

Since:

2.1

See Also:

Constant Field Values

Constructor Detail

ViewDeclarationLanguage

public ViewDeclarationLanguage()

Method Detail

buildView

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

Throws:

IOException

createView

public abstract UIViewRoot createView(FacesContext context,
                                      String viewId)

getComponentMetadata

public abstract BeanInfo getComponentMetadata(FacesContext context,
                                              Resource componentResource)

getScriptComponentResource

public abstract Resource getScriptComponentResource(FacesContext context,
                                                    Resource componentResource)

getStateManagementStrategy

public abstract StateManagementStrategy getStateManagementStrategy(FacesContext context,
                                                                   String viewId)

getViewMetadata

public abstract ViewMetadata getViewMetadata(FacesContext context,
                                             String viewId)

renderView

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

Throws:

IOException

restoreView

public abstract UIViewRoot restoreView(FacesContext context,
                                       String viewId)

retargetAttachedObjects

public void retargetAttachedObjects(FacesContext context,
                                    UIComponent topLevelComponent,
                                    List<AttachedObjectHandler> handlers)

retargetMethodExpressions

public void retargetMethodExpressions(FacesContext context,
                                      UIComponent topLevelComponent)

getId

public String getId()

Returns:

Since:

2.1

viewExists

public boolean viewExists(FacesContext facesContext,
                          String viewId)

Parameters:

facesContext -

viewId -

Returns:

Since:

2.1

createComponent

public UIComponent createComponent(FacesContext context,
                                   String taglibURI,
                                   String tagName,
                                   Map<String,Object> attributes)

Parameters:

context -

taglibURI -

tagName -

attributes -

Returns:

Since:

2.2

calculateResourceLibraryContracts

public List<String> calculateResourceLibraryContracts(FacesContext context,
                                                      String viewId)

Parameters:

context -

viewId -

Returns:

Since:

2.2

getViews

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

Parameters:

facesContext -

path -

options -

Returns:

Since:

2.3

getViews

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

Parameters:

facesContext -

path -

maxDepth -

options -

Returns:

Since:

2.3