|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.texteditor.AbstractRulerActionDelegate
org.eclipse.debug.ui.actions.RulerToggleBreakpointActionDelegate
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.
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 |
public RulerToggleBreakpointActionDelegate()
Method Detail |
protected IAction createAction(ITextEditor editor, IVerticalRulerInfo rulerInfo)
AbstractRulerActionDelegate
createAction
in class AbstractRulerActionDelegate
editor
- the editor the action to be created will work onrulerInfo
- the vertical ruler the action to be created will work on
public void setActiveEditor(IAction callerAction, IEditorPart targetEditor)
IEditorActionDelegate
setActiveEditor
in interface IEditorActionDelegate
setActiveEditor
in class AbstractRulerActionDelegate
public void init(IAction action)
IActionDelegate2
init
in interface IActionDelegate2
action
- the proxy action that handles the presentation portion of
the action.public void dispose()
IActionDelegate2
dispose
in interface IActionDelegate2
public void runWithEvent(IAction action, Event event)
IActionDelegate2
Note: This method is called instead of run(IAction)
.
runWithEvent
in interface IActionDelegate2
action
- the action proxy that handles the presentation portion of
the actionevent
- the SWT event which triggered this action being run
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.