|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.action.Action
org.eclipse.ui.texteditor.ResourceAction
org.eclipse.ui.texteditor.SelectMarkerRulerAction
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.
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, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT |
Constructor Summary | |
SelectMarkerRulerAction(ResourceBundle bundle,
String prefix,
ITextEditor editor,
IVerticalRulerInfo ruler)
Creates a new action for the given ruler and editor. |
|
SelectMarkerRulerAction(ResourceBundle bundle,
String prefix,
IVerticalRuler ruler,
ITextEditor editor)
Deprecated. As of 3.0, replaced by SelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo) |
Method Summary | |
protected IMarker |
chooseMarker(List markers)
Chooses the marker with the highest layer. |
protected IAnnotationAccessExtension |
getAnnotationAccessExtension()
Returns the annotation access extension. |
protected AbstractMarkerAnnotationModel |
getAnnotationModel()
Returns the AbstractMarkerAnnotationModel of the editor's input. |
protected IDocument |
getDocument()
Returns the IDocument of the editor's input. |
protected List |
getMarkers()
Returns all markers which include the ruler's line of activity. |
protected IResource |
getResource()
Returns the resource for which to create the marker, or null if there is no applicable resource. |
protected void |
handleCoreException(CoreException exception,
String message)
Handles core exceptions. |
protected boolean |
includesRulerLine(Position position,
IDocument document)
Checks whether a position includes the ruler's line of activity. |
void |
run()
The default implementation of this IAction method
does nothing. |
void |
update()
Requests that this object update itself. |
Methods inherited from class org.eclipse.ui.texteditor.ResourceAction |
getString, initialize, setHelpContextId |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SelectMarkerRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor, IVerticalRulerInfo ruler)
bundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keys
(described in ResourceAction
constructor), or null
if noneeditor
- the editorruler
- the rulerResourceAction.ResourceAction(ResourceBundle, String)
public SelectMarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor)
SelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo)
SelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo)
Method Detail |
public void update()
IUpdate
update
in interface IUpdate
public void run()
Action
IAction
method
does nothing. Subclasses should override this method
if they do not need information from the triggering event,
or override runWithEvent(Event)
if they do.
run
in interface IAction
run
in class Action
protected IMarker chooseMarker(List markers)
markers
- the list of markers to choose from
protected IAnnotationAccessExtension getAnnotationAccessExtension()
null
if
this action's editor has no such extensionprotected IResource getResource()
null
if there is no applicable resource.
null
protected AbstractMarkerAnnotationModel getAnnotationModel()
AbstractMarkerAnnotationModel
of the editor's input.
null
if there's noneprotected IDocument getDocument()
IDocument
of the editor's input.
protected boolean includesRulerLine(Position position, IDocument document)
position
- the position to be checkeddocument
- the document the position refers to
true
if the line is included by the given positionprotected void handleCoreException(CoreException exception, String message)
exception
- the exception to be handledmessage
- the message to be logged with the given exceptionprotected List getMarkers()
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.