public class FaceletCompositionContextImpl extends FaceletCompositionContext
| Modifier and Type | Field and Description |
|---|---|
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.
|
FACELET_COMPOSITION_CONTEXT_KEY| Constructor and Description |
|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
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 |
endComponentUniqueIdSection(String base) |
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.
|
UIViewRoot |
getViewRoot(FacesContext facesContext) |
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.
|
void |
setViewRoot(UIViewRoot root) |
String |
startComponentUniqueIdSection()
Start a new unique id section, which means a new counter is used to
generate unique ids to components
|
String |
startComponentUniqueIdSection(String base)
Start a new unique id section, which means a new counter is used to
generate unique ids to components, but appending a base to the
new counter.
|
void |
startMetadataSection()
Call this method to indicate a f:metadata section is about to be processed
since 2.1.7, 2.0.13
|
getCurrentInstance, getCurrentInstance, getCurrentInstance, init@JSFWebConfigParam(since="2.0.8",
defaultValue="noCache",
expectedValues="noCache, strict, allowCset, always, alwaysRecompile",
group="EL",
tags="performance")
public static final String INIT_PARAM_CACHE_EL_EXPRESSIONS
@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
Note in some cases this will wrap the original jakarta.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.
public FaceletCompositionContextImpl(FaceletFactory factory, FacesContext facesContext)
public FaceletCompositionContextImpl(FaceletFactory factory, FacesContext facesContext, String base)
factory - facesContext - base - public void setUniqueIdsIterator(Iterator<String> uniqueIdsIterator)
FaceletCompositionContextsetUniqueIdsIterator in class FaceletCompositionContextpublic void initUniqueIdRecording()
FaceletCompositionContextinitUniqueIdRecording in class FaceletCompositionContextpublic void addUniqueId(String uniqueId)
FaceletCompositionContextaddUniqueId in class FaceletCompositionContextpublic String getUniqueIdFromIterator()
FaceletCompositionContextgetUniqueIdFromIterator in class FaceletCompositionContextpublic List<String> getUniqueIdList()
FaceletCompositionContextgetUniqueIdList in class FaceletCompositionContextpublic FaceletFactory getFaceletFactory()
getFaceletFactory in class FaceletCompositionContextpublic void release(FacesContext facesContext)
FaceletCompositionContextrelease in class FaceletCompositionContextpublic UIComponent getCompositeComponentFromStack()
FaceletCompositionContextgetCompositeComponentFromStack in class FaceletCompositionContextpublic void pushCompositeComponentToStack(UIComponent parent)
pushCompositeComponentToStack in class FaceletCompositionContextpublic void popCompositeComponentToStack()
popCompositeComponentToStack in class FaceletCompositionContextpublic int getCompositeComponentLevel()
FaceletCompositionContextgetCompositeComponentLevel in class FaceletCompositionContextpublic UniqueIdVendor getUniqueIdVendorFromStack()
FaceletCompositionContextgetUniqueIdVendorFromStack in class FaceletCompositionContextpublic void popUniqueIdVendorToStack()
popUniqueIdVendorToStack in class FaceletCompositionContextpublic void pushUniqueIdVendorToStack(UniqueIdVendor parent)
pushUniqueIdVendorToStack in class FaceletCompositionContextpublic String getFirstValidationGroupFromStack()
getFirstValidationGroupFromStack in class FaceletCompositionContextpublic void popValidationGroupsToStack()
popValidationGroupsToStack in class FaceletCompositionContextpublic void pushValidationGroupsToStack(String validationGroups)
pushValidationGroupsToStack in class FaceletCompositionContextvalidationGroups - public Iterator<String> getExcludedValidatorIds()
getExcludedValidatorIds in class FaceletCompositionContextpublic void popExcludedValidatorIdToStack()
popExcludedValidatorIdToStack in class FaceletCompositionContextpublic void pushExcludedValidatorIdToStack(String validatorId)
pushExcludedValidatorIdToStack in class FaceletCompositionContextvalidatorId - public Iterator<String> getEnclosingValidatorIds()
getEnclosingValidatorIds in class FaceletCompositionContextpublic void popEnclosingValidatorIdToStack()
popEnclosingValidatorIdToStack in class FaceletCompositionContextpublic void pushEnclosingValidatorIdToStack(String validatorId)
pushEnclosingValidatorIdToStack in class FaceletCompositionContextvalidatorId - public void pushEnclosingValidatorIdToStack(String validatorId, EditableValueHolderAttachedObjectHandler attachedObjectHandler)
FaceletCompositionContextpushEnclosingValidatorIdToStack in class FaceletCompositionContextpublic Iterator<Map.Entry<String,EditableValueHolderAttachedObjectHandler>> getEnclosingValidatorIdsAndHandlers()
FaceletCompositionContextgetEnclosingValidatorIdsAndHandlers in class FaceletCompositionContextpublic boolean containsEnclosingValidatorId(String id)
containsEnclosingValidatorId in class FaceletCompositionContextpublic boolean isRefreshingTransientBuild()
FaceletCompositionContextisRefreshingTransientBuild in class FaceletCompositionContextpublic boolean isMarkInitialState()
FaceletCompositionContextisMarkInitialState in class FaceletCompositionContextpublic void setMarkInitialState(boolean value)
setMarkInitialState in class FaceletCompositionContextpublic boolean isRefreshTransientBuildOnPSS()
FaceletCompositionContextisRefreshTransientBuildOnPSS in class FaceletCompositionContextpublic boolean isRefreshTransientBuildOnPSSPreserveState()
isRefreshTransientBuildOnPSSPreserveState in class FaceletCompositionContextpublic boolean isBuildingViewMetadata()
FaceletCompositionContextisBuildingViewMetadata in class FaceletCompositionContextpublic boolean isUsingPSSOnThisView()
FaceletCompositionContextisUsingPSSOnThisView in class FaceletCompositionContextpublic boolean isMarkInitialStateAndIsRefreshTransientBuildOnPSS()
isMarkInitialStateAndIsRefreshTransientBuildOnPSS in class FaceletCompositionContextpublic ELExpressionCacheMode getELExpressionCacheMode()
FaceletCompositionContextgetELExpressionCacheMode in class FaceletCompositionContextpublic boolean isWrapTagExceptionsAsContextAware()
isWrapTagExceptionsAsContextAware in class FaceletCompositionContextpublic void addAttachedObjectHandler(UIComponent compositeComponentParent, AttachedObjectHandler handler)
FaceletCompositionContextaddAttachedObjectHandler in class FaceletCompositionContextpublic void removeAttachedObjectHandlers(UIComponent compositeComponentParent)
FaceletCompositionContextremoveAttachedObjectHandlers in class FaceletCompositionContextpublic List<AttachedObjectHandler> getAttachedObjectHandlers(UIComponent compositeComponentParent)
FaceletCompositionContextgetAttachedObjectHandlers in class FaceletCompositionContextpublic void addMethodExpressionTargeted(UIComponent targetedComponent, String attributeName, Object backingValue)
FaceletCompositionContextaddMethodExpressionTargeted in class FaceletCompositionContextbackingValue - A value that could be useful to revert its effects.public boolean isMethodExpressionAttributeApplied(UIComponent compositeComponentParent, String attributeName)
FaceletCompositionContextisMethodExpressionAttributeApplied in class FaceletCompositionContextpublic void markMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName)
FaceletCompositionContextmarkMethodExpressionAttribute in class FaceletCompositionContextpublic void clearMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName)
FaceletCompositionContextclearMethodExpressionAttribute in class FaceletCompositionContextpublic Object removeMethodExpressionTargeted(UIComponent targetedComponent, String attributeName)
FaceletCompositionContextremoveMethodExpressionTargeted in class FaceletCompositionContextpublic void markForDeletion(UIComponent component)
FaceletCompositionContextmarkForDeletion in class FaceletCompositionContextcomponent - UIComponent to markFaceletCompositionContext.finalizeForDeletion(UIComponent)public void removeComponentForDeletion(UIComponent component)
removeComponentForDeletion in class FaceletCompositionContextpublic void finalizeForDeletion(UIComponent component)
FaceletCompositionContextfinalizeForDeletion in class FaceletCompositionContextcomponent - UIComponent to finalizepublic void markRelocatableResourceForDeletion(UIComponent component)
FaceletCompositionContextFaceletCompositionContext.markForDeletion(UIComponent).markRelocatableResourceForDeletion in class FaceletCompositionContextcomponent - UIComponent to finalizepublic void finalizeRelocatableResourcesForDeletion(UIViewRoot root)
FaceletCompositionContextfinalizeRelocatableResourcesForDeletion in class FaceletCompositionContextroot - UIComponent to finalize (root component)public String startComponentUniqueIdSection()
FaceletCompositionContextstartComponentUniqueIdSection in class FaceletCompositionContextpublic String startComponentUniqueIdSection(String base)
FaceletCompositionContextstartComponentUniqueIdSection in class FaceletCompositionContextpublic void incrementUniqueId()
FaceletCompositionContextincrementUniqueId in class FaceletCompositionContextpublic String generateUniqueId()
FaceletCompositionContextgenerateUniqueId in class FaceletCompositionContextpublic void generateUniqueId(StringBuilder builderToAdd)
generateUniqueId in class FaceletCompositionContextpublic String generateUniqueComponentId()
FaceletCompositionContextgenerateUniqueComponentId in class FaceletCompositionContextpublic void incrementUniqueComponentId()
incrementUniqueComponentId in class FaceletCompositionContextpublic void endComponentUniqueIdSection()
FaceletCompositionContextendComponentUniqueIdSection in class FaceletCompositionContextpublic void endComponentUniqueIdSection(String base)
endComponentUniqueIdSection in class FaceletCompositionContextpublic void startMetadataSection()
FaceletCompositionContextstartMetadataSection in class FaceletCompositionContextpublic void endMetadataSection()
FaceletCompositionContextendMetadataSection in class FaceletCompositionContextpublic boolean isInMetadataSection()
FaceletCompositionContextisInMetadataSection in class FaceletCompositionContextpublic boolean isRefreshingSection()
FaceletCompositionContextisRefreshingSection in class FaceletCompositionContextpublic StringBuilder getSharedStringBuilder()
getSharedStringBuilder in class FaceletCompositionContextpublic boolean isDynamicCompositeComponentHandler()
isDynamicCompositeComponentHandler in class FaceletCompositionContextpublic void setDynamicCompositeComponentHandler(boolean value)
setDynamicCompositeComponentHandler in class FaceletCompositionContextpublic void pushDynamicComponentSection(String base)
pushDynamicComponentSection in class FaceletCompositionContextpublic void popDynamicComponentSection()
popDynamicComponentSection in class FaceletCompositionContextpublic boolean isDynamicComponentTopLevel()
FaceletCompositionContextisDynamicComponentTopLevel in class FaceletCompositionContextpublic void setDynamicComponentTopLevel(boolean value)
setDynamicComponentTopLevel in class FaceletCompositionContextpublic boolean isDynamicComponentSection()
FaceletCompositionContextisDynamicComponentSection in class FaceletCompositionContextpublic void setViewRoot(UIViewRoot root)
setViewRoot in class FaceletCompositionContextpublic UIViewRoot getViewRoot(FacesContext facesContext)
getViewRoot in class FaceletCompositionContextpublic VisitContextFactory getVisitContextFactory()
getVisitContextFactory in class FaceletCompositionContextCopyright © 2022 The Apache Software Foundation. All rights reserved.