/*

  * 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 javax.faces.component;

 import java.util.Collection;

 import java.util.Map;

 import javax.faces.component.visit.VisitCallback;

 import javax.faces.component.visit.VisitContext;

 import javax.faces.component.visit.VisitResult;

 import javax.faces.context.ExternalContext;

 import javax.faces.context.FacesContext;

 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;

 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperty;

 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;

 /**

  * Base class for components that provide a new "namespace" for the ids of their

  * child components.

  * <p>

  * See the javadocs for interface NamingContainer for further details.

  * </p>

  */

 @JSFComponent(

         name="f:subview",

         bodyContent="JSP",

         tagClass="org.apache.myfaces.taglib.core.SubviewTag")

 @JSFJspProperty(name="id",required=true)

 public class UINamingContainer extends UIComponentBase implements NamingContainer, UniqueIdVendor

 {

     public static final String COMPONENT_TYPE = "javax.faces.NamingContainer";

     public static final String COMPONENT_FAMILY = "javax.faces.NamingContainer";

     public static final String SEPARATOR_CHAR_PARAM_NAME = "javax.faces.SEPARATOR_CHAR";

     /**

      * Construct an instance of the UINamingContainer.

      */

     public UINamingContainer()

     {

         setRendererType(null);

     }

     @Override

     public String getFamily()

     {

         return COMPONENT_FAMILY;

     }

     /**

      * 

      * {@inheritDoc}

      * 

      * @since 2.0

      */

     public String createUniqueId(FacesContext context, String seed)

     {

         StringBuilder bld = _getSharedStringBuilder(context);

         // Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX,

         // and will be unique within this UIViewRoot.

         if(seed==null)

         {

             Integer uniqueIdCounter = (Integer) getStateHelper().get(PropertyKeys.uniqueIdCounter);

             uniqueIdCounter = (uniqueIdCounter == null) ? 0 : uniqueIdCounter;

             getStateHelper().put(PropertyKeys.uniqueIdCounter, (uniqueIdCounter+1));

             return bld.append(UIViewRoot.UNIQUE_ID_PREFIX).append(uniqueIdCounter).toString();    

         }

         // Optionally, a unique seed value can be supplied by component creators

         // which should be included in the generated unique id.

         else

         {

             return bld.append(UIViewRoot.UNIQUE_ID_PREFIX).append(seed).toString();

         }

     }

     /**

      * 

      * @param context

      * @return

      * 

      * @since 2.0

      */

     @SuppressWarnings("deprecation")

     public static char getSeparatorChar(FacesContext context)

     {

         Map<Object, Object> attributes = context.getAttributes();

         Character separatorChar = (Character) attributes.get(SEPARATOR_CHAR_PARAM_NAME);

         if (separatorChar == null)

         { // not cached yet for this request

             ExternalContext eContext = context.getExternalContext();

             // The implementation must determine if there is a <context-param> with the value given by the 

             // value of the symbolic constant SEPARATOR_CHAR_PARAM_NAME

             String param = eContext.getInitParameter(SEPARATOR_CHAR_PARAM_NAME);

             if (param == null || param.length() == 0)

             {

                 // Otherwise, the value of the symbolic constant NamingContainer.SEPARATOR_CHAR must be returned.

                 separatorChar = NamingContainer.SEPARATOR_CHAR;

             }

             else

             {

                 // If there is a value for this param, the first character of the value must be returned from 

                 // this method

                 separatorChar = param.charAt(0);

             }

             // Cache it under standard name

             attributes.put(SEPARATOR_CHAR_PARAM_NAME, separatorChar);

         }

         return separatorChar.charValue();

     }

     @JSFProperty(deferredValueType="java.lang.Boolean")

     @Override

     public boolean isRendered()

     {

         return super.isRendered();

     }

     @Override

     public boolean visitTree(VisitContext context, VisitCallback callback)

     {

         pushComponentToEL(context.getFacesContext(), this);

         boolean isCachedFacesContext = isCachedFacesContext();

         try

         {

             if (!isCachedFacesContext)

             {

                 setCachedFacesContext(context.getFacesContext());

             }

             if (!isVisitable(context))

             {

                 return false;

             }

             VisitResult res = context.invokeVisitCallback(this, callback);

             switch (res)

             {

                 //we are done nothing has to be processed anymore

                 case COMPLETE:

                     return true;

                 case REJECT:

                     return false;

                 //accept

                 default:

                     // Take advantage of the fact this is a NamingContainer

                     // and we can know if there are ids to visit inside it

                     Collection<String> subtreeIdsToVisit = context.getSubtreeIdsToVisit(this);

                     if (subtreeIdsToVisit != null && !subtreeIdsToVisit.isEmpty())

                     {

                         if (getFacetCount() > 0)

                         {

                             for (UIComponent facet : getFacets().values())

                             {

                                 if (facet.visitTree(context, callback))

                                 {

                                     return true;

                                 }

                             }

                         }

                         for (int i = 0, childCount = getChildCount(); i < childCount; i++)

                         {

                             UIComponent child = getChildren().get(i);

                             if (child.visitTree(context, callback))

                             {

                                 return true;

                             }

                         }

                     }

                     return false;

             }

         }

         finally

         {

             //all components must call popComponentFromEl after visiting is finished

             popComponentFromEL(context.getFacesContext());

             if (!isCachedFacesContext)

             {

                 setCachedFacesContext(null);

             }

         }

     }

     enum PropertyKeys

     {

         uniqueIdCounter

     }

 }