KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > help > ILiveHelpAction


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.help;
12 /**
13  * Live Help Extension. Classes that implement this interface can be used as
14  * live help extensions. When user clicks a live help link in a help document,
15  * the class will be loaded and run.
16  *
17  * @since 2.0
18  */

19 public interface ILiveHelpAction extends Runnable JavaDoc {
20     /**
21      * This method will be called upon instantiation of the live help extension.
22      * The data will be passed as specified in the help document live help link.
23      *
24      * @param data -
25      * initialization data as a String
26      */

27     public void setInitializationString(String JavaDoc data);
28 }
29
Popular Tags