org.primefaces.extensions.component.remotecommand.RemoteCommand Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011-2015 PrimeFaces Extensions
 *
 * 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.
 *
 * $Id$
 */

package org.primefaces.extensions.component.remotecommand;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.el.MethodExpression;
import javax.faces.application.ResourceDependencies;
import javax.faces.application.ResourceDependency;
import javax.faces.component.UICommand;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.ActionEvent;
import javax.faces.event.ActionListener;
import javax.faces.event.FacesEvent;
import javax.faces.event.FacesListener;

import org.primefaces.component.api.AjaxSource;
import org.primefaces.extensions.component.base.AbstractParameter;
import org.primefaces.extensions.component.parameters.AssignableParameter;
import org.primefaces.extensions.component.parameters.MethodParameter;

/**
 * Component class for the RemoteCommand component.
 *
 * @author  Thomas Andraschko / last modified by $Author$
 * @version $Revision$
 * @since   0.2
 */
@ResourceDependencies({
		@ResourceDependency(library = "primefaces", name = "jquery/jquery.js"),
        @ResourceDependency(library = "primefaces", name = "jquery/jquery-plugins.js"),
		@ResourceDependency(library = "primefaces", name = "core.js"),
        @ResourceDependency(library = "primefaces-extensions", name = "primefaces-extensions.js")
})
public class RemoteCommand extends UICommand implements AjaxSource {

	public static final String COMPONENT_TYPE = "org.primefaces.extensions.component.RemoteCommand";
	public static final String COMPONENT_FAMILY = "org.primefaces.extensions.component";
	private static final String DEFAULT_RENDERER = "org.primefaces.extensions.component.RemoteCommandRenderer";

	/**
	 * Properties that are tracked by state saving.
	 *
	 * @author  Thomas Andraschko / last modified by $Author$
	 * @version $Revision$
	 */
	protected enum PropertyKeys {

		name,
		update,
		process,
		onstart,
		oncomplete,
		onerror,
		onsuccess,
		global,
		async,
		partialSubmit,
		action,
		autoRun,
		actionListener,
		resetValues,
		ignoreAutoUpdate,
        delay,
        timeout,
        partialSubmitFilter,
        form;

		private String toString;

		PropertyKeys(final String toString) {
			this.toString = toString;
		}

		PropertyKeys() {
		}

		@Override
		public String toString() {
			return ((this.toString != null) ? this.toString : super.toString());
		}
	}

	public RemoteCommand() {
		setRendererType(DEFAULT_RENDERER);
	}

	@Override
	public String getFamily() {
		return COMPONENT_FAMILY;
	}

	public String getName() {
		return (String) getStateHelper().eval(PropertyKeys.name, null);
	}

	public void setName(final String name) {
		getStateHelper().put(PropertyKeys.name, name);
	}

	public String getUpdate() {
		return (String) getStateHelper().eval(PropertyKeys.update, null);
	}

	public void setUpdate(final String update) {
		getStateHelper().put(PropertyKeys.update, update);
	}

	public String getProcess() {
		return (String) getStateHelper().eval(PropertyKeys.process, null);
	}

	public void setProcess(final String process) {
		getStateHelper().put(PropertyKeys.process, process);
	}

	public String getOnstart() {
		return (String) getStateHelper().eval(PropertyKeys.onstart, null);
	}

	public void setOnstart(final String onstart) {
		getStateHelper().put(PropertyKeys.onstart, onstart);
	}

	public String getOncomplete() {
		return (String) getStateHelper().eval(PropertyKeys.oncomplete, null);
	}

	public void setOncomplete(final String oncomplete) {
		getStateHelper().put(PropertyKeys.oncomplete, oncomplete);
	}

	public String getOnerror() {
		return (String) getStateHelper().eval(PropertyKeys.onerror, null);
	}

	public void setOnerror(final String onerror) {
		getStateHelper().put(PropertyKeys.onerror, onerror);
	}

	public String getOnsuccess() {
		return (String) getStateHelper().eval(PropertyKeys.onsuccess, null);
	}

	public void setOnsuccess(final String onsuccess) {
		getStateHelper().put(PropertyKeys.onsuccess, onsuccess);
	}

	public boolean isGlobal() {
		return (Boolean) getStateHelper().eval(PropertyKeys.global, true);
	}

	public void setGlobal(final boolean global) {
		getStateHelper().put(PropertyKeys.global, global);
	}

	public boolean isAsync() {
		return (Boolean) getStateHelper().eval(PropertyKeys.async, false);
	}

	public void setAsync(final boolean async) {
		getStateHelper().put(PropertyKeys.async, async);
	}

	public boolean isPartialSubmit() {
		return (Boolean) getStateHelper().eval(PropertyKeys.partialSubmit, false);
	}

	public void setPartialSubmit(final boolean partialSubmit) {
		getStateHelper().put(PropertyKeys.partialSubmit, partialSubmit);
	}

	public boolean isAutoRun() {
		return (Boolean) getStateHelper().eval(PropertyKeys.autoRun, false);
	}

	public void setAutoRun(final boolean autoRun) {
		getStateHelper().put(PropertyKeys.autoRun, autoRun);
	}

	public MethodExpression getActionListenerMethodExpression() {
		return (MethodExpression) getStateHelper().get(PropertyKeys.actionListener);
	}

	public void setActionListenerMethodExpression(final MethodExpression actionListener) {
		getStateHelper().put(PropertyKeys.actionListener, actionListener);
	}

	public boolean isPartialSubmitSet() {
		return (getStateHelper().get(PropertyKeys.partialSubmit) != null) || (this.getValueExpression("partialSubmit") != null);
	}

	public boolean isResetValues() {
		return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.resetValues, false);
	}

	public void setResetValues(boolean resetValues) {
		getStateHelper().put(PropertyKeys.resetValues, resetValues);
	}

	public boolean isIgnoreAutoUpdate() {
		return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.ignoreAutoUpdate, false);
	}

	public void setIgnoreAutoUpdate(boolean ignoreAutoUpdate) {
		getStateHelper().put(PropertyKeys.ignoreAutoUpdate, ignoreAutoUpdate);
	}

        public boolean isResetValuesSet() {
            return (getStateHelper().get(PropertyKeys.resetValues) != null) || (this.getValueExpression("resetValues") != null);
        }

	public java.lang.String getDelay() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.delay, null);
	}

	public void setDelay(java.lang.String delay) {
		getStateHelper().put(PropertyKeys.delay, delay);
	}

	public int getTimeout() {
		return (java.lang.Integer) getStateHelper().eval(PropertyKeys.timeout, 0);
	}

	public void setTimeout(int timeout) {
		getStateHelper().put(PropertyKeys.timeout, timeout);
	}

	public java.lang.String getPartialSubmitFilter() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.partialSubmitFilter, null);
	}
	public void setPartialSubmitFilter(java.lang.String _partialSubmitFilter) {
		getStateHelper().put(PropertyKeys.partialSubmitFilter, _partialSubmitFilter);
	}

	public java.lang.String getForm() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.form, null);
	}
	public void setForm(java.lang.String _form) {
		getStateHelper().put(PropertyKeys.form, _form);
	}

	@Override
	public void broadcast(final FacesEvent event) throws AbortProcessingException {
		for (FacesListener listener : getFacesListeners(FacesListener.class)) {
			if (event.isAppropriateListener(listener)) {
				event.processListener(listener);
			}
		}

		if (event instanceof ActionEvent) {
			final FacesContext context = getFacesContext();

			//invoke actionListener
			final MethodExpression listener = getActionListenerMethodExpression();
			if (listener != null) {
				listener.invoke(context.getELContext(), getConvertedMethodParameters(context));
			}

			//invoke action
			final ActionListener actionListener = context.getApplication().getActionListener();
			if (actionListener != null) {
				actionListener.processAction((ActionEvent) event);
			}
		}
	}

	private transient List allParameters = null;
	private transient List assignableParameters = null;
	private transient List methodParameters = null;
	private transient Object[] convertedMethodParams = null;

	protected void findChildParameters() {
		if (allParameters == null || assignableParameters == null || methodParameters == null) {
			allParameters = new ArrayList();
			assignableParameters = new ArrayList();
			methodParameters = new ArrayList();

			for (final UIComponent child : super.getChildren()) {
				if (child instanceof AbstractParameter) {
					allParameters.add((AbstractParameter) child);

					if (child instanceof AssignableParameter) {
						assignableParameters.add((AssignableParameter) child);
					} else {
						if (child instanceof MethodParameter) {
							methodParameters.add((MethodParameter) child);
						}
					}
				}
			}
		}
	}

	protected List getAllParameters() {
		findChildParameters();

		return allParameters;
	}

	protected List getAssignableParameters() {
		findChildParameters();

		return assignableParameters;
	}

	protected List getMethodParameters() {
		findChildParameters();

		return methodParameters;
	}

	protected Object[] getConvertedMethodParameters(final FacesContext context) {
		if (convertedMethodParams == null) {
			convertedMethodParams = new Object[getMethodParameters().size()];

			for (int i = 0; i < getMethodParameters().size(); i++) {
				final MethodParameter methodParameter = getMethodParameters().get(i);

				final Converter converter = methodParameter.getConverter();
				final String parameterValue = getParameterValue(context, methodParameter.getName());

				if (converter == null) {
					convertedMethodParams[i] = parameterValue;
				} else {
					final Object convertedValue = converter.getAsObject(context, methodParameter, parameterValue);
					convertedMethodParams[i] = convertedValue;
				}
			}
		}

		return convertedMethodParams;
	}

	public String getParameterValue(final FacesContext context, final String name) {
		final Map params = context.getExternalContext().getRequestParameterMap();
		final String clientId = getClientId(context);

		return params.get(clientId + "_" + name);
	}

	public boolean isAjaxified() {
		return true;
	}
}