org.apache.myfaces.view.facelets.impl.FaceletCompositionContextImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of myfaces-impl Show documentation
Show all versions of myfaces-impl Show documentation
The private implementation classes of the Apache MyFaces Core JSF-2.0 Implementation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.myfaces.view.facelets.impl;
import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFWebConfigParam;
import org.apache.myfaces.shared.util.WebConfigParamUtils;
import org.apache.myfaces.view.facelets.ELExpressionCacheMode;
import org.apache.myfaces.view.facelets.FaceletCompositionContext;
import org.apache.myfaces.view.facelets.FaceletFactory;
import org.apache.myfaces.view.facelets.FaceletViewDeclarationLanguage;
import org.apache.myfaces.view.facelets.tag.jsf.ComponentSupport;
import javax.faces.component.UIComponent;
import javax.faces.component.UniqueIdVendor;
import javax.faces.context.FacesContext;
import javax.faces.view.AttachedObjectHandler;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
/**
* @since 2.0.1
* @author Leonardo Uribe (latest modification by $Author: lu4242 $)
* @version $Revision: 899026 $ $Date: 2010-01-13 20:47:14 -0500 (Mié, 13 Ene 2010) $
*/
public class FaceletCompositionContextImpl extends FaceletCompositionContext
{
/**
* 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 expression 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
*
*
*/
@JSFWebConfigParam(since="2.0.8", defaultValue="noCache", expectedValues="noCache, strict, allowCset, always")
public static final String INIT_PARAM_CACHE_EL_EXPRESSIONS = "org.apache.myfaces.CACHE_EL_EXPRESSIONS";
private FacesContext _facesContext;
private FaceletFactory _factory;
private LinkedList _compositeComponentStack;
private LinkedList _uniqueIdVendorStack;
private LinkedList _validationGroupsStack;
private LinkedList _excludedValidatorIdsStack;
private LinkedList _enclosingValidatorIdsStack;
private Boolean _isRefreshingTransientBuild;
private Boolean _isMarkInitialState;
private Boolean _refreshTransientBuildOnPSS;
private Boolean _usingPSSOnThisView;
private ELExpressionCacheMode _elExpressionCacheMode;
private List> _componentsMarkedForDeletion;
private int _deletionLevel;
private final Map> _attachedObjectHandlers;
private final Map > _methodExpressionsTargeted;
private final Map > _compositeComponentAttributesMarked;
private static final String VIEWROOT_FACELET_ID = "oam.VIEW_ROOT";
public FaceletCompositionContextImpl(FaceletFactory factory, FacesContext facesContext)
{
super();
_factory = factory;
_facesContext = facesContext;
_attachedObjectHandlers = new HashMap>();
_componentsMarkedForDeletion = new ArrayList>();
_methodExpressionsTargeted = new HashMap>();
_compositeComponentAttributesMarked = new HashMap>();
_deletionLevel = -1;
}
public FaceletFactory getFaceletFactory()
{
return _factory;
}
@Override
public void release(FacesContext facesContext)
{
super.release(facesContext);
_factory = null;
_facesContext = null;
_compositeComponentStack = null;
_enclosingValidatorIdsStack = null;
_excludedValidatorIdsStack = null;
_uniqueIdVendorStack = null;
_validationGroupsStack = null;
_componentsMarkedForDeletion = null;
}
@Override
public UIComponent getCompositeComponentFromStack()
{
if (_compositeComponentStack != null && !_compositeComponentStack.isEmpty())
{
return _compositeComponentStack.peek();
}
return null;
}
@Override
public void pushCompositeComponentToStack(UIComponent parent)
{
if (_compositeComponentStack == null)
{
_compositeComponentStack = new LinkedList();
}
_compositeComponentStack.addFirst(parent);
}
@Override
public void popCompositeComponentToStack()
{
if (_compositeComponentStack != null && !_compositeComponentStack.isEmpty())
{
_compositeComponentStack.removeFirst();
}
}
@Override
public UniqueIdVendor getUniqueIdVendorFromStack()
{
if (_uniqueIdVendorStack != null && !_uniqueIdVendorStack.isEmpty())
{
return _uniqueIdVendorStack.peek();
}
return null;
}
@Override
public void popUniqueIdVendorToStack()
{
if (_uniqueIdVendorStack != null && !_uniqueIdVendorStack.isEmpty())
{
_uniqueIdVendorStack.removeFirst();
}
}
@Override
public void pushUniqueIdVendorToStack(UniqueIdVendor parent)
{
if (_uniqueIdVendorStack == null)
{
_uniqueIdVendorStack = new LinkedList();
}
_uniqueIdVendorStack.addFirst(parent);
}
/**
* Gets the top of the validationGroups stack.
* @return
* @since 2.0
*/
@Override
public String getFirstValidationGroupFromStack()
{
if (_validationGroupsStack != null && !_validationGroupsStack.isEmpty())
{
return _validationGroupsStack.getFirst(); // top-of-stack
}
return null;
}
/**
* Removes top of stack.
* @since 2.0
*/
@Override
public void popValidationGroupsToStack()
{
if (_validationGroupsStack != null && !_validationGroupsStack.isEmpty())
{
_validationGroupsStack.removeFirst();
}
}
/**
* Pushes validationGroups to the stack.
* @param validationGroups
* @since 2.0
*/
@Override
public void pushValidationGroupsToStack(String validationGroups)
{
if (_validationGroupsStack == null)
{
_validationGroupsStack = new LinkedList();
}
_validationGroupsStack.addFirst(validationGroups);
}
/**
* Gets all validationIds on the stack.
* @return
* @since 2.0
*/
@Override
public Iterator getExcludedValidatorIds()
{
if (_excludedValidatorIdsStack != null && !_excludedValidatorIdsStack.isEmpty())
{
return _excludedValidatorIdsStack.iterator();
}
return null;
}
/**
* Removes top of stack.
* @since 2.0
*/
@Override
public void popExcludedValidatorIdToStack()
{
if (_excludedValidatorIdsStack != null && !_excludedValidatorIdsStack.isEmpty())
{
_excludedValidatorIdsStack.removeFirst();
}
}
/**
* Pushes validatorId to the stack of excluded validatorIds.
* @param validatorId
* @since 2.0
*/
@Override
public void pushExcludedValidatorIdToStack(String validatorId)
{
if (_excludedValidatorIdsStack == null)
{
_excludedValidatorIdsStack = new LinkedList();
}
_excludedValidatorIdsStack.addFirst(validatorId);
}
/**
* Gets all validationIds on the stack.
* @return
* @since 2.0
*/
@Override
public Iterator getEnclosingValidatorIds()
{
if (_enclosingValidatorIdsStack != null && !_enclosingValidatorIdsStack.isEmpty())
{
return _enclosingValidatorIdsStack.iterator();
}
return null;
}
/**
* Removes top of stack.
* @since 2.0
*/
@Override
public void popEnclosingValidatorIdToStack()
{
if (_enclosingValidatorIdsStack != null && !_enclosingValidatorIdsStack.isEmpty())
{
_enclosingValidatorIdsStack.removeFirst();
}
}
/**
* Pushes validatorId to the stack of all enclosing validatorIds.
* @param validatorId
* @since 2.0
*/
@Override
public void pushEnclosingValidatorIdToStack(String validatorId)
{
if (_enclosingValidatorIdsStack == null)
{
_enclosingValidatorIdsStack = new LinkedList();
}
_enclosingValidatorIdsStack.addFirst(validatorId);
}
@Override
public boolean isRefreshingTransientBuild()
{
if (_isRefreshingTransientBuild == null)
{
_isRefreshingTransientBuild = FaceletViewDeclarationLanguage.
isRefreshingTransientBuild(_facesContext);
}
return _isRefreshingTransientBuild;
}
@Override
public boolean isMarkInitialState()
{
if (_isMarkInitialState == null)
{
_isMarkInitialState = FaceletViewDeclarationLanguage.
isMarkInitialState(_facesContext);
}
return _isMarkInitialState;
}
@Override
public boolean isRefreshTransientBuildOnPSS()
{
if (_refreshTransientBuildOnPSS == null)
{
_refreshTransientBuildOnPSS = FaceletViewDeclarationLanguage.
isRefreshTransientBuildOnPSS(_facesContext);
}
return _refreshTransientBuildOnPSS;
}
@Override
public boolean isUsingPSSOnThisView()
{
if (_usingPSSOnThisView == null)
{
_usingPSSOnThisView = FaceletViewDeclarationLanguage.
isUsingPSSOnThisView(_facesContext);
}
return _usingPSSOnThisView;
}
public boolean isMarkInitialStateAndIsRefreshTransientBuildOnPSS()
{
return isMarkInitialState() && isRefreshTransientBuildOnPSS();
}
@Override
public ELExpressionCacheMode getELExpressionCacheMode()
{
if (_elExpressionCacheMode == null)
{
String value = WebConfigParamUtils.getStringInitParameter(
_facesContext.getExternalContext(), INIT_PARAM_CACHE_EL_EXPRESSIONS, ELExpressionCacheMode.noCache.name());
_elExpressionCacheMode = Enum.valueOf(ELExpressionCacheMode.class, value);
}
return _elExpressionCacheMode;
}
@Override
public void addAttachedObjectHandler(UIComponent compositeComponentParent, AttachedObjectHandler handler)
{
List list = _attachedObjectHandlers.get(compositeComponentParent);
if (list == null)
{
list = new ArrayList();
_attachedObjectHandlers.put(compositeComponentParent, list);
}
list.add(handler);
}
@Override
public void removeAttachedObjectHandlers(UIComponent compositeComponentParent)
{
_attachedObjectHandlers.remove(compositeComponentParent);
}
@Override
public List getAttachedObjectHandlers(UIComponent compositeComponentParent)
{
return _attachedObjectHandlers.get(compositeComponentParent);
}
@Override
public void addMethodExpressionTargeted(UIComponent targetedComponent, String attributeName, Object backingValue)
{
Map map = _methodExpressionsTargeted.get(targetedComponent);
if (map == null)
{
map = new HashMap(8);
_methodExpressionsTargeted.put(targetedComponent, map);
}
map.put(attributeName, backingValue);
}
/*
@Override
public Map getMethodExpressionsTargeted(UIComponent compositeComponentParent)
{
Map map = _methodExpressionsTargeted.get(compositeComponentParent);
if (map == null)
{
map = Collections.emptyMap();
}
return map;
}*/
public boolean isMethodExpressionAttributeApplied(UIComponent compositeComponentParent, String attributeName)
{
Map map = _compositeComponentAttributesMarked.get(compositeComponentParent);
if (map == null)
{
return false;
}
Boolean v = map.get(attributeName);
return v == null ? false : v.booleanValue();
}
public void markMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName)
{
Map map = _compositeComponentAttributesMarked.get(compositeComponentParent);
if (map == null)
{
map = new HashMap(8);
_compositeComponentAttributesMarked.put(compositeComponentParent, map);
}
map.put(attributeName, Boolean.TRUE);
}
public void clearMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName)
{
Map map = _compositeComponentAttributesMarked.get(compositeComponentParent);
if (map == null)
{
//No map, so just return
return;
}
map.put(attributeName, Boolean.FALSE);
}
@Override
public Object removeMethodExpressionTargeted(UIComponent targetedComponent, String attributeName)
{
Map map = _methodExpressionsTargeted.get(targetedComponent);
if (map != null)
{
return map.remove(attributeName);
}
return null;
}
/**
* Add a level of components marked for deletion.
*/
private void increaseComponentLevelMarkedForDeletion()
{
_deletionLevel++;
if (_componentsMarkedForDeletion.size() <= _deletionLevel)
{
_componentsMarkedForDeletion.add(new HashMap());
}
}
/**
* Remove the last component level from the components marked to be deleted. The components are removed
* from this list because they are deleted from the tree. This is done in ComponentSupport.finalizeForDeletion.
*
* @return the array of components that are removed.
*/
private void decreaseComponentLevelMarkedForDeletion()
{
//The common case is this co
if (!_componentsMarkedForDeletion.get(_deletionLevel).isEmpty())
{
_componentsMarkedForDeletion.get(_deletionLevel).clear();
}
_deletionLevel--;
}
/** Mark a component to be deleted from the tree. The component to be deleted is addded on the
* current level. This is done from ComponentSupport.markForDeletion
*
* @param id
* @param component the component marked for deletion.
*/
private void markComponentForDeletion(String id , UIComponent component)
{
_componentsMarkedForDeletion.get(_deletionLevel).put(id, component);
}
/**
* Remove a component from the last level of components marked to be deleted.
*
* @param id
*/
private UIComponent removeComponentForDeletion(String id)
{
UIComponent removedComponent = _componentsMarkedForDeletion.get(_deletionLevel).remove(id);
if (removedComponent != null && _deletionLevel > 0)
{
_componentsMarkedForDeletion.get(_deletionLevel-1).remove(id);
}
return removedComponent;
}
public void markForDeletion(UIComponent component)
{
increaseComponentLevelMarkedForDeletion();
String id = (String) component.getAttributes().get(ComponentSupport.MARK_CREATED);
id = (id == null) ? VIEWROOT_FACELET_ID : id;
markComponentForDeletion(id, component);
Map facets = component.getFacets();
if (!facets.isEmpty())
{
for (Iterator itr = facets.values().iterator(); itr.hasNext();)
{
UIComponent fc = itr.next();
id = (String) fc.getAttributes().get(ComponentSupport.MARK_CREATED);
if (id != null)
{
markComponentForDeletion(id, fc);
}
else if (Boolean.TRUE.equals(fc.getAttributes().get(ComponentSupport.FACET_CREATED_UIPANEL_MARKER)))
{
//Mark its children, but do not mark itself.
if (fc.getChildCount() > 0)
{
for (Iterator fciter = fc.getChildren().iterator(); fciter.hasNext();)
{
UIComponent child = fciter.next();
id = (String) child.getAttributes().get(ComponentSupport.MARK_CREATED);
if (id != null)
{
markComponentForDeletion(id, child);
}
}
}
}
}
}
if (component.getChildCount() > 0)
{
for (Iterator iter = component.getChildren().iterator(); iter.hasNext();)
{
UIComponent child = iter.next();
id = (String) child.getAttributes().get(ComponentSupport.MARK_CREATED);
if (id != null)
{
markComponentForDeletion(id, child);
}
}
}
}
public void finalizeForDeletion(UIComponent component)
{
String id = (String) component.getAttributes().get(ComponentSupport.MARK_CREATED);
id = (id == null) ? VIEWROOT_FACELET_ID : id;
// remove any existing marks of deletion
removeComponentForDeletion(id);
// finally remove any children marked as deleted
if (component.getChildCount() > 0)
{
for (Iterator iter = component.getChildren().iterator(); iter.hasNext();)
{
UIComponent child = iter.next();
id = (String) child.getAttributes().get(ComponentSupport.MARK_CREATED);
if (id != null && removeComponentForDeletion(id) != null)
{
iter.remove();
}
}
}
// remove any facets marked as deleted
Map facets = component.getFacets();
if (!facets.isEmpty())
{
for (Iterator itr = facets.values().iterator(); itr.hasNext();)
{
UIComponent fc = itr.next();
id = (String) fc.getAttributes().get(ComponentSupport.MARK_CREATED);
if (id != null && removeComponentForDeletion(id) != null)
{
itr.remove();
}
else if ( id == null && Boolean.TRUE.equals(fc.getAttributes().get(ComponentSupport.FACET_CREATED_UIPANEL_MARKER)))
{
if (fc.getChildCount() > 0)
{
for (Iterator fciter = fc.getChildren().iterator(); fciter.hasNext();)
{
UIComponent child = fciter.next();
id = (String) child.getAttributes().get(ComponentSupport.MARK_CREATED);
if (id != null && removeComponentForDeletion(id) != null)
{
fciter.remove();
}
}
}
if (fc.getChildCount() == 0)
{
itr.remove();
}
}
}
}
decreaseComponentLevelMarkedForDeletion();
}
}