01: /*******************************************************************************
02: * Copyright (c) 2005, 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.internal.provisional.cheatsheets;
11:
12: import org.eclipse.ui.cheatsheets.ICheatSheetManager;
13:
14: /**
15: * Interface representing a composite cheatsheet.
16: * A composite cheat sheet has a single root task, each task may have
17: * zero or more children.
18: * <p>
19: * This interface is not intended to be implemented by clients.
20: * </p>
21: */
22:
23: public interface ICompositeCheatSheet {
24:
25: /**
26: * The ID of the task explorer that should be the
27: * default for this composite cheat sheet. Can be null.
28: * @return the task explorer identifier or <code>null</code> if
29: * the view's default should be used.
30: */
31: String getTaskExplorerId();
32:
33: /**
34: * The root task of this composite cheat sheet
35: * @return the root task object
36: */
37: ICompositeCheatSheetTask getRootTask();
38:
39: /**
40: * Get the manager which allows data to be shared between tasks.
41: * @return the CheatSheetManager for this composite cheat cheet. May not be null.
42: */
43: ICheatSheetManager getCheatSheetManager();
44: }
|