Eclipse Plug-in Developer Guide (Galileo) - LaunchShortcutsAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.debug.ui.actions
Class LaunchShortcutsAction


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

org.eclipse.jface.action.Action
              
org.eclipse.debug.ui.actions.LaunchShortcutsAction

All Implemented Interfaces:: IAction, IMenuCreator, IActionDelegate, IWorkbenchWindowActionDelegate, IWorkbenchWindowPulldownDelegate, IWorkbenchWindowPulldownDelegate2

public class LaunchShortcutsAction
extends Action
implements IMenuCreator, IWorkbenchWindowPulldownDelegate2
extends Action
implements IMenuCreator, IWorkbenchWindowPulldownDelegate2

A cascading sub-menu that shows all launch shortcuts pertinent to a selection. This action is similar to ContextualLaunchAction except this action is an IAction rather than an action delegate.

This action appears in the main Run menu

Clients may subclass this class.

Since:: 3.1

Field Summary

Fields inherited from interface org.eclipse.jface.action. IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

LaunchShortcutsAction ( String launchGroupIdentifier)
          Creates a cascading menu action to populate with shortcuts in the given launch group.

Method Summary

void dispose ()
          Disposes the menu returned by getMenu.

Menu getMenu ( Control parent)
          Returns the SWT menu, created as a pop up menu parented by the given control.

Menu getMenu ( Menu parent)
          Returns an SWT menu created as a drop down menu parented by the given menu.

protected String getMode ()
          Returns the mode of this action - run or debug

void init ( IWorkbenchWindow window)
          Initializes this action delegate with the workbench window it will work in.

void run ()
          The default implementation of this IAction method does nothing.

void run ( IAction action)
          Performs this action.

void selectionChanged ( IAction action, ISelection selection)
          Notifies this action delegate that the selection in the workbench has changed.

Methods inherited from class org.eclipse.jface.action. Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class org.eclipse.jface.action. AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class org.eclipse.core.commands.common. EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang. Object

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

Methods inherited from interface org.eclipse.jface.action. IAction

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

LaunchShortcutsAction

public LaunchShortcutsAction(
String launchGroupIdentifier)

Creates a cascading menu action to populate with shortcuts in the given launch group.

Parameters:: launchGroupIdentifier - launch group identifier

Method Detail

run

public void run()

Description copied from class: Action

The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.

Specified by:: run in interface IAction
Overrides:: run in class Action

See Also:: IAction.run()

dispose

public void dispose()

Description copied from interface: IMenuCreator

Disposes the menu returned by getMenu. Does nothing if there is no menu. This method will be executed only when the parent of the menu is disposed.

Specified by:: dispose in interface IMenuCreator
Specified by:: dispose in interface IWorkbenchWindowActionDelegate

See Also:: IMenuCreator.dispose()

getMenu

public 
Menu getMenu(
Control parent)

Description copied from interface: IMenuCreator

Returns the SWT menu, created as a pop up menu parented by the given control. In most cases, this menu can be created once, cached and reused when the pop-up/drop-down action occurs. If the menu must be dynamically created (i.e., each time it is popped up or dropped down), the old menu should be disposed of before replacing it with the new menu.

Specified by:: getMenu in interface IMenuCreator
Specified by:: getMenu in interface IWorkbenchWindowPulldownDelegate

Parameters:: parent - the parent control
Returns:: the menu, or null if the menu could not be created
See Also:: IMenuCreator.getMenu(Control)

getMenu

public 
Menu getMenu(
Menu parent)

Description copied from interface: IMenuCreator

Returns an SWT menu created as a drop down menu parented by the given menu. In most cases, this menu can be created once, cached and reused when the pop-up/drop-down action occurs. If the menu must be dynamically created (i.e., each time it is popped up or dropped down), the old menu should be disposed of before replacing it with the new menu.

Specified by:: getMenu in interface IMenuCreator
Specified by:: getMenu in interface IWorkbenchWindowPulldownDelegate2

Parameters:: parent - the parent menu
Returns:: the menu, or null if the menu could not be created
See Also:: IMenuCreator.getMenu(Menu)

getMode

protected 
String getMode()

Returns the mode of this action - run or debug

Returns:: the mode of this action - run or debug

init

public void init(
IWorkbenchWindow window)

Description copied from interface: IWorkbenchWindowActionDelegate

Initializes this action delegate with the workbench window it will work in.

Specified by:: init in interface IWorkbenchWindowActionDelegate

Parameters:: window - the window that provides the context for this delegate
See Also:: IWorkbenchWindowActionDelegate.init(org.eclipse.ui.IWorkbenchWindow)

run

public void run(
IAction action)

Description copied from interface: IActionDelegate

Performs this action.

This method is called by the proxy action when the action has been triggered. Implement this method to do the actual work.

Note: If the action delegate also implements IActionDelegate2, then this method is not invoked but instead the runWithEvent(IAction, Event) method is called.

Specified by:: run in interface IActionDelegate

Parameters:: action - the action proxy that handles the presentation portion of the action
See Also:: IActionDelegate.run(org.eclipse.jface.action.IAction)

selectionChanged

public void selectionChanged(
IAction action,
                             
ISelection selection)

Description copied from interface: IActionDelegate

Notifies this action delegate that the selection in the workbench has changed.

Implementers can use this opportunity to change the availability of the action or to modify other presentation properties.

When the selection changes, the action enablement state is updated based on the criteria specified in the plugin.xml file. Then the delegate is notified of the selection change regardless of whether the enablement criteria in the plugin.xml file is met.

Specified by:: selectionChanged in interface IActionDelegate

Parameters:: action - the action proxy that handles presentation portion of the action; selection - the current selection, or null if there is no selection.
See Also:: IActionDelegate.selectionChanged(org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelection)