org.apache.myfaces.view.facelets
Class AbstractFacelet

java.lang.Object
  org.apache.myfaces.view.facelets.Facelet
      org.apache.myfaces.view.facelets.AbstractFacelet

public abstract class AbstractFacelet
extends Facelet

Since:

2.0.1

Version:

$Revision: 1301672 $ $Date: 2012-03-16 13:00:42 -0500 (Fri, 16 Mar 2012) $

Author:

Leonardo Uribe (latest modification by $Author: lu4242 $)

Constructor Summary

AbstractFacelet()

Method Summary

abstract void	applyCompositeComponent(AbstractFaceletContext ctx, UIComponent parent, Resource resource)
abstract String	getAlias() Return the alias name for error messages and logging
abstract javax.el.ExpressionFactory	getExpressionFactory() Return this Facelet's ExpressionFactory instance
String	getFaceletId() Return an identifier used to derive an unique id per facelet instance.
abstract void	include(AbstractFaceletContext ctx, UIComponent parent, String path) Used for delegation by the DefaultFaceletContext.
abstract void	include(AbstractFaceletContext ctx, UIComponent parent, URL url) Grabs a DefaultFacelet from referenced DefaultFaceletFacotry
abstract boolean	isBuildingCompositeComponentMetadata()

Methods inherited from class org.apache.myfaces.view.facelets.Facelet

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFacelet

public AbstractFacelet()

Method Detail

getExpressionFactory

public abstract javax.el.ExpressionFactory getExpressionFactory()

Return this Facelet's ExpressionFactory instance

Returns:

internal ExpressionFactory instance

include

public abstract void include(AbstractFaceletContext ctx,
                             UIComponent parent,
                             String path)
                      throws IOException,
                             FacesException,
                             FaceletException,
                             javax.el.ELException

Used for delegation by the DefaultFaceletContext.

Parameters:

ctx - FaceletContext to pass to the included Facelet

parent - UIComponent to apply changes to

path - relative path to the desired Facelet from the FaceletContext

Throws:

IOException

FacesException

FaceletException

javax.el.ELException

See Also:

FaceletContext.includeFacelet(UIComponent, String)

include

public abstract void include(AbstractFaceletContext ctx,
                             UIComponent parent,
                             URL url)
                      throws IOException,
                             FacesException,
                             FaceletException,
                             javax.el.ELException

Grabs a DefaultFacelet from referenced DefaultFaceletFacotry

Parameters:

ctx - FaceletContext to pass to the included Facelet

parent - UIComponent to apply changes to

url - URL source to include Facelet from

Throws:

IOException

FacesException

FaceletException

javax.el.ELException

See Also:

DefaultFaceletFactory.getFacelet(URL)

getAlias

public abstract String getAlias()

Return the alias name for error messages and logging

Returns:

alias name

applyCompositeComponent

public abstract void applyCompositeComponent(AbstractFaceletContext ctx,
                                             UIComponent parent,
                                             Resource resource)
                                      throws IOException,
                                             FacesException,
                                             FaceletException,
                                             javax.el.ELException

Throws:

IOException

FacesException

FaceletException

javax.el.ELException

isBuildingCompositeComponentMetadata

public abstract boolean isBuildingCompositeComponentMetadata()

getFaceletId

public String getFaceletId()

Return an identifier used to derive an unique id per facelet instance. This value should be the same for viewMetadata and normal facelet instances.

Returns: