|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.ui.actions.ActionDelegate
org.eclipse.ui.texteditor.AbstractRulerActionDelegate
This class serves as an adapter for actions contributed to the vertical ruler's
context menu. This adapter provides the contributed actions access to their editor
and the editor's vertical ruler. These actions gain only limited access to the vertical
ruler as defined by IVerticalRulerInfo. The adapter updates the
adapter (inner) action on menu and mouse action on the vertical ruler.
Extending classes must implement the factory method
createAction(ITextEditor editor, IVerticalRulerInfo).
| Constructor Summary | |
|---|---|
AbstractRulerActionDelegate()
|
|
| Method Summary | |
|---|---|
protected abstract IAction |
createAction(ITextEditor editor,
IVerticalRulerInfo rulerInfo)
The factory method creating the underlying action. |
void |
menuAboutToShow(IMenuManager manager)
Notifies this listener that the menu is about to be shown by the given menu manager. |
void |
mouseDoubleClick(MouseEvent e)
Sent when a mouse button is pressed twice within the (operating system specified) double click period. |
void |
mouseDown(MouseEvent e)
Sent when a mouse button is pressed. |
void |
mouseUp(MouseEvent e)
Sent when a mouse button is released. |
void |
run(IAction callerAction)
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 callerAction,
IEditorPart targetEditor)
Sets the active editor for the delegate. |
| Methods inherited from class org.eclipse.ui.actions.ActionDelegate |
|---|
dispose, init |
| 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.IActionDelegate2 |
|---|
dispose, init |
| Constructor Detail |
public AbstractRulerActionDelegate()
| Method Detail |
protected abstract IAction createAction(ITextEditor editor,
IVerticalRulerInfo rulerInfo)
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 IEditorActionDelegatecallerAction - the action proxy that handles presentation portion of the actiontargetEditor - the new editor targetpublic void run(IAction callerAction)
IActionDelegateThis 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.
run in interface IActionDelegaterun in class ActionDelegate
public void runWithEvent(IAction action,
Event event)
IActionDelegate2
Note: This method is called instead of run(IAction).
runWithEvent in interface IActionDelegate2runWithEvent in class ActionDelegate
public void selectionChanged(IAction action,
ISelection selection)
IActionDelegateImplementers 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.
selectionChanged in interface IActionDelegateselectionChanged in class ActionDelegatepublic void menuAboutToShow(IMenuManager manager)
IMenuListener
menuAboutToShow in interface IMenuListenermanager - the menu managerpublic void mouseDoubleClick(MouseEvent e)
MouseListener
mouseDoubleClick in interface MouseListenere - an event containing information about the mouse double clickDisplay.getDoubleClickTime()public void mouseDown(MouseEvent e)
MouseListener
mouseDown in interface MouseListenere - an event containing information about the mouse button presspublic void mouseUp(MouseEvent e)
MouseListener
mouseUp in interface MouseListenere - an event containing information about the mouse button release
|
Eclipse Platform Release 3.3 |
|||||||||||
| 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, 2007. All rights reserved.