Eclipse Plug-in Developer Guide (Galileo) - AddMemoryRenderingActionDelegate (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 AddMemoryRenderingActionDelegate


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

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

All Implemented Interfaces:: IAction, IActionDelegate, IActionDelegate2, IEditorActionDelegate, IObjectActionDelegate, IViewActionDelegate

public class AddMemoryRenderingActionDelegate
extends Action
implements IViewActionDelegate, IEditorActionDelegate, IObjectActionDelegate, IActionDelegate2
extends Action
implements IViewActionDelegate, IEditorActionDelegate, IObjectActionDelegate, IActionDelegate2

A cascade menu to add a memory rendering to the memory view. This action delegate can be contributed to a an editor, view or object via standard workbench extension points. The action works on the IAddMemoryRenderingsTarget adapter provided by the active debug context, creating a context menu to add applicable renderings to the memory view.

Clients may reference/contribute this class as an action delegate in plug-in XML.

Since:: 3.2
Restriction:: This class is not intended to be subclassed by clients.
Restriction:: This class is not intended to be instantiated by clients.

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

AddMemoryRenderingActionDelegate ()


Method Summary

void dispose ()
          Allows the action delegate to clean up.

void init ( IAction action)
          Allows the action delegate to initialize itself after being created by the proxy action.

void init ( IViewPart view)
          Initializes this action delegate with the view it will work in.

void run ( IAction action)
          Performs this action.

void runWithEvent ( IAction action, Event event)
          Performs this action, passing the SWT event which triggered it.

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

void setActiveEditor ( IAction action, IEditorPart targetEditor)
          Sets the active editor for the delegate.

void setActivePart ( IAction action, IWorkbenchPart targetPart)
          Sets the active part for the delegate.

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, run, 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

AddMemoryRenderingActionDelegate

public AddMemoryRenderingActionDelegate()

Method Detail

init

public void init(
IViewPart view)

Description copied from interface: IViewActionDelegate

Initializes this action delegate with the view it will work in.

Specified by:: init in interface IViewActionDelegate

Parameters:: view - the view that provides the context for this delegate

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

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.

setActiveEditor

public void setActiveEditor(
IAction action,
                            
IEditorPart targetEditor)

Description copied from interface: IEditorActionDelegate

Sets the active editor for the delegate. Implementors should disconnect from the old editor, connect to the new editor, and update the action to reflect the new editor.

Specified by:: setActiveEditor in interface IEditorActionDelegate

Parameters:: action - the action proxy that handles presentation portion of the action; targetEditor - the new editor target

setActivePart

public void setActivePart(
IAction action,
                          
IWorkbenchPart targetPart)

Description copied from interface: IObjectActionDelegate

Sets the active part for the delegate. The active part is commonly used to get a working context for the action, such as the shell for any dialog which is needed.

This method will be called every time the action appears in a popup menu. The targetPart may change with each invocation.

Specified by:: setActivePart in interface IObjectActionDelegate

Parameters:: action - the action proxy that handles presentation portion of the action; must not be null.; targetPart - the new part target; must not be null.

init

public void init(
IAction action)

Description copied from interface: IActionDelegate2

Allows the action delegate to initialize itself after being created by the proxy action. This lifecycle method is called after the action delegate has been created and before any other method of the action delegate is called.

Specified by:: init in interface IActionDelegate2

Parameters:: action - the proxy action that handles the presentation portion of the action.

dispose

public void dispose()

Description copied from interface: IActionDelegate2

Allows the action delegate to clean up. This lifecycle method is called when the proxy action is done with this action delegate. This is the last method called.

Specified by:: dispose in interface IActionDelegate2

runWithEvent

public void runWithEvent(
IAction action,
                         
Event event)

Description copied from interface: IActionDelegate2

Performs this action, passing the SWT event which triggered it. This method is called by the proxy action when the action has been triggered. Implement this method to do the actual work.

Note: This method is called instead of run(IAction).

Specified by:: runWithEvent in interface IActionDelegate2

Parameters:: action - the action proxy that handles the presentation portion of the action; event - the SWT event which triggered this action being run