org.pepstock.charba.client.commons.NativeJsHelper 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 org.pepstock.charba.client.dom.elements.Canvas;
import org.pepstock.charba.client.dom.elements.CanvasGradientItem;
import org.pepstock.charba.client.dom.elements.CanvasPatternItem;
import org.pepstock.charba.client.dom.elements.Img;

import jsinterop.annotations.JsPackage;
import jsinterop.annotations.JsType;

/**
 * Java native object which is wrapping a CHARBA java script object implementation with some utilities to act on java script objects.
 * 
 * @author Andrea "Stock" Stocchero
 */
@JsType(isNative = true, name = NativeName.JS_HELPER, namespace = JsPackage.GLOBAL)
final class NativeJsHelper {

	/**
	 * To avoid any instantiation
	 */
	NativeJsHelper() {
		// do nothing
	}

	/**
	 * Creates a native object instance.
	 * 
	 * @return new native object instance
	 */
	static native NativeObject create();

	/**
	 * Performs unchecked cast to a type.

	 * Using this method can have an incorrect type of the object to the rest of the system which will result in hard to debug problems.
	 * 
	 * @param object object which must be cast
	 * @param  type of the result
	 * @return the object cast to another type
	 */
	static native  T cast(Object object);

	/**
	 * Returns a boolean indicating whether the object has the specified property as its own property.
	 *
	 * @param object the object on which to search the property.
	 * @param key the string name of the property to test.
	 * @return boolean indicating whether or not the object has the specified property as own property.
	 */
	static native boolean has(Object object, String key);

	/**
	 * Returns the java script object type of object.
	 * 
	 * @param object the object to get type.
	 * @return the object type
	 */
	static native String typeOf(Object object);

	/**
	 * Returns the java script object type of a property.
	 * 
	 * @param object the object on which to search the property.
	 * @param key the string name of the property to test.
	 * @return the object type
	 */
	static native String type(Object object, String key);

	/**
	 * This method determines whether the passed property of passed object is an Array.
	 * 
	 * @param object the object on which to test the property.
	 * @param key the string name of the property to test.
	 * @return true if the value is an Array otherwise, false.
	 */
	static native boolean isArray(Object object, String key);

	/**
	 * Creates new proxy for callback which will pass this environment of java script as first argument of callback method.
	 * 
	 * @param  callback proxy type
	 * @return new proxy for callback.
	 */
	static native  CallbackProxy newCallbackProxy();

	/**
	 * Removes a property from a java script object.
	 * 
	 * @param object the object on which to remove the property.
	 * @param key the string name of the property to remove.
	 */
	static native void remove(NativeObject object, String key);

	/**
	 * Returns true if the object is a {@link CanvasPatternItem}.
	 * 
	 * @param object the object instance on which to check
	 * @return true if the object is a {@link CanvasPatternItem}
	 */
	static native boolean isCanvasPattern(Object object);

	/**
	 * Returns true if the object is a {@link CanvasGradientItem}.
	 * 
	 * @param object the object instance on which to check
	 * @return true if the object is a {@link CanvasGradientItem}
	 */
	static native boolean isCanvasGradient(Object object);

	/**
	 * Returns true if the object is a {@link Canvas}.
	 * 
	 * @param object the object instance on which to check
	 * @param key the string name of the property to test.
	 * @return true if the object is a {@link Canvas}
	 */
	static native boolean isCanvas(NativeObject object, String key);

	/**
	 * Returns true if the object is a {@link Img}.
	 * 
	 * @param object the object instance on which to check
	 * @param key the string name of the property to test.
	 * @return true if the object is a {@link Img}
	 */
	static native boolean isImage(NativeObject object, String key);
}