public abstract class PageTemplateModel extends Object
If the value attribute of the <af:pageTemplate /> is given, and is an instance of this class, the view ID will be retrieved from this class and it will be notified of setup and tear down changes of the template context.
Constructor and Description |
---|
PageTemplateModel() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getViewId(javax.faces.context.FacesContext facesContext)
Retrieve the view ID of the page template.
|
void |
setupContext(javax.faces.context.FacesContext facesContext, PageTemplateSite templateSite)
Perform any contextual setup of the page template when the page template is processing its content.
|
void |
tearDownContext(javax.faces.context.FacesContext facesContext, PageTemplateSite templateSite)
Perform any contextual tear down of the page template when the page template is leaving its content.
|
public void setupContext(javax.faces.context.FacesContext facesContext, PageTemplateSite templateSite)
This is called before each JSF phase method begins on the component and after any invokeOnComponent
call.
facesContext
- the faces contexttemplateSite
- provides access to site-specific information and services. The site object is only valid between setupContext and tearDownContextpublic void tearDownContext(javax.faces.context.FacesContext facesContext, PageTemplateSite templateSite)
This is called after each JSF phase method ends on the component and before any invokeOnComponent
call.
facesContext
- the faces contexttemplateSite
- provides access to site-specific information and services. The site object is only valid between setupContext and tearDownContext. The value passed is the same instance that was passed to the setupContext(javax.faces.context.FacesContext, oracle.adf.view.rich.component.fragment.PageTemplateSite)
methodpublic abstract String getViewId(javax.faces.context.FacesContext facesContext)
This is called by the JSP tag or include handler of the page template to retrieve the view ID to be used to include. It may be called at other times but only for informational purposes.
This value should only be changed during the invoke application phase or before the rendering phase. It should return the same value during rendering as during restoring of the view during subsequent requests.
facesContext
- the faces context