org.primefaces.component.hotkey.HotkeyRenderer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation

PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.

There is a newer version: 14.0.0-RC3

Show newest version

/**
 * Copyright 2009-2018 PrimeTek.
 *
 * 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 org.primefaces.component.hotkey;

import java.io.IOException;
import java.util.Map;

import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.event.ActionEvent;

import org.primefaces.context.RequestContext;
import org.primefaces.renderkit.CoreRenderer;
import org.primefaces.util.AjaxRequestBuilder;
import org.primefaces.util.ComponentTraversalUtils;

public class HotkeyRenderer extends CoreRenderer {

    @Override
    public void decode(FacesContext facesContext, UIComponent component) {
        Map params = facesContext.getExternalContext().getRequestParameterMap();
        Hotkey hotkey = (Hotkey) component;

        if (params.containsKey(hotkey.getClientId(facesContext))) {
            hotkey.queueEvent(new ActionEvent(hotkey));
        }
    }

    @Override
    public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
        ResponseWriter writer = context.getResponseWriter();
        Hotkey hotkey = (Hotkey) component;
        String clientId = hotkey.getClientId(context);

        writer.startElement("script", null);
        writer.writeAttribute("type", "text/javascript", null);

        writer.write("$(function() {");
        writer.write("$(document).bind('keydown', '" + hotkey.getBind() + "', function(){");

        if (hotkey.isAjaxified()) {
            UIComponent form = ComponentTraversalUtils.closestForm(context, hotkey);

            if (form == null) {
                throw new FacesException("Hotkey '" + clientId + "' needs to be enclosed in a form when ajax mode is enabled");
            }

            AjaxRequestBuilder builder = RequestContext.getCurrentInstance(context).getAjaxRequestBuilder();

            String request = builder.init()
                    .source(clientId)
                    .form(form.getClientId(context))
                    .process(component, hotkey.getProcess())
                    .update(component, hotkey.getUpdate())
                    .async(hotkey.isAsync())
                    .global(hotkey.isGlobal())
                    .delay(hotkey.getDelay())
                    .timeout(hotkey.getTimeout())
                    .partialSubmit(hotkey.isPartialSubmit(), hotkey.isPartialSubmitSet(), hotkey.getPartialSubmitFilter())
                    .resetValues(hotkey.isResetValues(), hotkey.isResetValuesSet())
                    .ignoreAutoUpdate(hotkey.isIgnoreAutoUpdate())
                    .onstart(hotkey.getOnstart())
                    .onerror(hotkey.getOnerror())
                    .onsuccess(hotkey.getOnsuccess())
                    .oncomplete(hotkey.getOncomplete())
                    .params(hotkey)
                    .build();

            writer.write(request);
        }
        else {
            writer.write(hotkey.getHandler());
        }

        writer.write(";return false;});});");

        writer.endElement("script");
    }
}