org.sakaiproject.jsf2.renderer.ToolBarRenderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsf2-widgets Show documentation

This is the Maven project for the custom JSF 2 widgets. The widgets and the resources projects are closely tied together. These widgets will be deployed as a jar file containing Sakai JSF 2 widgets (components). Web applications can include this jar in order to use the Sakai JSF 2 widgets in a JSF tool.

There is a newer version: 23.3

Show newest version

/**********************************************************************************
Copyright (c) 2018 Apereo Foundation

Licensed under the Educational Community 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://opensource.org/licenses/ecl2

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.sakaiproject.jsf2.renderer;

import java.io.IOException;
import java.util.List;

import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.render.Renderer;

import org.sakaiproject.jsf2.util.RendererUtil;

/**
 * This does not render children, but can deal with children by surrounding them in a comment.
 *
 */
public class ToolBarRenderer extends Renderer
{
    /**
     * This component renders its children
     * @return true
     */
    public boolean getRendersChildren()
    {
        return true;
    }

    public boolean supportsComponentType(UIComponent component)
    {
        return (component instanceof org.sakaiproject.jsf2.component.ToolBarComponent);
    }

    public void encodeBegin(FacesContext context, UIComponent component) throws IOException
    {
        if(!component.isRendered()){
            //tool_bar tag is not to be rendered, return now
            return;
        }
        ResponseWriter writer = context.getResponseWriter();
        writer.write("");
    }

    /**
     * We put all our processing in the encodeChildren method
     * @param context
     * @param component
     * @throws IOException
     */
    public void encodeChildren(FacesContext context, UIComponent component) throws IOException
    {
        if (!component.isRendered())
        {
            return;
        }

        String clientId = null;

        if (component.getId() != null && !component.getId().startsWith(UIViewRoot.UNIQUE_ID_PREFIX))
        {
            clientId = component.getClientId(context);
        }

        ResponseWriter writer = context.getResponseWriter();

        if (clientId != null)
        {
            writer.startElement("ul", component);
            //writer.append(" class=\"jsfToolbar\" "); // we don't seem to get here
        }

        @SuppressWarnings("unchecked")
        List children = component.getChildren();

        // this is a special separator attribute, not supported by UIData
        String separator = (String) RendererUtil.getAttribute(context, component, "separator");
        if (separator == null)
        {
            separator = "";
        }

        boolean first = true;
        boolean foundCurrent = false;
        for( UIComponent child : children )
        {
            // should instead leave the span open, and the item should then add class and aria attributes
            // depending on the item is (disabled or not) and then close
            if (child.isRendered()) {
                if (!first)
                {
                    writer.write("");
                }
                else
                {
                    writer.write("
");
                }
                // SAK-23062 improve JSF options menu
                boolean current = false;
                if (!foundCurrent) {
                    // check for the "current" attribute on the custom tag, mark that item as current if it set to true
                    boolean hasCurrentIndicated = (child.getAttributes().get("current") != null); // NOTE: child.getAttributes().containsKey("current") will NOT work here
                    current = (hasCurrentIndicated && ((Boolean)child.getAttributes().get("current")));
                    /* this breaks too many other things
                     * if (!hasCurrentIndicated && !"javax.faces.Link".equals(child.getRendererType())) {
                     * // basically - if it is not a link, it is probably the current item
                     * current = true;
                     * }
                     */
                }
                if (current) {
                    foundCurrent = true;
                    writer.write("");
                } else {
                    writer.write("");
                }
                RendererUtil.encodeRecursive(context, child);
                writer.write(" ");
                first = false;
            }
        }
        if (clientId != null)
        {
             writer.endElement("ul");
        }
    }

    public void encodeEnd(FacesContext context, UIComponent component) throws IOException
    {
        ResponseWriter writer = context.getResponseWriter();
        writer.write("");
    }
}