org.apache.myfaces.view.facelets.impl
Class FaceletCompositionContextImpl

java.lang.Object
  org.apache.myfaces.view.facelets.FaceletCompositionContext
      org.apache.myfaces.view.facelets.impl.FaceletCompositionContextImpl

public class FaceletCompositionContextImpl
extends FaceletCompositionContext

Since:

2.0.1

Version:

$Revision: 1526200 $ $Date: 2013-09-25 10:02:21 -0500 (Wed, 25 Sep 2013) $

Author:

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

Field Summary

static String	INIT_PARAM_CACHE_EL_EXPRESSIONS Indicates if expressions generated by facelets should be cached or not.
static String	INIT_PARAM_WRAP_TAG_EXCEPTIONS_AS_CONTEXT_AWARE Wrap exception caused by calls to EL expressions, so information like the location, expression string and tag name can be retrieved by the ExceptionHandler implementation and used to output meaningful information about itself.

Fields inherited from class org.apache.myfaces.view.facelets.FaceletCompositionContext

FACELET_COMPOSITION_CONTEXT_KEY

Constructor Summary

FaceletCompositionContextImpl(FaceletFactory factory, FacesContext facesContext)

FaceletCompositionContextImpl(FaceletFactory factory, FacesContext facesContext, String base)
This constructor is intended for places where the id generation strategy needs to be changed adding a unique base id, like for example on a dynamic component creation.

Method Summary

void	addAttachedObjectHandler(UIComponent compositeComponentParent, AttachedObjectHandler handler) Add to the composite component parent this handler, so it will be processed later when ViewDeclarationLanguage.retargetAttachedObjects is called.
void	addMethodExpressionTargeted(UIComponent targetedComponent, String attributeName, Object backingValue) Add a method expression as targeted for the provided composite component
void	addUniqueId(String uniqueId) Add an unique id to the list if recording is enabled, if recording is not enabled it has no effect.
void	clearMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName) Clear the MethodExpression attribute to call vdl.retargetMethodExpression again
boolean	containsEnclosingValidatorId(String id)
void	endComponentUniqueIdSection() Ends the current unique id section, so the previous counter will be used to generate unique ids to components.
void	endMetadataSection() Call this method to indicate f:metadata section has been already processed since 2.1.7, 2.0.13
void	finalizeForDeletion(UIComponent component) Used in conjunction with markForDeletion where any UIComponent marked will be removed.
void	finalizeRelocatableResourcesForDeletion(UIViewRoot root) Used to clean up all unused relocatable components on the root component.
String	generateUniqueComponentId() Generate a unique id for component instances.
String	generateUniqueId() Generate a unique id that will be used later to derive a unique id per tag by FaceletContext.generateUniqueId().
void	generateUniqueId(StringBuilder builderToAdd)
List<AttachedObjectHandler>	getAttachedObjectHandlers(UIComponent compositeComponentParent) Retrieve the list of object handlers attached to a composite component parent.
UIComponent	getCompositeComponentFromStack() Return the composite component being applied on the current facelet.
int	getCompositeComponentLevel() Returns the current nesting level of composite components found.
ELExpressionCacheMode	getELExpressionCacheMode() Indicates if a EL Expression can be or not cached by facelets vdl.
Iterator<String>	getEnclosingValidatorIds() Gets all validationIds on the stack.
Iterator<Map.Entry<String,EditableValueHolderAttachedObjectHandler>>	getEnclosingValidatorIdsAndHandlers() Gets all validationIds with its associated EditableValueHolderAttachedObjectHandler from the stack.
Iterator<String>	getExcludedValidatorIds() Gets all validationIds on the stack.
FaceletFactory	getFaceletFactory()
String	getFirstValidationGroupFromStack() Gets the top of the validationGroups stack.
StringBuilder	getSharedStringBuilder()
String	getUniqueIdFromIterator() Return the unique id from the iterator if applies since 2.1.7, 2.0.13
List<String>	getUniqueIdList() Return the list of unique ids since 2.1.7, 2.0.13
UniqueIdVendor	getUniqueIdVendorFromStack() Return the latest UniqueIdVendor created from stack.
VisitContextFactory	getVisitContextFactory()
void	incrementUniqueComponentId()
void	incrementUniqueId() Increment the unique id without construct it.
void	initUniqueIdRecording() Activater record unique id mode, so an structure will be used to hold those values.
boolean	isBuildingViewMetadata() Check if the facelet is building view metadata since 2.1.7, 2.0.13
boolean	isDynamicComponentSection() Indicate if the current facelet section is a dynamic component section, which means it was added to the component tree using vdl.createComponent(...);
boolean	isDynamicComponentTopLevel() Check if the algorithm is applying a dynamic component and the current component is the top level one.
boolean	isDynamicCompositeComponentHandler()
boolean	isInMetadataSection() Check if the component is created inside f:metadata section since 2.1.7, 2.0.13
boolean	isMarkInitialState() Check if this build should be marked as initial state.
boolean	isMarkInitialStateAndIsRefreshTransientBuildOnPSS()
boolean	isMethodExpressionAttributeApplied(UIComponent compositeComponentParent, String attributeName) Check if the MethodExpression attribute has been applied using vdl.retargetMethodExpression
boolean	isRefreshingSection() Check if the section to be processed is being refreshed.
boolean	isRefreshingTransientBuild() Check if this build is being refreshed, adding transient components and adding/removing components under c:if or c:forEach or not.
boolean	isRefreshTransientBuildOnPSS() Check if the current view will be refreshed with partial state saving.
boolean	isRefreshTransientBuildOnPSSPreserveState()
boolean	isUsingPSSOnThisView() Check if we are using partial state saving on this view
boolean	isWrapTagExceptionsAsContextAware()
void	markForDeletion(UIComponent component) Marks all direct children and Facets with an attribute for deletion.
void	markMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName) Mark the MethodExpression attribute as applied using vdl.retargetMethodExpression
void	markRelocatableResourceForDeletion(UIComponent component) Marks the given resource for deletion.
void	popCompositeComponentToStack()
void	popDynamicComponentSection()
void	popEnclosingValidatorIdToStack() Removes top of stack.
void	popExcludedValidatorIdToStack() Removes top of stack.
void	popUniqueIdVendorToStack()
void	popValidationGroupsToStack() Removes top of stack.
void	pushCompositeComponentToStack(UIComponent parent)
void	pushDynamicComponentSection(String base)
void	pushEnclosingValidatorIdToStack(String validatorId) Pushes validatorId to the stack of all enclosing validatorIds.
void	pushEnclosingValidatorIdToStack(String validatorId, EditableValueHolderAttachedObjectHandler attachedObjectHandler) Pushes validatorId to the stack of all enclosing validatorIds.
void	pushExcludedValidatorIdToStack(String validatorId) Pushes validatorId to the stack of excluded validatorIds.
void	pushUniqueIdVendorToStack(UniqueIdVendor parent)
void	pushValidationGroupsToStack(String validationGroups) Pushes validationGroups to the stack.
void	release(FacesContext facesContext) Releases the MyFaceletContext object.
void	removeAttachedObjectHandlers(UIComponent compositeComponentParent) Remove from the composite component parent the list of attached handlers.
void	removeComponentForDeletion(UIComponent component)
Object	removeMethodExpressionTargeted(UIComponent targetedComponent, String attributeName) Remove a method expression as targeted for the provided composite component
void	setDynamicComponentTopLevel(boolean value)
void	setDynamicCompositeComponentHandler(boolean value)
void	setMarkInitialState(boolean value)
void	setUniqueIdsIterator(Iterator<String> uniqueIdsIterator) Set the iterator used to retrieve unique ids.
String	startComponentUniqueIdSection() Start a new unique id section, which means a new counter is used to generate unique ids to components
void	startMetadataSection() Call this method to indicate a f:metadata section is about to be processed since 2.1.7, 2.0.13

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

getCurrentInstance, getCurrentInstance, getCurrentInstance, init

Methods inherited from class java.lang.Object

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

Field Detail

INIT_PARAM_CACHE_EL_EXPRESSIONS

@JSFWebConfigParam(since="2.0.8",
                   defaultValue="noCache",
                   expectedValues="noCache, strict, allowCset, always",
                   group="EL",
                   tags="performance")
public static final String INIT_PARAM_CACHE_EL_EXPRESSIONS

Indicates if expressions generated by facelets should be cached or not. Default is noCache. There there are four modes:

• always: Only does not cache when expressions are inside user tags or the e xpression contains a variable resolved using VariableMapper
• allowCset: Like always, but does not allow cache when ui:param was used on the current template context
• strict: Like allowCset, but does not allow cache when c:set with var and value properties only is used on the current page context
• noCache: All expression are created each time the view is built

See Also:

Constant Field Values

INIT_PARAM_WRAP_TAG_EXCEPTIONS_AS_CONTEXT_AWARE

@JSFWebConfigParam(since="2.0.9, 2.1.3",
                   defaultValue="true",
                   expectedValues="true, false")
public static final String INIT_PARAM_WRAP_TAG_EXCEPTIONS_AS_CONTEXT_AWARE

Wrap exception caused by calls to EL expressions, so information like the location, expression string and tag name can be retrieved by the ExceptionHandler implementation and used to output meaningful information about itself.

Note in some cases this will wrap the original javax.el.ELException, so the information will not be on the stack trace unless ExceptionHandler retrieve checking if the exception implements ContextAware interface and calling getWrapped() method.

See Also:

Constant Field Values

Constructor Detail

FaceletCompositionContextImpl

public FaceletCompositionContextImpl(FaceletFactory factory,
                                     FacesContext facesContext)

FaceletCompositionContextImpl

public FaceletCompositionContextImpl(FaceletFactory factory,
                                     FacesContext facesContext,
                                     String base)

This constructor is intended for places where the id generation strategy needs to be changed adding a unique base id, like for example on a dynamic component creation.

Parameters:

factory -

facesContext -

base -

Method Detail

setUniqueIdsIterator

public void setUniqueIdsIterator(Iterator<String> uniqueIdsIterator)

Description copied from class: FaceletCompositionContext

Set the iterator used to retrieve unique ids. since 2.1.7, 2.0.13

Overrides:

setUniqueIdsIterator in class FaceletCompositionContext

initUniqueIdRecording

public void initUniqueIdRecording()

Description copied from class: FaceletCompositionContext

Activater record unique id mode, so an structure will be used to hold those values. since 2.1.7, 2.0.13

Overrides:

initUniqueIdRecording in class FaceletCompositionContext

addUniqueId

public void addUniqueId(String uniqueId)

Description copied from class: FaceletCompositionContext

Add an unique id to the list if recording is enabled, if recording is not enabled it has no effect. since 2.1.7, 2.0.13

Overrides:

addUniqueId in class FaceletCompositionContext

getUniqueIdFromIterator

public String getUniqueIdFromIterator()

Description copied from class: FaceletCompositionContext

Return the unique id from the iterator if applies since 2.1.7, 2.0.13

Overrides:

getUniqueIdFromIterator in class FaceletCompositionContext

Returns:

getUniqueIdList

public List<String> getUniqueIdList()

Description copied from class: FaceletCompositionContext

Return the list of unique ids since 2.1.7, 2.0.13

Overrides:

getUniqueIdList in class FaceletCompositionContext

Returns:

getFaceletFactory

public FaceletFactory getFaceletFactory()

Specified by:

getFaceletFactory in class FaceletCompositionContext

release

public void release(FacesContext facesContext)

Description copied from class: FaceletCompositionContext

Releases the MyFaceletContext object. This method must only be called by the code that created the MyFaceletContext.

Overrides:

release in class FaceletCompositionContext

getCompositeComponentFromStack

public UIComponent getCompositeComponentFromStack()

Description copied from class: FaceletCompositionContext

Return the composite component being applied on the current facelet. Note this is different to UIComponent.getCurrentCompositeComponent, because a composite component is added to the stack each time a composite:implementation tag handler is applied. This could be used by InsertChildrenHandler and InsertFacetHandler to retrieve the current composite component to be applied.

Specified by:

getCompositeComponentFromStack in class FaceletCompositionContext

Returns:

pushCompositeComponentToStack

public void pushCompositeComponentToStack(UIComponent parent)

Specified by:

pushCompositeComponentToStack in class FaceletCompositionContext

popCompositeComponentToStack

public void popCompositeComponentToStack()

Specified by:

popCompositeComponentToStack in class FaceletCompositionContext

getCompositeComponentLevel

public int getCompositeComponentLevel()

Description copied from class: FaceletCompositionContext

Returns the current nesting level of composite components found. If no composite component has been used returns 0.

Overrides:

getCompositeComponentLevel in class FaceletCompositionContext

getUniqueIdVendorFromStack

public UniqueIdVendor getUniqueIdVendorFromStack()

Description copied from class: FaceletCompositionContext

Return the latest UniqueIdVendor created from stack. The reason why we need to keep a UniqueIdVendor stack is because we need to look the closest one in ComponentTagHandlerDelegate. Note that facelets tree is built from leafs to root, that means use UIComponent.getParent() does not always return parent components.

Specified by:

getUniqueIdVendorFromStack in class FaceletCompositionContext

Returns:

popUniqueIdVendorToStack

public void popUniqueIdVendorToStack()

Specified by:

popUniqueIdVendorToStack in class FaceletCompositionContext

pushUniqueIdVendorToStack

public void pushUniqueIdVendorToStack(UniqueIdVendor parent)

Specified by:

pushUniqueIdVendorToStack in class FaceletCompositionContext

getFirstValidationGroupFromStack

public String getFirstValidationGroupFromStack()

Gets the top of the validationGroups stack.

Specified by:

getFirstValidationGroupFromStack in class FaceletCompositionContext

Returns:

Since:

2.0

popValidationGroupsToStack

public void popValidationGroupsToStack()

Removes top of stack.

Specified by:

popValidationGroupsToStack in class FaceletCompositionContext

Since:

2.0

pushValidationGroupsToStack

public void pushValidationGroupsToStack(String validationGroups)

Pushes validationGroups to the stack.

Specified by:

pushValidationGroupsToStack in class FaceletCompositionContext

Parameters:

validationGroups -

Since:

2.0

getExcludedValidatorIds

public Iterator<String> getExcludedValidatorIds()

Gets all validationIds on the stack.

Specified by:

getExcludedValidatorIds in class FaceletCompositionContext

Returns:

Since:

2.0

popExcludedValidatorIdToStack

public void popExcludedValidatorIdToStack()

Removes top of stack.

Specified by:

popExcludedValidatorIdToStack in class FaceletCompositionContext

Since:

2.0

pushExcludedValidatorIdToStack

public void pushExcludedValidatorIdToStack(String validatorId)

Pushes validatorId to the stack of excluded validatorIds.

Specified by:

pushExcludedValidatorIdToStack in class FaceletCompositionContext

Parameters:

validatorId -

Since:

2.0

getEnclosingValidatorIds

public Iterator<String> getEnclosingValidatorIds()

Gets all validationIds on the stack.

Specified by:

getEnclosingValidatorIds in class FaceletCompositionContext

Returns:

Since:

2.0

popEnclosingValidatorIdToStack

public void popEnclosingValidatorIdToStack()

Removes top of stack.

Specified by:

popEnclosingValidatorIdToStack in class FaceletCompositionContext

Since:

2.0

pushEnclosingValidatorIdToStack

public void pushEnclosingValidatorIdToStack(String validatorId)

Pushes validatorId to the stack of all enclosing validatorIds.

Specified by:

pushEnclosingValidatorIdToStack in class FaceletCompositionContext

Parameters:

validatorId -

Since:

2.0

pushEnclosingValidatorIdToStack

public void pushEnclosingValidatorIdToStack(String validatorId,
                                            EditableValueHolderAttachedObjectHandler attachedObjectHandler)

Description copied from class: FaceletCompositionContext

Pushes validatorId to the stack of all enclosing validatorIds.

Specified by:

pushEnclosingValidatorIdToStack in class FaceletCompositionContext

getEnclosingValidatorIdsAndHandlers

public Iterator<Map.Entry<String,EditableValueHolderAttachedObjectHandler>> getEnclosingValidatorIdsAndHandlers()

Description copied from class: FaceletCompositionContext

Gets all validationIds with its associated EditableValueHolderAttachedObjectHandler from the stack.

Specified by:

getEnclosingValidatorIdsAndHandlers in class FaceletCompositionContext

Returns:

containsEnclosingValidatorId

public boolean containsEnclosingValidatorId(String id)

Specified by:

containsEnclosingValidatorId in class FaceletCompositionContext

Returns:

isRefreshingTransientBuild

public boolean isRefreshingTransientBuild()

Description copied from class: FaceletCompositionContext

Check if this build is being refreshed, adding transient components and adding/removing components under c:if or c:forEach or not.

Specified by:

isRefreshingTransientBuild in class FaceletCompositionContext

Returns:

isMarkInitialState

public boolean isMarkInitialState()

Description copied from class: FaceletCompositionContext

Check if this build should be marked as initial state. In other words, all components must call UIComponent.markInitialState.

Specified by:

isMarkInitialState in class FaceletCompositionContext

Returns:

setMarkInitialState

public void setMarkInitialState(boolean value)

Overrides:

setMarkInitialState in class FaceletCompositionContext

isRefreshTransientBuildOnPSS

public boolean isRefreshTransientBuildOnPSS()

Description copied from class: FaceletCompositionContext

Check if the current view will be refreshed with partial state saving. This param is used in two posible events: 1. To notify UIInstruction instances to look for instances moved by cc:insertChildren or cc:insertFacet. 2. To do proper actions when a tag that could change tree structure is applied (c:if, c:forEach...)

Specified by:

isRefreshTransientBuildOnPSS in class FaceletCompositionContext

Returns:

isRefreshTransientBuildOnPSSPreserveState

public boolean isRefreshTransientBuildOnPSSPreserveState()

Overrides:

isRefreshTransientBuildOnPSSPreserveState in class FaceletCompositionContext

Returns:

isBuildingViewMetadata

public boolean isBuildingViewMetadata()

Description copied from class: FaceletCompositionContext

Check if the facelet is building view metadata since 2.1.7, 2.0.13

Overrides:

isBuildingViewMetadata in class FaceletCompositionContext

Returns:

isUsingPSSOnThisView

public boolean isUsingPSSOnThisView()

Description copied from class: FaceletCompositionContext

Check if we are using partial state saving on this view

Specified by:

isUsingPSSOnThisView in class FaceletCompositionContext

Returns:

isMarkInitialStateAndIsRefreshTransientBuildOnPSS

public boolean isMarkInitialStateAndIsRefreshTransientBuildOnPSS()

Specified by:

isMarkInitialStateAndIsRefreshTransientBuildOnPSS in class FaceletCompositionContext

Returns:

getELExpressionCacheMode

public ELExpressionCacheMode getELExpressionCacheMode()

Description copied from class: FaceletCompositionContext

Indicates if a EL Expression can be or not cached by facelets vdl.

Overrides:

getELExpressionCacheMode in class FaceletCompositionContext

Returns:

isWrapTagExceptionsAsContextAware

public boolean isWrapTagExceptionsAsContextAware()

Overrides:

isWrapTagExceptionsAsContextAware in class FaceletCompositionContext

Returns:

addAttachedObjectHandler

public void addAttachedObjectHandler(UIComponent compositeComponentParent,
                                     AttachedObjectHandler handler)

Description copied from class: FaceletCompositionContext

Add to the composite component parent this handler, so it will be processed later when ViewDeclarationLanguage.retargetAttachedObjects is called. Tag Handlers exposing attached objects should call this method to expose them when the parent to be applied is a composite components.

Specified by:

addAttachedObjectHandler in class FaceletCompositionContext

removeAttachedObjectHandlers

public void removeAttachedObjectHandlers(UIComponent compositeComponentParent)

Description copied from class: FaceletCompositionContext

Remove from the composite component parent the list of attached handlers.

Specified by:

removeAttachedObjectHandlers in class FaceletCompositionContext

getAttachedObjectHandlers

public List<AttachedObjectHandler> getAttachedObjectHandlers(UIComponent compositeComponentParent)

Description copied from class: FaceletCompositionContext

Retrieve the list of object handlers attached to a composite component parent.

Specified by:

getAttachedObjectHandlers in class FaceletCompositionContext

addMethodExpressionTargeted

public void addMethodExpressionTargeted(UIComponent targetedComponent,
                                        String attributeName,
                                        Object backingValue)

Description copied from class: FaceletCompositionContext

Add a method expression as targeted for the provided composite component

Specified by:

addMethodExpressionTargeted in class FaceletCompositionContext

backingValue - A value that could be useful to revert its effects.

isMethodExpressionAttributeApplied

public boolean isMethodExpressionAttributeApplied(UIComponent compositeComponentParent,
                                                  String attributeName)

Description copied from class: FaceletCompositionContext

Check if the MethodExpression attribute has been applied using vdl.retargetMethodExpression

Specified by:

isMethodExpressionAttributeApplied in class FaceletCompositionContext

Returns:

markMethodExpressionAttribute

public void markMethodExpressionAttribute(UIComponent compositeComponentParent,
                                          String attributeName)

Description copied from class: FaceletCompositionContext

Mark the MethodExpression attribute as applied using vdl.retargetMethodExpression

Specified by:

markMethodExpressionAttribute in class FaceletCompositionContext

clearMethodExpressionAttribute

public void clearMethodExpressionAttribute(UIComponent compositeComponentParent,
                                           String attributeName)

Description copied from class: FaceletCompositionContext

Clear the MethodExpression attribute to call vdl.retargetMethodExpression again

Specified by:

clearMethodExpressionAttribute in class FaceletCompositionContext

removeMethodExpressionTargeted

public Object removeMethodExpressionTargeted(UIComponent targetedComponent,
                                             String attributeName)

Description copied from class: FaceletCompositionContext

Remove a method expression as targeted for the provided composite component

Specified by:

removeMethodExpressionTargeted in class FaceletCompositionContext

Returns:

A value that could be useful to revert its effects.

markForDeletion

public void markForDeletion(UIComponent component)

Description copied from class: FaceletCompositionContext

Marks all direct children and Facets with an attribute for deletion.

Specified by:

markForDeletion in class FaceletCompositionContext

Parameters:

component - UIComponent to mark

See Also:

FaceletCompositionContext.finalizeForDeletion(UIComponent)

removeComponentForDeletion

public void removeComponentForDeletion(UIComponent component)

Overrides:

removeComponentForDeletion in class FaceletCompositionContext

finalizeForDeletion

public void finalizeForDeletion(UIComponent component)

Description copied from class: FaceletCompositionContext

Used in conjunction with markForDeletion where any UIComponent marked will be removed.

Specified by:

finalizeForDeletion in class FaceletCompositionContext

Parameters:

component - UIComponent to finalize

markRelocatableResourceForDeletion

public void markRelocatableResourceForDeletion(UIComponent component)

Description copied from class: FaceletCompositionContext

Marks the given resource for deletion. Is to be used for relocatable components instead of FaceletCompositionContext.markForDeletion(UIComponent).

Overrides:

markRelocatableResourceForDeletion in class FaceletCompositionContext

Parameters:

component - UIComponent to finalize

finalizeRelocatableResourcesForDeletion

public void finalizeRelocatableResourcesForDeletion(UIViewRoot root)

Description copied from class: FaceletCompositionContext

Used to clean up all unused relocatable components on the root component.

Overrides:

finalizeRelocatableResourcesForDeletion in class FaceletCompositionContext

startComponentUniqueIdSection

public String startComponentUniqueIdSection()

Description copied from class: FaceletCompositionContext

Start a new unique id section, which means a new counter is used to generate unique ids to components

Overrides:

startComponentUniqueIdSection in class FaceletCompositionContext

Returns:

incrementUniqueId

public void incrementUniqueId()

Description copied from class: FaceletCompositionContext

Increment the unique id without construct it. since 2.1.7, 2.0.13

Overrides:

incrementUniqueId in class FaceletCompositionContext

generateUniqueId

public String generateUniqueId()

Description copied from class: FaceletCompositionContext

Generate a unique id that will be used later to derive a unique id per tag by FaceletContext.generateUniqueId(). This generator ensures uniqueness per view but FaceletContext.generateUniqueId() ensures uniqueness per view and per facelet hierarchy, so different included facelets will generate different ids.

Overrides:

generateUniqueId in class FaceletCompositionContext

Returns:

generateUniqueId

public void generateUniqueId(StringBuilder builderToAdd)

Overrides:

generateUniqueId in class FaceletCompositionContext

generateUniqueComponentId

public String generateUniqueComponentId()

Description copied from class: FaceletCompositionContext

Generate a unique id for component instances.

Overrides:

generateUniqueComponentId in class FaceletCompositionContext

Returns:

incrementUniqueComponentId

public void incrementUniqueComponentId()

Overrides:

incrementUniqueComponentId in class FaceletCompositionContext

endComponentUniqueIdSection

public void endComponentUniqueIdSection()

Description copied from class: FaceletCompositionContext

Ends the current unique id section, so the previous counter will be used to generate unique ids to components.

Overrides:

endComponentUniqueIdSection in class FaceletCompositionContext

startMetadataSection

public void startMetadataSection()

Description copied from class: FaceletCompositionContext

Call this method to indicate a f:metadata section is about to be processed since 2.1.7, 2.0.13

Overrides:

startMetadataSection in class FaceletCompositionContext

endMetadataSection

public void endMetadataSection()

Description copied from class: FaceletCompositionContext

Call this method to indicate f:metadata section has been already processed since 2.1.7, 2.0.13

Overrides:

endMetadataSection in class FaceletCompositionContext

isInMetadataSection

public boolean isInMetadataSection()

Description copied from class: FaceletCompositionContext

Check if the component is created inside f:metadata section since 2.1.7, 2.0.13

Overrides:

isInMetadataSection in class FaceletCompositionContext

Returns:

isRefreshingSection

public boolean isRefreshingSection()

Description copied from class: FaceletCompositionContext

Check if the section to be processed is being refreshed. since 2.1.7, 2.0.13

Overrides:

isRefreshingSection in class FaceletCompositionContext

Returns:

getSharedStringBuilder

public StringBuilder getSharedStringBuilder()

Overrides:

getSharedStringBuilder in class FaceletCompositionContext

isDynamicCompositeComponentHandler

public boolean isDynamicCompositeComponentHandler()

Overrides:

isDynamicCompositeComponentHandler in class FaceletCompositionContext

setDynamicCompositeComponentHandler

public void setDynamicCompositeComponentHandler(boolean value)

Overrides:

setDynamicCompositeComponentHandler in class FaceletCompositionContext

pushDynamicComponentSection

public void pushDynamicComponentSection(String base)

Overrides:

pushDynamicComponentSection in class FaceletCompositionContext

popDynamicComponentSection

public void popDynamicComponentSection()

Overrides:

popDynamicComponentSection in class FaceletCompositionContext

isDynamicComponentTopLevel

public boolean isDynamicComponentTopLevel()

Description copied from class: FaceletCompositionContext

Check if the algorithm is applying a dynamic component and the current component is the top level one. This is necessary to avoid remove/add the component under a refresh and in that way change the position of the component in the tree. Remember facelets algorithm removes/add components to sort the components under a refresh, but in this case, it is up to the user to put the component in the tree, so the idea is do not make interference with the user's code. Note if the dynamic content is wrapped by a generated panel, the top level component is the wrapper itself, which has no attached tag handler.

Overrides:

isDynamicComponentTopLevel in class FaceletCompositionContext

Returns:

setDynamicComponentTopLevel

public void setDynamicComponentTopLevel(boolean value)

Overrides:

setDynamicComponentTopLevel in class FaceletCompositionContext

isDynamicComponentSection

public boolean isDynamicComponentSection()

Description copied from class: FaceletCompositionContext

Indicate if the current facelet section is a dynamic component section, which means it was added to the component tree using vdl.createComponent(...);

Overrides:

isDynamicComponentSection in class FaceletCompositionContext

Returns:

getVisitContextFactory

public VisitContextFactory getVisitContextFactory()

Overrides:

getVisitContextFactory in class FaceletCompositionContext