Seeking Review: remname composite:insertChildren to composite:renderUsingPageChildren

From: Ed Burns <Ed.Burns_at_Sun.COM>
Date: Wed, 14 Jan 2009 09:29:28 -0800

Issue: 273-CompositeComponent

Rename <composite:insertChildren /> to <composite:renderUsingPageChildren />

SECTION: Modified Files
----------------------------
M jsf-api/doc/standard-html-renderkit-base.xml
M jsf-api/doc/standard-html-renderkit.xml

- rename

- <renderer-type>javax.faces.ConsumingPageCompositeChildren</renderer-type>
+ <renderer-type>javax.faces.UsingPageChildren</renderer-type>

M jsf-ri/conf/share/composite.tld

- fix documentation to reflect new renderer name, above.

- Rename <composite:insertChildren /> to <composite:renderUsingPageChildren />

M jsf-ri/src/com/sun/faces/standard-html-renderkit-impl.xml

- Rename impl class for insertChildren renderer:

- <output-consuming-page-composite-children-renderer-class>
- com.sun.faces.renderkit.html_basic.ConsumingPageCompositeChildrenRenderer
- </output-consuming-page-composite-children-renderer-class>
+ <output-using-page-children-renderer-class>
+ com.sun.faces.renderkit.html_basic.UsingPageChildrenRenderer
+ </output-using-page-children-renderer-class>

M jsf-ri/src/com/sun/faces/facelets/tag/composite/CompositeLibrary.java

- change tag name and renderer-type

- this.addComponent("insertChildren", "javax.faces.Output",
- "javax.faces.ConsumingPageCompositeChildren",
- InsertChildrenHandler.class);
+ this.addComponent("renderUsingPageChildren", "javax.faces.Output",
+ "javax.faces.UsingPageChildren",
+ RenderUsingPageChildrenHandler.class);

M jsf-demo/ezcomp00/src/main/webapp/resources/ezcomp/loginPanel.xhtml
M jsf-demo/ezcomp01/src/main/webapp/resources/ezcomp/loginPanel.xhtml

- rename usages of tag

M jsf-demo/ezcomp01/pom.xml
M jsf-demo/ezcomp00/pom.xml

- updae dependencies

A + jsf-ri/src/com/sun/faces/facelets/tag/composite/RenderUsingPageChildrenHandler.java
A + jsf-ri/src/com/sun/faces/renderkit/html_basic/UsingPageChildrenRenderer.java

D jsf-ri/src/com/sun/faces/facelets/tag/composite/InsertChildrenHandler.java
D jsf-ri/src/com/sun/faces/renderkit/html_basic/ConsumingPageCompositeChildrenRenderer.java

- Rename classes

SECTION: Diffs
----------------------------
Index: jsf-api/doc/standard-html-renderkit-base.xml
===================================================================
--- jsf-api/doc/standard-html-renderkit-base.xml (revision 6204)
+++ jsf-api/doc/standard-html-renderkit-base.xml (working copy)
-2686,9 +2686,9 @@
</div>]]></description>

             <component-family>javax.faces.Output</component-family>
- <renderer-type>javax.faces.ConsumingPageCompositeChildren</renderer-type>
+ <renderer-type>javax.faces.UsingPageChildren</renderer-type>
             <renderer-class>
- <xi:include href="standard-html-renderkit-impl.xml" xpointer="xpointer(/root/output-consuming-page-composite-children-renderer-class/text())"/>
+ <xi:include href="standard-html-renderkit-impl.xml" xpointer="xpointer(/root/output-using-page-children-renderer-class/text())"/>
             </renderer-class>
             <renderer-extension>
                <jsp-ignore>true</jsp-ignore>
Index: jsf-api/doc/standard-html-renderkit.xml
===================================================================
--- jsf-api/doc/standard-html-renderkit.xml (revision 6204)
+++ jsf-api/doc/standard-html-renderkit.xml (working copy)
-36,7 +36,7 @@
-->

<faces-config xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xi="http://www.w3.org/2001/XInclude" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd" version="2.0">
- 
+
   <component>
     <component-type>javax.faces.Column</component-type>
     <component-class>javax.faces.component.UIColumn</component-class>
-373,7 +373,7 @@
         <method-signature>
                 void actionListener(javax.faces.event.ActionEvent)
             </method-signature>
- 
+
   <component>
     <description><![CDATA[<p>Represents a column that will be rendered
       in an HTML <code>table</code> element.</p>]]></description>
-4382,7 +4382,7 @@
         <method-signature>
                 void actionListener(javax.faces.event.ActionEvent)
             </method-signature>
- 
+
   <render-kit>
     <description><![CDATA[
      The standard HTML RenderKit. Please see the spec for additional
-26617,9 +26617,9 @@

</div>]]></description>
       <component-family>javax.faces.Output</component-family>
- <renderer-type>javax.faces.ConsumingPageCompositeChildren</renderer-type>
+ <renderer-type>javax.faces.UsingPageChildren</renderer-type>
       <renderer-class>
- com.sun.faces.renderkit.html_basic.ConsumingPageCompositeChildrenRenderer
+ com.sun.faces.renderkit.html_basic.UsingPageChildrenRenderer
     </renderer-class>
       <renderer-extension>
         <jsp-ignore>true</jsp-ignore>
Index: jsf-ri/conf/share/composite.tld
===================================================================
--- jsf-ri/conf/share/composite.tld (revision 6204)
+++ jsf-ri/conf/share/composite.tld (working copy)
-986,7 +986,7 @@
             <p>The implementation of this tag handler must insert a
             component with <code>component-type</code>
             <code>javax.faces.Output</code> and <code>renderer-type</code>
- <code>javax.faces.ConsumingPageCompositeChildren</code> as a
+ <code>javax.faces.CompositeFacet</code> as a
             child at this point in the component tree.</p>

<p>The implementation of this tag handler must store an attribute into
-1035,19 +1035,24 @@
<p>This element is used in the
<code><composite:implementation></code> section. Any child
components or template text within the composite component tag in the
-using page will be inserted into the rendered output at this point
-in the composite component PDL page.</p>
+using page will be inserted into the rendered output at this point in
+the composite component PDL page. The normal use-case for this element
+is to have only one occurrence within the
+<code><composite:implementation></code> section. Inserting
+multiple occurrences may cause duplicate id errors. The results are
+undefined if there are multiple occurrences of this element in the
+<code><composite:implementation></code> section.</p>

             <p>The implementation of this tag handler must insert a
             component with <code>component-type</code>
             <code>javax.faces.Output</code> and <code>renderer-type</code>
- <code>javax.faces.ConsumingPageCompositeChildren</code> as a
+ <code>javax.faces.UsingPageChildren</code> as a
             child at this point in the component tree.</p>

</div>]]>
         </description>
         <name>
- insertChildren
+ renderUsingPageChildren
         </name>
         <body-content>
             JSP
Index: jsf-ri/src/com/sun/faces/standard-html-renderkit-impl.xml
===================================================================
--- jsf-ri/src/com/sun/faces/standard-html-renderkit-impl.xml (revision 6204)
+++ jsf-ri/src/com/sun/faces/standard-html-renderkit-impl.xml (working copy)
-92,9 +92,9 @@
     <naming-container-composite-renderer-class>
         com.sun.faces.renderkit.html_basic.CompositeRenderer
     </naming-container-composite-renderer-class>
- <output-consuming-page-composite-children-renderer-class>
- com.sun.faces.renderkit.html_basic.ConsumingPageCompositeChildrenRenderer
- </output-consuming-page-composite-children-renderer-class>
+ <output-using-page-children-renderer-class>
+ com.sun.faces.renderkit.html_basic.UsingPageChildrenRenderer
+ </output-using-page-children-renderer-class>
     <output-composite-facet-renderer-class>
         com.sun.faces.renderkit.html_basic.CompositeFacetRenderer
     </output-composite-facet-renderer-class>
Index: jsf-ri/src/com/sun/faces/facelets/tag/composite/InsertChildrenHandler.java
===================================================================
--- jsf-ri/src/com/sun/faces/facelets/tag/composite/InsertChildrenHandler.java (revision 6204)
+++ jsf-ri/src/com/sun/faces/facelets/tag/composite/InsertChildrenHandler.java (working copy)
-1,64 +0,0 @@
-/*
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
- *
- * Copyright 1997-2008 Sun Microsystems, Inc. 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.html
- * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
- * Sun designates this particular file as subject to the "Classpath" exception
- * as provided by Sun in the GPL Version 2 section of the License file that
- * accompanied this code. If applicable, add the following below the License
- * Header, with the fields enclosed by brackets [] replaced by your own
- * identifying information: "Portions Copyrighted [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:
- *
- * 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.composite;
-
-import com.sun.faces.facelets.tag.jsf.ComponentConfig;
-import com.sun.faces.facelets.tag.jsf.ComponentHandler;
-
-
-public class InsertChildrenHandler extends ComponentHandler {
-
- public InsertChildrenHandler(ComponentConfig config) {
- super(config);
- }
-
-}
Index: jsf-ri/src/com/sun/faces/facelets/tag/composite/CompositeLibrary.java
===================================================================
--- jsf-ri/src/com/sun/faces/facelets/tag/composite/CompositeLibrary.java (revision 6204)
+++ jsf-ri/src/com/sun/faces/facelets/tag/composite/CompositeLibrary.java (working copy)
-85,9 +85,9 @@
         this.addTagHandler("implementation", ImplementationHandler.class);

         // Things that go inside of the implementation section
- this.addComponent("insertChildren", "javax.faces.Output",
- "javax.faces.ConsumingPageCompositeChildren",
- InsertChildrenHandler.class);
+ this.addComponent("renderUsingPageChildren", "javax.faces.Output",
+ "javax.faces.UsingPageChildren",
+ RenderUsingPageChildrenHandler.class);
         this.addComponent("insertFacet", "javax.faces.Output",
                 "javax.faces.CompositeFacet", InsertFacetHandler.class);
     }
Index: jsf-ri/src/com/sun/faces/facelets/tag/composite/RenderUsingPageChildrenHandler.java
===================================================================
--- jsf-ri/src/com/sun/faces/facelets/tag/composite/RenderUsingPageChildrenHandler.java (revision 6204)
+++ jsf-ri/src/com/sun/faces/facelets/tag/composite/RenderUsingPageChildrenHandler.java (working copy)
-55,9 +55,9 @@
import com.sun.faces.facelets.tag.jsf.ComponentHandler;

-public class InsertChildrenHandler extends ComponentHandler {
+public class RenderUsingPageChildrenHandler extends ComponentHandler {

- public InsertChildrenHandler(ComponentConfig config) {
+ public RenderUsingPageChildrenHandler(ComponentConfig config) {
         super(config);
     }

Index: jsf-ri/src/com/sun/faces/renderkit/html_basic/ConsumingPageCompositeChildrenRenderer.java
===================================================================
--- jsf-ri/src/com/sun/faces/renderkit/html_basic/ConsumingPageCompositeChildrenRenderer.java (revision 6204)
+++ jsf-ri/src/com/sun/faces/renderkit/html_basic/ConsumingPageCompositeChildrenRenderer.java (working copy)
-1,93 +0,0 @@
-/*
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
- *
- * Copyright 1997-2008 Sun Microsystems, Inc. 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.html
- * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
- * Sun designates this particular file as subject to the "Classpath" exception
- * as provided by Sun in the GPL Version 2 section of the License file that
- * accompanied this code. If applicable, add the following below the License
- * Header, with the fields enclosed by brackets [] replaced by your own
- * identifying information: "Portions Copyrighted [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.
- */
-
-
-package com.sun.faces.renderkit.html_basic;
-
-import com.sun.faces.util.FacesLogger;
-import java.io.IOException;
-import java.util.List;
-import java.util.logging.Logger;
-import javax.faces.component.UIComponent;
-import javax.faces.context.FacesContext;
-import javax.faces.render.Renderer;
-
-/**
- * RELEASE_PENDING (rlubke,driscoll) docs
- */
-public class ConsumingPageCompositeChildrenRenderer extends Renderer {
-
- // Log instance for this class
- protected static final Logger logger = FacesLogger.RENDERKIT.getLogger();
-
- @Override
- public void encodeBegin(FacesContext context, UIComponent component) throws IOException {
-
- }
-
- @Override
- public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
- UIComponent currentCompositeComponent = UIComponent.getCurrentCompositeComponent(context);
- if (null != currentCompositeComponent) {
-
- // It must be true that each of the children of the composite
- // component must come from the consuming page, and therefore
- // are to be rendered right now.
- List<UIComponent> children = currentCompositeComponent.getChildren();
- for (UIComponent cur : children) {
- cur.encodeAll(context);
- }
- }
- else {
- throw new IOException("Unable to find composite component parent for component " +
- component.getId());
- }
- }
-
- @Override
- public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
-
- }
-
- @Override
- public boolean getRendersChildren() {
- return true;
- }
-
-
-
-
-}
Index: jsf-ri/src/com/sun/faces/renderkit/html_basic/UsingPageChildrenRenderer.java
===================================================================
--- jsf-ri/src/com/sun/faces/renderkit/html_basic/UsingPageChildrenRenderer.java (revision 6204)
+++ jsf-ri/src/com/sun/faces/renderkit/html_basic/UsingPageChildrenRenderer.java (working copy)
-48,7 +48,7 @@
/**
  * RELEASE_PENDING (rlubke,driscoll) docs
  */
-public class ConsumingPageCompositeChildrenRenderer extends Renderer {
+public class UsingPageChildrenRenderer extends Renderer {

     // Log instance for this class
     protected static final Logger logger = FacesLogger.RENDERKIT.getLogger();
Index: jsf-demo/ezcomp00/src/main/webapp/resources/ezcomp/loginPanel.xhtml
===================================================================
--- jsf-demo/ezcomp00/src/main/webapp/resources/ezcomp/loginPanel.xhtml (revision 6204)
+++ jsf-demo/ezcomp00/src/main/webapp/resources/ezcomp/loginPanel.xhtml (working copy)
-129,7 +129,7 @@

      <p>This is the login panel footer</p>

- <composite:insertChildren />
+ <composite:renderUsingPageChildren />

       </td>

Index: jsf-demo/ezcomp00/pom.xml
===================================================================
--- jsf-demo/ezcomp00/pom.xml (revision 6204)
+++ jsf-demo/ezcomp00/pom.xml (working copy)
-104,9 +104,9 @@

   <dependencies>
     <dependency>
- <groupId>javax.faces</groupId>
+ <groupId>com.sun.faces</groupId>
       <artifactId>jsf-api</artifactId>
- <version>2.0-SNAPSHOT</version>
+ <version>2.0.0-SNAPSHOT</version>
       <scope>provided</scope>
     </dependency>
   </dependencies>
Index: jsf-demo/ezcomp01/src/main/webapp/resources/ezcomp/loginPanel.xhtml
===================================================================
--- jsf-demo/ezcomp01/src/main/webapp/resources/ezcomp/loginPanel.xhtml (revision 6204)
+++ jsf-demo/ezcomp01/src/main/webapp/resources/ezcomp/loginPanel.xhtml (working copy)
-113,7 +113,7 @@

      <p>This is the login panel footer</p>

- <composite:insertChildren />
+ <composite:renderUsingPageChildren />

     </ui:define>

Index: jsf-demo/ezcomp01/pom.xml
===================================================================
--- jsf-demo/ezcomp01/pom.xml (revision 6204)
+++ jsf-demo/ezcomp01/pom.xml (working copy)
-104,9 +104,9 @@

   <dependencies>
     <dependency>
- <groupId>javax.faces</groupId>
+ <groupId>com.sun.faces</groupId>
       <artifactId>jsf-api</artifactId>
- <version>2.0-SNAPSHOT</version>
+ <version>2.0.0-SNAPSHOT</version>
       <scope>provided</scope>
     </dependency>
   </dependencies>

SECTION: New Files
----------------------------
SEE ATTACHMENTS

-- 
| ed.burns_at_sun.com  | office: 408 884 9519 OR x31640
| homepage:         | http://ridingthecrest.com/