Command.java

/*
 * @(#)Command.java
 *
 * Project:		JHotdraw - a GUI framework for technical drawings
 *				http://www.jhotdraw.org
 *				http://jhotdraw.sourceforge.net
 * Copyright:	(c) by the original author(s) and all contributors
 * License:		Lesser GNU Public License (LGPL)
 *				http://www.opensource.org/licenses/lgpl-license.html
 */

package org.jhotdraw.util;

import org.jhotdraw.framework.DrawingEditor;

/**
 * Commands encapsulate an action to be executed. Commands have
 * a name and can be used in conjunction with <i>Command enabled</i>
 * ui components.
 * <hr>
 * <b>Design Patterns</b><P>
 * <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
 * <b><a href=../pattlets/sld010.htm>Command</a></b><br>
 * Command is a simple instance of the command pattern without undo
 * support.
 * <hr>
 *
 * @see CommandButton
 * @see CommandMenu
 * @see CommandChoice
 *
 * @version <$CURRENT_VERSION$>
 */
public interface Command {

	/**
	 * Executes the command.
	 */
	public void execute();

	/**
	 * Tests if the command can be executed.
	 */
	public boolean isExecutable();

	/**
	 * Gets the command name.
	 */
	public String name();
	
	public DrawingEditor getDrawingEditor();

	public Undoable getUndoActivity();

	public void setUndoActivity(Undoable newUndoableActivity);
	
	public void addCommandListener(CommandListener newCommandListener);
	public void removeCommandListener(CommandListener oldCommandListener);
}