AbstractMenuFacet.java

/**
 * JBoss, Home of Professional Open Source
 * Copyright , Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.richfaces.bootstrap.semantic;

import javax.faces.component.UIComponent;

import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.JsfComponent;
import org.richfaces.cdk.annotations.Tag;

/**
 * Base class for the menuFacet component.
 *
 * @author <a href="http://pauldijou.fr">Paul Dijou</a>
 */
@JsfComponent(
        type = AbstractMenuFacet.COMPONENT_TYPE,
        family = AbstractMenuFacet.COMPONENT_FAMILY,
        tag = @Tag(name="menuFacet"))
public abstract class AbstractMenuFacet extends AbstractSemanticComponentBase<RenderMenuFacetCapable> {
    public static final String COMPONENT_FAMILY = "org.richfaces.bootstrap.MenuFacet";
    public static final String COMPONENT_TYPE = "org.richfaces.bootstrap.MenuFacet";
    public static final String ACTIVE_ATTRIBUTE_NAME = "active";

    @Attribute
    public abstract String getLabel();
    
    @Attribute
    public abstract boolean isActive();
    
    public int getLevel() {
        return getLevel(null);
    }
    
    public int getLevel(String stopParentFamily) {
        UIComponent parent = this.getParent();
        int level = 0;
        
        while(parent != null) {
            if(parent instanceof AbstractMenuFacet) {
                ++level;
            }
            
            if(stopParentFamily != null && stopParentFamily.equals(parent.getFamily())) {
                parent = null;
            }
            else {
                parent = parent.getParent();
            }
        }
        
        return level;
    }
    
    @Override
    public Class<RenderMenuFacetCapable> getRendererCapability() {
        return RenderMenuFacetCapable.class;
    }
    
    @Override
    public String getRendererType(RenderMenuFacetCapable container) {
        return container.getMenuFacetRendererType();
    }
}