01: /*******************************************************************************
02: * Copyright (c) 2004, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.cheatsheets;
11:
12: /**
13: * For monitoring the execution of a cheat sheet.
14: * <p>
15: * This class is used in conjuction with the "listener" attribute on
16: * extensions to the extension point
17: * "org.eclipse.ui.cheatsheets.cheatSheetContent". Clients should declare
18: * a subclass that implements {@link #cheatSheetEvent(ICheatSheetEvent)}. The
19: * listener subclass must be public, and have a public 0-arg constructor. The
20: * listener subclass is instantiated as the cheat sheet is opened, and discarded
21: * after the cheat sheet is closed.
22: * </p>
23: *
24: * @since 3.0
25: */
26: public abstract class CheatSheetListener {
27:
28: /**
29: * Creates a new cheat sheet listener.
30: */
31: public CheatSheetListener() {
32: // do nothing
33: }
34:
35: /**
36: * Notifies this listener of the given cheat sheet event.
37: *
38: * @param event the cheat sheet event
39: */
40: public abstract void cheatSheetEvent(ICheatSheetEvent event);
41: }
|