org.apache.myfaces.commons.util.ComponentUtils Maven / Gradle / Ivy

Go to download
/*
 * 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.commons.util;

import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;

/**
 * 
 * @since 1.0.2
 */
public class ComponentUtils
{

    /**
     * Return the parent NamingContainer of the component passed as argument.
     * 
     * @param component
     * @return
     */
    public static UIComponent findParentNamingContainer(UIComponent component)
    {
        return findParentNamingContainer(component, true);
    }

    /**
     * Return the parent NamingContainer of the component passed as argument.
     * 
     * @param component
     * @param returnRootIfNotFound
     * @return
     */
    public static UIComponent findParentNamingContainer(UIComponent component, boolean returnRootIfNotFound)
    {
        UIComponent parent = component.getParent();
        if (returnRootIfNotFound && parent == null)
        {
            return component;
        }
        while (parent != null)
        {
            if (parent instanceof NamingContainer)
                return parent;
            if (returnRootIfNotFound)
            {
                UIComponent nextParent = parent.getParent();
                if (nextParent == null)
                {
                    return parent; // Root
                }
                parent = nextParent;
            }
            else
            {
                parent = parent.getParent();
            }
        }
        return null;
    }
}