|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.webapp.pdl.PageDeclarationLanguage
public abstract class PageDeclarationLanguage
The contract that a page declaration language must implement to interact with the JSF runtime. An implementation of this class must be thread-safe.
Instances of this class are application scoped and must be
obtained from the PageDeclarationLanguageFactory
.
Constructor Summary | |
---|---|
PageDeclarationLanguage()
|
Method Summary | |
---|---|
abstract UIViewRoot |
createView(FacesContext context,
String viewId)
Create a |
abstract BeanInfo |
getComponentMetadata(FacesContext context,
Resource componentResource)
Return a reference to the component
metadata for the composite component represented by the argument
|
abstract Resource |
getScriptComponentResource(FacesContext context,
Resource componentResource)
Take implementation specific action
to discover a |
abstract void |
renderView(FacesContext context,
UIViewRoot view)
Render a view rooted at
argument |
abstract UIViewRoot |
restoreView(FacesContext context,
String viewId)
Restore a |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageDeclarationLanguage()
Method Detail |
---|
public abstract BeanInfo getComponentMetadata(FacesContext context, Resource componentResource)
Return a reference to the component
metadata for the composite component represented by the argument
componentResource
, or null
if the
metadata cannot be found. See section 7.6.2 for the
specification of the default implementation.
context
- The FacesContext
for this request.componentResource
- The Resource
that represents the component.
NullPointerException
- if any of the arguments are
null
.
FacesException
- if there is an error in
obtaining the metadatapublic abstract Resource getScriptComponentResource(FacesContext context, Resource componentResource)
Take implementation specific action
to discover a Resource
given the argument
componentResource
. See section 7.6.2 for the
specification of the default implementation.
context
- The FacesContext
for this request.componentResource
- The Resource
that represents the component.
NullPointerException
- if any of the arguments are
null
.
FacesException
- if there is an error in
obtaining the script component resourcepublic abstract UIViewRoot createView(FacesContext context, String viewId)
Create a UIViewRoot
from the PDL contained in the artifact referenced by the argument
viewId
. See section 7.6.2 for the specification of
the default implementation.
context
- the FacesContext
for this request.viewId
- the identifier of an artifact that contains the PDL
syntax that describes this view.
NullPointerException
- if any of the arguments are
null
public abstract UIViewRoot restoreView(FacesContext context, String viewId)
Restore a UIViewRoot
from a previously created view. See section 7.6.2 for the
specification of the default implementation.
context
- the FacesContext
for this request.viewId
- the identifier for a previously rendered view.
NullPointerException
- if any of the arguments are
null
public abstract void renderView(FacesContext context, UIViewRoot view) throws IOException
Render a view rooted at
argumentview
. See section 7.6.2 for the
specification of the default implementation.
context
- the FacesContext
for this request.view
- the UIViewRoot
from an early call to
createView(javax.faces.context.FacesContext, java.lang.String)
or restoreView(javax.faces.context.FacesContext, java.lang.String)
.
NullPointerException
- if any of the arguments are
null
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |