com.eduworks.foundation.jquery.plugin.Foundation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ec.ui.framework Show documentation

There is a newer version: 3.1.8

package com.eduworks.foundation.jquery.plugin;

import org.stjs.javascript.annotation.SyntheticType;
import org.stjs.javascript.jquery.JQueryCore;

/**
 * STJS Wrapper for the foundation functions used in the EC Framework
 *
 * @param  Meaning that the foundation functions can be called on any JQueryCore instances
 *                     (Including Jquery wrapped elements)
 * @author [email protected]
 */
@SyntheticType
public interface Foundation> {

	/**
	 * Invokes foundation without any parameters on the JqueryCore Instance
	 *
	 * @return Returns the JQueryCore Instance so other JQuery functions could be called on it
	 */
	public FullJQuery foundation();

	/**
	 * Invokes a specific foundation method on the JqueryCore Instance
	 *
	 * @param methodName Name of the foundation method to invoke
	 * @return Returns the JQueryCore Instance so other JQuery functions could be called on it
	 */
	public FullJQuery foundation(String methodName);

	/**
	 * Invokes a specific foundation method with a type on the JqueryCore Instance
	 *
	 * @param type
	 * @param methodName Name of the foundation method to invoke
	 * @return Returns the JQueryCore Instance so other JQuery functions could be called on it
	 */
	public FullJQuery foundation(String type, String methodName);
}