org.eclipse.ui.cheatsheets
Interface ICompositeCheatSheet

public interface ICompositeCheatSheet

Interface representing a composite cheatsheet. A composite cheat sheet has a single root task, each task may have zero or more children.

This interface is not intended to be implemented by clients.

Since:

3.2

Method Summary

ICheatSheetManager	getCheatSheetManager() Get the manager which allows data to be shared between tasks.
ICompositeCheatSheetTask	getRootTask() The root task of this composite cheat sheet
String	getTaskExplorerId() The ID of the task explorer that should be the default for this composite cheat sheet.

Method Detail

getTaskExplorerId

public String getTaskExplorerId()

The ID of the task explorer that should be the default for this composite cheat sheet. Can be null.

Returns:

the task explorer identifier or null if the view's default should be used.

getRootTask

public ICompositeCheatSheetTask getRootTask()

The root task of this composite cheat sheet

Returns:

the root task object

getCheatSheetManager

public ICheatSheetManager getCheatSheetManager()

Get the manager which allows data to be shared between tasks.

Returns:

the CheatSheetManager for this composite cheat cheet. May not be null.