Tool.java

/* (C) 2001-2002, DIUF, http://www.unifr.ch/diuf
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

package iiuf.xmillum;

import org.w3c.dom.Element;

/**
 * Tool
 *
 * This interface defines an xmillum tool.
 *  
 * @author $Author: ohitz $
 * @version $Revision: 1.1 $
 */
public interface Tool {
  /**
   * Activates the tool. The tool is free to open windows or stay in
   * the background.
   *
   * @param context The current context of the application
   * @param e       Element that defines the tool, may contain
   *                additional parameters
   */
  public void activateTool(BrowserContext context, Element e);

  /**
   * Deactivates the tool. All resources allocated by the tool should
   * be freed (windows, files etc).
   */
  public void deactivateTool();
}