Package org.eclipse.ui.texteditor
Class SelectMarkerRulerAction
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.SelectMarkerRulerAction
- Direct Known Subclasses:
SelectMarkerRulerInfoAction
A ruler action which can select the textual range of a marker that has a visual representation in
a vertical ruler.
This class may be instantiated but is not intended for sub-classing.
- Since:
- 2.0, allowed to be subclassed since 3.5
-
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
ConstructorsConstructorDescriptionSelectMarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor) Deprecated.SelectMarkerRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor, IVerticalRulerInfo ruler) Creates a new action for the given ruler and editor. -
Method Summary
Modifier and TypeMethodDescriptionprotected final IMarkerchooseMarker(List<? extends IMarker> markers) Chooses the marker with the highest layer.protected final IAnnotationAccessExtensionReturns the annotation access extension.protected final AbstractMarkerAnnotationModelReturns theAbstractMarkerAnnotationModelof the editor's input.protected final IDocumentReturns theIDocumentof the editor's input.Returns all markers which include the ruler's line of activity.protected final IResourceReturns the resource for which to create the marker, ornullif there is no applicable resource.protected final voidhandleCoreException(CoreException exception, String message) Handles core exceptions.protected final booleanReturnstrueiff there are any markers which include the ruler's line of activity.protected final booleanincludesRulerLine(Position position, IDocument document) Checks whether a position includes the ruler's line of activity.voidrun()The default implementation of thisIActionmethod does nothing.voidupdate()Requests that this object update itself.Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, initialize, setHelpContextIdMethods 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, setToolTipTextMethods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListenerMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Constructor Details
-
SelectMarkerRulerAction
public SelectMarkerRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor, IVerticalRulerInfo ruler) Creates a new action for the given ruler and 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 inResourceActionconstructor), ornullif noneeditor- the editorruler- the ruler- See Also:
-
SelectMarkerRulerAction
@Deprecated public SelectMarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor) Deprecated.As of 3.0, replaced bySelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo)Creates a new action for the given ruler and 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 keysruler- the rulereditor- the editor
-
-
Method Details
-
update
public void update()Description copied from interface:IUpdateRequests that this object update itself. -
run
public void run()Description copied from class:ActionThe default implementation of thisIActionmethod does nothing. Subclasses should override this method if they do not need information from the triggering event, or overriderunWithEvent(Event)if they do. -
chooseMarker
Chooses the marker with the highest layer. If there are multiple markers at the found layer, the first marker is taken.- Parameters:
markers- the list of markers to choose from- Returns:
- the chosen marker or
nullif none of the given markers has a marker annotation in the model
-
getAnnotationAccessExtension
Returns the annotation access extension.- Returns:
- the annotation access extension or
nullif this action's editor has no such extension - Since:
- 3.0
-
getResource
Returns the resource for which to create the marker, ornullif there is no applicable resource.- Returns:
- the resource for which to create the marker or
null
-
getAnnotationModel
Returns theAbstractMarkerAnnotationModelof the editor's input.- Returns:
- the marker annotation model or
nullif there's none
-
getDocument
Returns theIDocumentof the editor's input.- Returns:
- the document of the editor's input
-
includesRulerLine
Checks whether a position includes the ruler's line of activity.- Parameters:
position- the position to be checkeddocument- the document the position refers to- Returns:
trueif the line is included by the given position
-
handleCoreException
Handles core exceptions. This implementation logs the exceptions with the workbench plug-in and shows an error dialog.- Parameters:
exception- the exception to be handledmessage- the message to be logged with the given exception
-
getMarkers
Returns all markers which include the ruler's line of activity.- Returns:
- an unmodifiable list with all markers which include the ruler's line of activity
-
hasMarkers
protected final boolean hasMarkers()Returnstrueiff there are any markers which include the ruler's line of activity.- Returns:
trueiff there are any markers which include the ruler's line of activity.- Since:
- 3.3
-
SelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo)