KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > cheatsheets > CheatSheetListener


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