org.apache.myfaces.view.facelets
Class FaceletFactory

java.lang.Object
  extended by org.apache.myfaces.view.facelets.FaceletFactory
Direct Known Subclasses:
DefaultFaceletFactory

public abstract class FaceletFactory
extends Object

FaceletFactory for producing Facelets relative to the context of the underlying implementation.

Version:
$Id: FaceletFactory.java 1187700 2011-10-22 12:19:37Z bommel $
Author:
Jacob Hookom

Constructor Summary
FaceletFactory()
           
 
Method Summary
abstract  Facelet getCompositeComponentMetadataFacelet(String uri)
          Return a Facelet instance as specified by the file at the passed URI.
abstract  Facelet getCompositeComponentMetadataFacelet(URL url)
          Create a Facelet used to create composite component metadata from the passed URL.
abstract  Facelet getFacelet(String uri)
          Return a Facelet instance as specified by the file at the passed URI.
abstract  Facelet getFacelet(URL url)
          Create a Facelet from the passed URL.
static FaceletFactory getInstance()
          Get the static instance
abstract  Facelet getViewMetadataFacelet(String uri)
          Return a Facelet instance as specified by the file at the passed URI.
abstract  Facelet getViewMetadataFacelet(URL url)
          Create a Facelet used to create view metadata from the passed URL.
static void setInstance(FaceletFactory factory)
          Set the static instance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FaceletFactory

public FaceletFactory()
Method Detail

getFacelet

public abstract Facelet getFacelet(String uri)
                            throws IOException
Return a Facelet instance as specified by the file at the passed URI.

Parameters:
uri -
Returns:
Throws:
IOException
FaceletException
FacesException
javax.el.ELException

getFacelet

public abstract Facelet getFacelet(URL url)
                            throws IOException,
                                   FaceletException,
                                   FacesException,
                                   javax.el.ELException
Create a Facelet from the passed URL. This method checks if the cached Facelet needs to be refreshed before returning. If so, uses the passed URL to build a new instance;

Parameters:
url - source url
Returns:
Facelet instance
Throws:
IOException
FaceletException
FacesException
javax.el.ELException

getViewMetadataFacelet

public abstract Facelet getViewMetadataFacelet(String uri)
                                        throws IOException
Return a Facelet instance as specified by the file at the passed URI. The returned facelet is used to create view metadata in this form:

UIViewRoot(in facet javax_faces_metadata(one or many UIViewParameter instances))

This method should be called from FaceletViewMetadata.createMetadataView(FacesContext context)

Parameters:
uri -
Returns:
Throws:
IOException
Since:
2.0

getViewMetadataFacelet

public abstract Facelet getViewMetadataFacelet(URL url)
                                        throws IOException,
                                               FaceletException,
                                               FacesException,
                                               javax.el.ELException
Create a Facelet used to create view metadata from the passed URL. This method checks if the cached Facelet needs to be refreshed before returning. If so, uses the passed URL to build a new instance;

Parameters:
url - source url
Returns:
Facelet instance
Throws:
IOException
FaceletException
FacesException
javax.el.ELException
Since:
2.0

getCompositeComponentMetadataFacelet

public abstract Facelet getCompositeComponentMetadataFacelet(String uri)
                                                      throws IOException
Return a Facelet instance as specified by the file at the passed URI. The returned facelet is used to create composite component metadata.

This method should be called from vdl.getComponentMetadata(FacesContext context)

Parameters:
uri -
Returns:
Throws:
IOException
Since:
2.0.1

getCompositeComponentMetadataFacelet

public abstract Facelet getCompositeComponentMetadataFacelet(URL url)
                                                      throws IOException,
                                                             FaceletException,
                                                             FacesException,
                                                             javax.el.ELException
Create a Facelet used to create composite component metadata from the passed URL. This method checks if the cached Facelet needs to be refreshed before returning. If so, uses the passed URL to build a new instance.

Parameters:
url - source url
Returns:
Facelet instance
Throws:
IOException
FaceletException
FacesException
javax.el.ELException
Since:
2.0.1

setInstance

public static final void setInstance(FaceletFactory factory)
Set the static instance

Parameters:
factory -

getInstance

public static final FaceletFactory getInstance()
Get the static instance

Returns:


Copyright © 2014 The Apache Software Foundation. All Rights Reserved.