RendererPlugin.java

/*
 * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
 *
 * 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.
 */
package org.primaresearch.web.gwt.client.ui.page.renderer;


/**
 * Interface for page renderer plug-ins that represent a rendering layer.
 * 
 * @author Christian Clausner
 *
 */
public interface RendererPlugin {

	/**
	 * Draws the layer
	 */
	public void render(PageRenderer renderer);

	/**
	 * Enables or disables the plug-in.
	 */
	public void enable(boolean enable);

	/**
	 * Returns <code>true</code> if the plug-in is enabled, <code>false</code> otherwise.
	 */
	public boolean isEnabled();
}