com.sun.faces.facelets.tag.jsf.ComponentSupport Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.0 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2005-2007 The Apache Software Foundation
*
* Licensed 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 com.sun.faces.facelets.tag.jsf;
import com.sun.faces.context.StateContext;
import com.sun.faces.facelets.tag.jsf.core.FacetHandler;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UIPanel;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.view.facelets.FaceletContext;
import javax.faces.view.facelets.TagAttribute;
import javax.faces.view.facelets.TagAttributeException;
import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import javax.faces.view.facelets.Tag;
/**
*
* @author Jacob Hookom
* @version $Id: ComponentSupport.java 8802 2011-01-12 01:34:27Z edburns $
*/
public final class ComponentSupport {
private final static String MARK_DELETED = "com.sun.faces.facelets.MARK_DELETED";
public final static String MARK_CREATED = "com.sun.faces.facelets.MARK_ID";
private final static String IMPLICIT_PANEL = "com.sun.faces.facelets.IMPLICIT_PANEL";
/**
* Key to a FacesContext scoped Map where the keys are UIComponent instances and the
* values are Tag instances.
*/
public static final String COMPONENT_TO_TAG_MAP_NAME = "com.sun.faces.facelets.COMPONENT_TO_LOCATION_MAP";
/**
* Used in conjunction with markForDeletion where any UIComponent marked
* will be removed.
*
* @param c
* UIComponent to finalize
*/
public static void finalizeForDeletion(UIComponent c) {
// remove any existing marks of deletion
c.getAttributes().remove(MARK_DELETED);
// finally remove any children marked as deleted
int sz = c.getChildCount();
if (sz > 0) {
UIComponent cc = null;
List cl = c.getChildren();
while (--sz >= 0) {
cc = (UIComponent) cl.get(sz);
if (cc.getAttributes().containsKey(MARK_DELETED)) {
cl.remove(sz);
}
}
}
Map facets = c.getFacets();
// remove any facets marked as deleted
if (facets.size() > 0) {
Set> col = facets.entrySet();
UIComponent fc;
Entry curEntry;
for (Iterator> itr = col.iterator(); itr.hasNext();) {
curEntry = itr.next();
fc = curEntry.getValue();
Map attrs = fc.getAttributes();
if (attrs.containsKey(MARK_DELETED)) {
itr.remove();
} else if (attrs.containsKey(IMPLICIT_PANEL) &&
!curEntry.getKey().equals(UIViewRoot.METADATA_FACET_NAME)) {
List implicitPanelChildren = fc.getChildren();
UIComponent innerChild;
for (Iterator innerItr = implicitPanelChildren.iterator();
innerItr.hasNext();) {
innerChild = innerItr.next();
if (innerChild.getAttributes().containsKey(MARK_DELETED)) {
innerItr.remove();
}
}
}
}
}
}
public static Tag setTagForComponent(FacesContext context, UIComponent c, Tag t) {
Map contextMap = context.getAttributes();
Map componentToTagMap;
componentToTagMap = (Map)
contextMap.get(COMPONENT_TO_TAG_MAP_NAME);
if (null == componentToTagMap) {
componentToTagMap = new HashMap();
contextMap.put(COMPONENT_TO_TAG_MAP_NAME, componentToTagMap);
}
return componentToTagMap.put((Integer) System.identityHashCode(c), t);
}
public static Tag getTagForComponent(FacesContext context, UIComponent c) {
Tag result = null;
Map contextMap = context.getAttributes();
Map componentToTagMap;
componentToTagMap = (Map)
contextMap.get(COMPONENT_TO_TAG_MAP_NAME);
if (null != componentToTagMap) {
result = componentToTagMap.get((Integer) System.identityHashCode(c));
}
return result;
}
/**
* A lighter-weight version of UIComponent's findChild.
*
* @param parent
* parent to start searching from
* @param id
* to match to
* @return UIComponent found or null
*/
public static UIComponent findChild(UIComponent parent, String id) {
int sz = parent.getChildCount();
if (sz > 0) {
UIComponent c = null;
List cl = parent.getChildren();
while (--sz >= 0) {
c = (UIComponent) cl.get(sz);
if (id.equals(c.getId())) {
return c;
}
}
}
return null;
}
/**
* By TagId, find Child
* @param parent
* @param id
* @return
*/
public static UIComponent findChildByTagId(UIComponent parent, String id) {
Iterator itr = parent.getFacetsAndChildren();
UIComponent c = null;
String cid = null;
while (itr.hasNext()) {
c = (UIComponent) itr.next();
cid = (String) c.getAttributes().get(MARK_CREATED);
if (id.equals(cid)) {
return c;
}
if (c instanceof UIPanel && c.getAttributes().containsKey(IMPLICIT_PANEL)) {
for (UIComponent c2 : c.getChildren()) {
cid = (String) c2.getAttributes().get(MARK_CREATED);
if (id.equals(cid)) {
return c2;
}
}
}
}
// int sz = parent.getChildCount();
// if (sz > 0) {
// UIComponent c = null;
// List cl = parent.getChildren();
// String cid = null;
// while (--sz >= 0) {
// c = (UIComponent) cl.get(sz);
// cid = (String) c.getAttributes().get(MARK_CREATED);
// if (id.equals(cid)) {
// return c;
// }
// }
// }
return null;
}
/**
* According to JSF 1.2 tag specs, this helper method will use the
* TagAttribute passed in determining the Locale intended.
*
* @param ctx
* FaceletContext to evaluate from
* @param attr
* TagAttribute representing a Locale
* @return Locale found
* @throws TagAttributeException
* if the Locale cannot be determined
*/
public static Locale getLocale(FaceletContext ctx, TagAttribute attr)
throws TagAttributeException {
Object obj = attr.getObject(ctx);
if (obj instanceof Locale) {
return (Locale) obj;
}
if (obj instanceof String) {
String s = (String) obj;
if (s.length() == 2) {
return new Locale(s);
}
if (s.length() == 5) {
return new Locale(s.substring(0, 2), s.substring(3, 5)
.toUpperCase());
}
if (s.length() >= 7) {
return new Locale(s.substring(0, 2), s.substring(3, 5)
.toUpperCase(), s.substring(6, s.length()));
}
throw new TagAttributeException(attr, "Invalid Locale Specified: "
+ s);
} else {
throw new TagAttributeException(attr,
"Attribute did not evaluate to a String or Locale: " + obj);
}
}
/**
* Tries to walk up the parent to find the UIViewRoot, if not found, then go
* to FaceletContext's FacesContext for the view root.
*
* @param ctx
* FaceletContext
* @param parent
* UIComponent to search from
* @return UIViewRoot instance for this evaluation
*/
public static UIViewRoot getViewRoot(FaceletContext ctx,
UIComponent parent) {
UIComponent c = parent;
do {
if (c instanceof UIViewRoot) {
return (UIViewRoot) c;
} else {
c = c.getParent();
}
} while (c != null);
return ctx.getFacesContext().getViewRoot();
}
/**
* Marks all direct children and Facets with an attribute for deletion.
*
* @see #finalizeForDeletion(UIComponent)
* @param c
* UIComponent to mark
*/
public static void markForDeletion(UIComponent c) {
// flag this component as deleted
c.getAttributes().put(MARK_DELETED, Boolean.TRUE);
// mark all children to be deleted
int sz = c.getChildCount();
if (sz > 0) {
UIComponent cc = null;
List cl = c.getChildren();
while (--sz >= 0) {
cc = (UIComponent) cl.get(sz);
if (cc.getAttributes().containsKey(MARK_CREATED)) {
cc.getAttributes().put(MARK_DELETED, Boolean.TRUE);
}
}
}
// mark all facets to be deleted
if (c.getFacets().size() > 0) {
Collection col = c.getFacets().values();
UIComponent fc;
for (Iterator itr = col.iterator(); itr.hasNext();) {
fc = (UIComponent) itr.next();
Map attrs = fc.getAttributes();
if (attrs.containsKey(MARK_CREATED)) {
attrs.put(MARK_DELETED, Boolean.TRUE);
} else if (attrs.containsKey(IMPLICIT_PANEL)) {
List implicitPanelChildren = fc.getChildren();
Map innerAttrs = null;
for (UIComponent cur : implicitPanelChildren) {
innerAttrs = cur.getAttributes();
if (innerAttrs.containsKey(MARK_CREATED)) {
innerAttrs.put(MARK_DELETED, Boolean.TRUE);
}
}
}
}
}
}
public static void encodeRecursive(FacesContext context,
UIComponent viewToRender) throws IOException, FacesException {
if (viewToRender.isRendered()) {
viewToRender.encodeBegin(context);
if (viewToRender.getRendersChildren()) {
viewToRender.encodeChildren(context);
} else if (viewToRender.getChildCount() > 0) {
Iterator kids = viewToRender.getChildren().iterator();
while (kids.hasNext()) {
UIComponent kid = (UIComponent) kids.next();
encodeRecursive(context, kid);
}
}
viewToRender.encodeEnd(context);
}
}
public static void removeTransient(UIComponent c) {
UIComponent d, e;
if (c.getChildCount() > 0) {
for (Iterator itr = c.getChildren().iterator(); itr.hasNext();) {
d = (UIComponent) itr.next();
if (d.getFacets().size() > 0) {
for (Iterator jtr = d.getFacets().values().iterator(); jtr
.hasNext();) {
e = (UIComponent) jtr.next();
if (e.isTransient()) {
jtr.remove();
} else {
removeTransient(e);
}
}
}
if (d.isTransient()) {
itr.remove();
} else {
removeTransient(d);
}
}
}
if (c.getFacets().size() > 0) {
for (Iterator itr = c.getFacets().values().iterator(); itr
.hasNext();) {
d = (UIComponent) itr.next();
if (d.isTransient()) {
itr.remove();
} else {
removeTransient(d);
}
}
}
}
/**
* Add the child component to the parent. If the parent is a facet,
* check to see whether the facet is already defined. If it is, wrap the existing component
* in a panel group, if it's not already, then add the child to the panel group. If the facet
* does not yet exist, make the child the facet.
*/
public static void addComponent(FaceletContext ctx, UIComponent parent, UIComponent child) {
String facetName = getFacetName(parent);
if (facetName == null) {
parent.getChildren().add(child);
} else {
UIComponent existing = parent.getFacets().get(facetName);
if (existing != null && existing != child) {
if (!(existing instanceof UIPanel)) {
// move existing component under a panel group
UIComponent panelGroup = ctx.getFacesContext().getApplication().createComponent(UIPanel.COMPONENT_TYPE);
String id = null;
panelGroup.setId(id = getViewRoot(ctx.getFacesContext(), parent).createUniqueId());
Map attrs = panelGroup.getAttributes();
attrs.put(ComponentSupport.IMPLICIT_PANEL, true);
panelGroup.getChildren().add(existing);
// the panel group becomes the facet
parent.getFacets().put(facetName, panelGroup);
existing = panelGroup;
}
if (existing.getAttributes().get(ComponentSupport.IMPLICIT_PANEL) != null) {
// we have a panel group, so add the new component to it
existing.getChildren().add(child);
} else {
parent.getFacets().put(facetName, child);
}
} else {
parent.getFacets().put(facetName, child);
}
}
}
public static String getFacetName(UIComponent parent) {
return (String) parent.getAttributes().get(FacetHandler.KEY);
}
public static boolean suppressViewModificationEvents(FacesContext ctx) {
// NO UIViewRoot means this was called during restore view -
// no need to suppress events at that time
UIViewRoot root = ctx.getViewRoot();
if (root != null) {
String viewId = root.getViewId();
if (viewId != null) {
StateContext stateCtx = StateContext.getStateContext(ctx);
return stateCtx
.partialStateSaving(ctx, viewId);
}
}
return false;
}
/**
* Specifies whether literal component Ids need to be make unique.
* This method is normally called by the tag handlers executing their child handlers
* repeatedly.
* @param ctx Facelet context
* @param needUniqueIds true if literal Ids have to be made unique, false otherwise
* @return the old value of the needUniqueIds flag
* @see getNeedUniqueIds
*/
public final static boolean setNeedUniqueIds(FaceletContext ctx,
boolean needUniqueIds) {
Boolean old = (Boolean)ctx.getAttribute(_UNIQUE_IDS_ATTR);
ctx.setAttribute(_UNIQUE_IDS_ATTR, Boolean.valueOf(needUniqueIds));
return Boolean.TRUE.equals(old);
}
/**
* Determines whether literal component Ids need to be make unique.
*
* @param ctx Facelet context
* @return true if the literal Ids need to be made unique, false otherwise
* @see setNeedUniqueIds
*/
public static boolean getNeedUniqueIds(FaceletContext ctx) {
Boolean val = (Boolean)ctx.getAttribute(_UNIQUE_IDS_ATTR);
return Boolean.TRUE.equals(val);
}
private static final String _UNIQUE_IDS_ATTR =
"com.sun.facelets.tag.jsf._needUniqueIds";
// --------------------------------------------------------- private classes
private static UIViewRoot getViewRoot(FacesContext ctx, UIComponent parent) {
if (parent instanceof UIViewRoot) {
return (UIViewRoot) parent;
}
UIViewRoot root = ctx.getViewRoot();
if (root != null) {
return root;
}
UIComponent c = parent.getParent();
while (c != null) {
if (c instanceof UIViewRoot) {
root = (UIViewRoot) c;
break;
} else {
c = c.getParent();
}
}
return root;
}
}