KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > ui > ILaunchGroup


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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.debug.ui;
12  
13 import org.eclipse.jface.resource.ImageDescriptor;
14
15 /**
16  * A launch group identifies a group of launch configurations by a launch
17  * mode and category. The launch configuration dialog can be opened on
18  * a launch group, and a launch history is maintained for each group.
19  * A launch group is defined in plug-in XML via the <code>launchGroups</code>
20  * extension point.
21  * <p>
22  * Following is an example of a launch group contribution:
23  * <pre>
24  * &lt;extension point="org.eclipse.debug.ui.launchGroups"&gt;
25  * &lt;launchGroup
26  * id="com.example.ExampleLaunchGroupId"
27  * mode="run"
28  * label="Run"
29  * image="icons\run.gif"
30  * &lt;/launchGroup&gt;
31  * &lt;/extension&gt;
32  * </pre>
33  * </p>
34  * <p>
35  * Clients are not intended to implement this interface.
36  * </p>
37  * @since 3.0
38  */
39 public interface ILaunchGroup {
40     
41     /**
42      * Returns the image for this launch group, or <code>null</code>
43      * if none.
44      *
45      * @return the image for this launch group, or <code>null</code> if none
46      */
47     public ImageDescriptor getImageDescriptor();
48     
49     /**
50      * Returns the banner image for this launch group, or <code>null</code> if
51      * none
52      *
53      * @return the banner image for this launch group, or <code>null</code> if
54      * none
55      */
56     public ImageDescriptor getBannerImageDescriptor();
57     
58     /**
59      * Returns the label for this launch group
60      *
61      * @return the label for this launch group
62      */
63     public String JavaDoc getLabel();
64         
65     /**
66      * Returns the id for this launch group
67      *
68      * @return the id for this launch group
69      */
70     public String JavaDoc getIdentifier();
71     
72     /**
73      * Returns the category for this launch group, possibly <code>null</code>
74      *
75      * @return the category for this launch group, possibly <code>null</code>
76      */
77     public String JavaDoc getCategory();
78     
79     /**
80      * Returns the mode for this launch group
81      *
82      * @return the mode for this launch group
83      */
84     public String JavaDoc getMode();
85     
86     /**
87      * Returns whether this launch group is public
88      *
89      * @return boolean
90      */
91     public boolean isPublic();
92     
93 }
94
95
Popular Tags