Eclipse Plug-in Developer Guide (Galileo) - OpenCheatSheetFromHelpAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.cheatsheets
Class OpenCheatSheetFromHelpAction


java.lang.Object
  
org.eclipse.ui.cheatsheets.OpenCheatSheetFromHelpAction

All Implemented Interfaces:: Runnable, ILiveHelpAction

public final class OpenCheatSheetFromHelpAction
extends Object
implements ILiveHelpAction
extends Object
implements ILiveHelpAction

Live help action for launching a cheat sheet from a help book.

The initialization string passed to setInitializationString(String) is the id of a cheat sheet contributed to the cheatsheetContent extension point.

Since:: 3.0

Constructor Summary

OpenCheatSheetFromHelpAction ()
          Creates a new live help action.

Method Summary

void run ()


void setInitializationString ( String data)
          This method will be called upon instantiation of the live help extension.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenCheatSheetFromHelpAction

public OpenCheatSheetFromHelpAction()

Creates a new live help action.

Method Detail

setInitializationString

public void setInitializationString(
String data)

Description copied from interface: ILiveHelpAction

This method will be called upon instantiation of the live help extension. The data will be passed as specified in the help document live help link.

Specified by:: setInitializationString in interface ILiveHelpAction

Parameters:: data - - initialization data as a String

run

public void run()

Specified by:: run in interface Runnable