Package org.eclipse.debug.ui.actions

Class RulerRunToLineActionDelegate

java.lang.Object

org.eclipse.ui.actions.ActionDelegate

org.eclipse.ui.texteditor.AbstractRulerActionDelegate

org.eclipse.debug.ui.actions.RulerRunToLineActionDelegate

All Implemented Interfaces:

EventListener, IMenuListener, MouseListener, SWTEventListener, IActionDelegate, IActionDelegate2, IEditorActionDelegate

public class RulerRunToLineActionDelegate
extends AbstractRulerActionDelegate
implements IActionDelegate2

A run to line action that can be contributed to a an editor or view. The action will perform the "run to line" operation for parts that provide an appropriate IRunToLineTarget adapter.

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.RulerRunToLineActionDelegate"
             style="push"
             actionID="RulerClick"
             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="Run to Line"
         class="org.eclipse.debug.ui.actions.RulerRunToLineActionDelegate"
         menubarPath="additions"
         id="example.rulerContextMenu.runToLineAction">
       </action>
   </viewerContribution>
 

Clients may refer to this class as an action delegate in plug-in XML.

Since:

3.12

Restriction:

This class is not intended to be subclassed by clients.

Restriction:

This class is not intended to be instantiated by clients.

Constructor Summary

Constructors

Constructor	Description
RulerRunToLineActionDelegate()

Method Summary

Modifier and Type	Method	Description
protected IAction	createAction(ITextEditor editor, IVerticalRulerInfo rulerInfo)	The factory method creating the underlying action.
void	dispose()	The ActionDelegate implementation of this IActionDelegate2 method does nothing.
void	init(IAction action)	The ActionDelegate implementation of this IActionDelegate2 method does nothing.
void	runWithEvent(IAction action, Event event)	The ActionDelegate implementation of this IActionDelegate2 method redirects to the run method.
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

RulerRunToLineActionDelegate

public RulerRunToLineActionDelegate()

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

Parameters:

callerAction - the action proxy that handles presentation portion of the action

targetEditor - the new editor target

init

public void init(IAction action)

Description copied from class: ActionDelegate

The ActionDelegate implementation of this IActionDelegate2 method does nothing. Subclasses may reimplement.

Specified by:

init in interface IActionDelegate2

Overrides:

init in class ActionDelegate

Parameters:

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

dispose

public void dispose()

Description copied from class: ActionDelegate

The ActionDelegate implementation of this IActionDelegate2 method does nothing. Subclasses may reimplement.

Specified by:

dispose in interface IActionDelegate2

Overrides:

dispose in class ActionDelegate

runWithEvent

public void runWithEvent(IAction action,
                         Event event)

Description copied from class: ActionDelegate

The ActionDelegate implementation of this IActionDelegate2 method redirects to the run method. Subclasses may reimplement.

Specified by:

runWithEvent in interface IActionDelegate2

Overrides:

runWithEvent in class AbstractRulerActionDelegate

Parameters:

action - the action proxy that handles the presentation portion of the action

event - the SWT event which triggered this action being run