Package org.eclipse.pde.ui.launcher

Class EclipseLaunchShortcut

  • All Implemented Interfaces:
    ILaunchShortcut
    public class EclipseLaunchShortcut
extends AbstractLaunchShortcut
    A launch shortcut capable of launching an Eclipse application. Given the current selection, either a new Eclipse Application launch configuration is created with default settings, or the user is presented with a list of suitable existing Eclipse Application launch configurations to choose from.

    This class may be instantiated or subclassed by clients.

    Since:
    3.3

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CONFIGURATION_TYPE
      The launch configuration type name that this shortcut uses

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected ILaunchConfiguration findLaunchConfiguration​(java.lang.String mode)
      This method first tries to locate existing launch configurations that are suitable for the application or framework being launched.
      protected java.lang.String getLaunchConfigurationTypeName()
      Returns the Eclipse application configuration type ID as declared in the plugin.xml
      protected java.lang.String getName​(ILaunchConfigurationType type)
      Returns the name assigned to the new launch configuration
      protected void initializeConfiguration​(ILaunchConfigurationWorkingCopy wc)
      Initializes a new Eclipse Application launch configuration with defaults based on the current selection: If there is no selection or the selected project is a plug-in that does not declare an application, the default product is launched. If the selected project is a plug-in that declares an application, then that application is launched. If the selected project is a plug-in that declares more than one application, then the user is presented with a list of choices to choose from. Once an application is chosen, the plug-in is searched to see if there is a product bound to this application.
      protected boolean isGoodMatch​(ILaunchConfiguration configuration)
      Returns a boolean value indicating whether the launch configuration is a good match for the application or product to launch.
      void launch​(ISelection selection, java.lang.String mode)  
      void launch​(IEditorPart editor, java.lang.String mode)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • CONFIGURATION_TYPE

        public static final java.lang.String CONFIGURATION_TYPE
        The launch configuration type name that this shortcut uses
        See Also:
        Constant Field Values

    • Constructor Detail

      • EclipseLaunchShortcut

        public EclipseLaunchShortcut()

    • Method Detail

      • launch

        public void launch​(IEditorPart editor,
                   java.lang.String mode)

      • launch

        public void launch​(ISelection selection,
                   java.lang.String mode)

      • findLaunchConfiguration

        protected ILaunchConfiguration findLaunchConfiguration​(java.lang.String mode)
        Description copied from class: AbstractLaunchShortcut
        This method first tries to locate existing launch configurations that are suitable for the application or framework being launched.
        • If none are found, a new launch configuration is created and initialized
        • If one is found, it is launched automatically
        • If more than one is found, a selection dialog is presented to the user and the chosen one will be launched
        Overrides:
        findLaunchConfiguration in class AbstractLaunchShortcut
        Parameters:
        mode - mode of launch (run, debug or profile)
        Returns:
        a launch configuration to run or null if launch is canceled

      • isGoodMatch

        protected boolean isGoodMatch​(ILaunchConfiguration configuration)
        Returns a boolean value indicating whether the launch configuration is a good match for the application or product to launch.
        Specified by:
        isGoodMatch in class AbstractLaunchShortcut
        Parameters:
        configuration - the launch configuration being evaluated
        Returns:
        true if the launch configuration is suitable for the application or product to launch with, false otherwise.

      • initializeConfiguration

        protected void initializeConfiguration​(ILaunchConfigurationWorkingCopy wc)
        Initializes a new Eclipse Application launch configuration with defaults based on the current selection:
        • If there is no selection or the selected project is a plug-in that does not declare an application, the default product is launched.
        • If the selected project is a plug-in that declares an application, then that application is launched.
        • If the selected project is a plug-in that declares more than one application, then the user is presented with a list of choices to choose from.
        Once an application is chosen, the plug-in is searched to see if there is a product bound to this application. If a product is found, the product is launched instead, since a product provides a richer branded experience.
        Specified by:
        initializeConfiguration in class AbstractLaunchShortcut
        Parameters:
        wc - the launch configuration working copy to be initialize
        Since:
        3.3
        See Also:
        IPDELauncherConstants

      • getLaunchConfigurationTypeName

        protected java.lang.String getLaunchConfigurationTypeName()
        Returns the Eclipse application configuration type ID as declared in the plugin.xml
        Specified by:
        getLaunchConfigurationTypeName in class AbstractLaunchShortcut
        Returns:
        the Eclipse application configuration type ID