com.jsftoolkit.base.HeadInsert Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of components-base

The core classes for the JSF Toolkit Component Framework. Includes all framework base and utility classes as well as component kick-start/code-generation and registration tools. Also includes some classes for testing that are reused in other projects. They cannot be factored out into a separate project because they are referenced by the tests and they reference this code (circular dependence).

The newest version!

package com.jsftoolkit.base;

import java.io.IOException;
import java.util.Set;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;

import com.jsftoolkit.base.renderer.HtmlRenderer;

/**
 * 
 * Interface for components (and renderers) that need to write something inside
 * of the head element, e.g. a script or stylesheet include, or an
 * initialization script.
 * 
 * @author noah
 * 
 */
public interface HeadInsert {

	/**
	 * Gives the component a chance to write things into head. See
	 * {@link HtmlRenderer#encodeHead(FacesContext, UIComponent, Set)} for
	 * an example.
	 * 
	 * @param context
	 * @param component
	 * @param resourceIds
	 *            ids of resources already included in the page. This is
	 *            important for Ajax requests because Shale Remoting will not be
	 *            aware of what is already loaded in the page.
	 * @throws IOException
	 */
	void encodeHead(FacesContext context, UIComponent component,
			Set resourceIds) throws IOException;
}