Package org.eclipse.ui.texteditor
Class GotoAnnotationAction
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.texteditor.ResourceAction
org.eclipse.ui.texteditor.TextEditorAction
org.eclipse.ui.texteditor.GotoAnnotationAction
Action for jumping to a particular annotation in the editor's text viewer.
This action only runs if getTextEditor()
implements ITextEditorExtension4
.
This class may be instantiated; it is not intended to be subclassed.
- Since:
- 3.2
- Restriction:
- This class is not intended to be subclassed 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
ConstructorDescriptionGotoAnnotationAction
(ResourceBundle bundle, String prefix, ITextEditor editor, boolean forward) Creates a new action for the given text editor.GotoAnnotationAction
(ITextEditor editor, boolean forward) Creates a new action for the given text editor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
run()
The default implementation of thisIAction
method does nothing.void
setEditor
(ITextEditor editor) Retargets this action to the given editor.void
update()
Always enables this action if it is connected to a text editor.Methods inherited from class org.eclipse.ui.texteditor.TextEditorAction
canModifyEditor, getTextEditor, validateEditorInputState
Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, initialize, setHelpContextId
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, 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
-
Constructor Details
-
GotoAnnotationAction
public GotoAnnotationAction(ResourceBundle bundle, String prefix, ITextEditor editor, boolean forward) Creates a new action for the given text editor. The action configures its visual representation from the given resource bundle.- Parameters:
bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys (described inResourceAction
constructor), ornull
if noneeditor
- the text editorforward
-true
to go to next andfalse
to go to previous annotation- See Also:
-
GotoAnnotationAction
Creates a new action for the given text editor. The action configures its visual representation from the given resource bundle.- Parameters:
editor
- the text editorforward
-true
to go to next andfalse
to go to previous annotation- See Also:
-
-
Method Details
-
run
public void run()Description copied from class:Action
The default implementation of thisIAction
method does nothing. Subclasses should override this method if they do not need information from the triggering event, or overriderunWithEvent(Event)
if they do. -
setEditor
Description copied from class:TextEditorAction
Retargets this action to the given editor.- Overrides:
setEditor
in classTextEditorAction
- Parameters:
editor
- the new editor, ornull
if none
-
update
public void update()Description copied from class:TextEditorAction
Always enables this action if it is connected to a text editor. If the associated editor isnull
, the action is disabled. Subclasses may override.- Specified by:
update
in interfaceIUpdate
- Overrides:
update
in classTextEditorAction
-