plugins/org.eclipse.epf.richtext/src/org/eclipse/epf/richtext/actions/IBaseRichTextAction.java

//------------------------------------------------------------------------------
// Copyright (c) 2005, 2006 IBM Corporation and others.
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// Contributors:
// IBM Corporation - initial implementation
//------------------------------------------------------------------------------
package org.eclipse.epf.richtext.actions;

/**
 * The base interface for a Rich Text action.
 * 
 * @author Kelvin Low
 * @since 1.0
 */
public interface IBaseRichTextAction {

	/**
	 * Returns the tool tip for the action.
	 * 
	 * @return The tool tip text.
	 */
	public String getToolTipText();

	/**
	 * Sets the tool tip for the action.
	 * 
	 * @param toolTipText
	 *            The tool tip text.
	 */
	public void setToolTipText(String toolTipText);

	/**
	 * Returns the enabled status of the action.
	 * 
	 * @return True if enabled, false if not.
	 */
	public boolean getEnabled();

	/**
	 * Enables or disables the action.
	 * 
	 * @param enabled
	 *            If true, enable the action. if false, disable it.
	 */
	public void setEnabled(boolean enabled);

}