Eclipse Platform
Release 3.1

org.eclipse.debug.ui.actions
Class RulerToggleBreakpointActionDelegate

java.lang.Object
  extended byorg.eclipse.ui.texteditor.AbstractRulerActionDelegate
      extended byorg.eclipse.debug.ui.actions.RulerToggleBreakpointActionDelegate
All Implemented Interfaces:
EventListener, IActionDelegate, IActionDelegate2, IEditorActionDelegate, IMenuListener, MouseListener, org.eclipse.swt.internal.SWTEventListener

public class RulerToggleBreakpointActionDelegate
extends AbstractRulerActionDelegate
implements IActionDelegate2

Toggles a breakpoint when ruler is double-clicked. This action delegate can be contributed to an editor with the editorActions extension point. This action is as a factory that creates another action that performs the actual breakpoint toggling. The created action acts on the editor's IToggleBreakpointsTagret to toggle breakpoints.

Following is example plug-in XML used to contribute this action to an editor. Note that the label attribute of this action is not displayed in the editor. Instead, the label of the created action is displayed.

 <extension point="org.eclipse.ui.editorActions">
    <editorContribution
          targetID="example.editor"
          id="example.rulerActions">
       <action
             label="Not Used"
             class="org.eclipse.debug.ui.actions.RulerToggleBreakpointActionDelegate"
             style="push"
             actionID="RulerDoubleClick"
             id="example.doubleClickBreakpointAction"/>
    </editorContribution>
 </extension>
 

This action can also be contributed to a vertical ruler context menu via the popupMenus extension point, by referencing the ruler's context menu identifier in the targetID attribute.

 <extension point="org.eclipse.ui.popupMenus">
   <viewerContribution
     targetID="example.rulerContextMenuId"
     id="example.RulerPopupActions">
       <action
         label="Toggle Breakpoint"
         class="org.eclipse.debug.ui.actions.RulerToggleBreakpointActionDelegate"
         menubarPath="additions"
         id="example.rulerContextMenu.toggleBreakpointAction">
       </action>
   </viewerContribution>
 

Clients may refer to this class as an action delegate in plug-in XML. This class is not intended to be subclassed.

Since:
3.1

Constructor Summary
RulerToggleBreakpointActionDelegate()
           
 
Method Summary
protected  IAction createAction(ITextEditor editor, IVerticalRulerInfo rulerInfo)
          The factory method creating the underlying action.
 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 runWithEvent(IAction action, Event event)
          Performs this action, passing the SWT event which triggered it.
 void setActiveEditor(IAction callerAction, IEditorPart targetEditor)
          Sets the active editor for the delegate.
 
Methods inherited from class org.eclipse.ui.texteditor.AbstractRulerActionDelegate
menuAboutToShow, mouseDoubleClick, mouseDown, mouseUp, run, selectionChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IActionDelegate
run, selectionChanged
 

Constructor Detail

RulerToggleBreakpointActionDelegate

public RulerToggleBreakpointActionDelegate()
Method Detail

createAction

protected IAction createAction(ITextEditor editor,
                               IVerticalRulerInfo rulerInfo)
Description copied from class: AbstractRulerActionDelegate
The factory method creating the underlying action.

Specified by:
createAction in class AbstractRulerActionDelegate
Parameters:
editor - the editor the action to be created will work on
rulerInfo - the vertical ruler the action to be created will work on
Returns:
the created action

setActiveEditor

public void setActiveEditor(IAction callerAction,
                            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
Overrides:
setActiveEditor in class AbstractRulerActionDelegate

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

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.