org.eclipse.ui.cheatsheets/src/org/eclipse/ui/cheatsheets/CheatSheetListener.java

/*******************************************************************************
 * Copyright (c) 2004, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.cheatsheets;

/**
 * For monitoring the execution of a cheat sheet.
 * <p>
 * This class is used in conjuction with the "listener" attribute on
 * extensions to the extension point
 * "org.eclipse.ui.cheatsheets.cheatSheetContent". Clients should declare
 * a subclass that implements {@link #cheatSheetEvent(ICheatSheetEvent)}. The
 * listener subclass must be public, and have a public 0-arg constructor. The
 * listener subclass is instantiated as the cheat sheet is opened, and discarded
 * after the cheat sheet is closed.
 * </p>
 *
 * @since 3.0
 */
public abstract class CheatSheetListener {

	/**
	 * Creates a new cheat sheet listener.
	 */
	public CheatSheetListener() {
		// do nothing
	}

	/**
	 * Notifies this listener of the given cheat sheet event.
	 *
	 * @param event the cheat sheet event
	 */
	 public abstract void cheatSheetEvent(ICheatSheetEvent event);
}