/*
 *  JFLAP - Formal Languages and Automata Package
 * 
 * 
 *  Susan H. Rodger
 *  Computer Science Department
 *  Duke University
 *  August 27, 2009

 *  Copyright (c) 2002-2009
 *  All rights reserved.

 *  JFLAP is open source software. Please see the LICENSE for terms.
 *
 */





package gui.action;

import gui.environment.Environment;
import java.awt.event.ActionEvent;

/**
 * The <CODE>EnvironmentHelpAction</CODE> is an extension of the <CODE>HelpAction</CODE>
 * that, whenever an action is received, determines what should be displayed
 * based on the currently active pane in the environment. Basically, it simply
 * calls <CODE>HelpAction.displayHelp</CODE> on <CODE>Environment.getActive</CODE>.
 * 
 * Any components in an environment that wish to have help should register
 * themselves, or preferably their <CODE>Class</CODE> objects (so that it only
 * happens once), with whatever particular webpage they wish to display whenever
 * help is activated.
 * 
 * @author Thomas Finley
 */

public class EnvironmentHelpAction extends HelpAction {
	/**
	 * Instantiates an <CODE>EnvironmentHelpAction</CODE>.
	 * 
	 * @param environment
	 *            the environment that this help action will get the current
	 *            panel from
	 */
	public EnvironmentHelpAction(Environment environment) {
		this.environment = environment;
	}

	/**
	 * Displays help according to the current display of the automaton.
	 * 
	 * @param event
	 *            the action event
	 */
	public void actionPerformed(ActionEvent event) {
		displayHelp(environment.getActive());
	}

	/** The environment this help action is for. */
	private Environment environment;
}