org.eclipse.debug.ui.ILaunchGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.debug.ui Show documentation
This is org.eclipse.debug.ui jar used by Scout SDK
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.debug.ui;
 
import org.eclipse.jface.resource.ImageDescriptor;

/**
 * A launch group identifies a group of launch configurations by a launch
 * mode and category. The launch configuration dialog can be opened on
 * a launch group, and a launch history is maintained for each group.
 * A launch group is defined in plug-in XML via the launchGroups
 * extension point.
 *  
 * Following is an example of a launch group contribution:
 * 
 * 	<extension point="org.eclipse.debug.ui.launchGroups">
 * 		<launchGroup
 * 			  id="com.example.ExampleLaunchGroupId"
 * 			  mode="run"
 * 			  label="Run"
 * 			  image="icons\run.png"
 * 		</launchGroup>
 * 	</extension>
 * 
 * 
 * 
 * The debug platform defines constants for the identifiers of the launch groups
 * provided by the debug platform:
 * 

 * IDebugUIConstants.ID_DEBUG_LAUNCH_GROUP
 * IDebugUIConstants.ID_RUN_LAUNCH_GROUP
 * IDebugUIConstants.ID_PROFILE_LAUNCH_GROUP
 * 
 * 
 * @since 3.0
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface ILaunchGroup {
	
	/**
	 * Returns the image for this launch group, or null
	 * if none.
	 * 
	 * @return the image for this launch group, or null if none
	 */
	public ImageDescriptor getImageDescriptor();
	
	/**
	 * Returns the banner image for this launch group, or null if
	 * none
	 * 
	 * @return the banner image for this launch group, or null if
	 * none
	 */
	public ImageDescriptor getBannerImageDescriptor();
	
	/**
	 * Returns the label for this launch group
	 * 
	 * @return the label for this launch group
	 */
	public String getLabel();
		
	/**
	 * Returns the id for this launch group
	 * 
	 * @return the id for this launch group
	 */
	public String getIdentifier();
	
	/**
	 * Returns the category for this launch group, possibly null
	 * 
	 * @return the category for this launch group, possibly null
	 */
	public String getCategory();
	
	/**
	 * Returns the mode for this launch group
	 * 
	 * @return the mode for this launch group
	 */
	public String getMode();
	
	/**
	 * Returns whether this launch group is public
	 *  
	 * @return boolean
	 */
	public boolean isPublic();
	
}