org.pepstock.charba.client.commons.CallbackProxy 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.pepstock.charba.client.commons;

import jsinterop.annotations.JsFunction;
import jsinterop.annotations.JsPackage;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;

/**
 * This is a native object which wraps a java script object created by {@link JsHelper}.

 * This object is used to get a proxy instance which is able to call a java script function passing also this java script value, to maintain the environment when
 * required.
 * 
 * @author Andrea "Stock" Stocchero
 * 
 */
@JsType(isNative = true, namespace = JsPackage.GLOBAL, name = NativeName.JS_CALLBACK_PROXY)
public final class CallbackProxy {

	/**
	 * It's a java script function which maps the function proxy implemented in the additional java script source.
	 * 
	 * @author Andrea "Stock" Stocchero
	 */
	@JsFunction
	public interface Proxy {
		/**
		 * Call method the function proxy implemented in the additional java script source.
		 */
		void call();
	}

	/**
	 * Returns the function proxy implemented in the additional java script source.
	 * 
	 * @return the proxy function proxy implemented in the additional java script source
	 */
	@JsProperty
	public native Proxy getProxy();

	/**
	 * Returns the function callback implemented in the additional java script source.
	 * 
	 * @return the function callback implemented in the additional java script source
	 */
	@JsProperty
	public native T getCallback();

	/**
	 * Sets true if the functional context must be ignored as argument to pass to callback.
	 * 
	 * @param ignore true if the functional context must be ignored as argument to pass to callback
	 */
	@JsProperty
	public native void setIgnoreFunctionContext(boolean ignore);

	/**
	 * Returns true if the functional context must be ignored as argument to pass to callback.
	 * 
	 * @return true if the functional context must be ignored as argument to pass to callback
	 */
	@JsProperty
	public native boolean isIgnoreFunctionContext();

	/**
	 * Sets the function callback implemented in the additional java script source.
	 * 
	 * @param callback the function callback implemented in the additional java script source
	 */
	@JsProperty
	public native void setCallback(T callback);

}