KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > provisional > cheatsheets > ICompositeCheatSheet


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