package ie.dcu.apps.ist.actions;

import org.eclipse.jface.action.*;

/**
 * Extension of IAction that supports arming when the mouse hovers over the
 * item. This may be useful for displaying descriptions of menu items in the
 * status bar, for example. To use hover actions the {@link HoverMenuManager}
 * must be used.
 * 
 * @author Kevin McGuinness
 */
public interface IHoverAction extends IAction {
	
	
	/**
	 * Executed when the action is hovered/armed.
	 */
	public void arm();
	
	
	/**
	 * Executed when the action is de-hovered/disarmed.
	 */
	public void disarm();
	
	
	/**
	 * Query if the action is armed.
	 * 
	 * @return <code>true</code> if armed.
	 */
	public boolean isArmed();
}