|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.action.Action | +--org.eclipse.ui.texteditor.ResourceAction | +--org.eclipse.ui.texteditor.MarkerRulerAction
A ruler action which can add and remove markers which have a visual representation in the ruler.
This class may be instantiated but is not intended for subclassing.
Field Summary |
Fields inherited from interface org.eclipse.jface.action.IAction |
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT |
Constructor Summary | |
MarkerRulerAction(ResourceBundle bundle,
String prefix,
ITextEditor editor,
IVerticalRulerInfo ruler,
String markerType,
boolean askForLabel)
Creates a new action for the given ruler and editor. |
|
MarkerRulerAction(ResourceBundle bundle,
String prefix,
IVerticalRuler ruler,
ITextEditor editor,
String markerType,
boolean askForLabel)
Deprecated. use MarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo, String, boolean) instead |
Method Summary | |
protected void |
addMarker()
Creates a new marker according to the specification of this action and adds it to the marker resource. |
protected boolean |
askForLabel(Map attributes)
Asks the user for a marker label. |
protected AbstractMarkerAnnotationModel |
getAnnotationModel()
Returns the AbstractMarkerAnnotationModel of the editor's input. |
protected IDocument |
getDocument()
Returns the IDocument of the editor's input. |
protected Map |
getInitialAttributes()
Returns the attributes with which a newly created marker will be initialized. |
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 ResourceBundle |
getResourceBundle()
Returns this action's resource bundle. |
protected String |
getResourceKeyPrefix()
Returns this action's resource key prefix. |
protected ITextEditor |
getTextEditor()
Returns this action's editor. |
protected IVerticalRuler |
getVerticalRuler()
Deprecated. use getVerticalRulerInfo instead |
protected IVerticalRulerInfo |
getVerticalRulerInfo()
Returns this action's vertical ruler info. |
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. |
protected void |
removeMarkers(List markers)
Removes the given markers. |
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, setHelpContextId |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MarkerRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor, IVerticalRulerInfo ruler, String markerType, boolean askForLabel)
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 rulermarkerType
- the type of markeraskForLabel
- true
if the user should be asked for a label when a new marker is createdResourceAction.ResourceAction(java.util.ResourceBundle, java.lang.String)
public MarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor, String markerType, boolean askForLabel)
MarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo, String, boolean)
instead
Method Detail |
protected ITextEditor getTextEditor()
protected IVerticalRuler getVerticalRuler()
getVerticalRulerInfo
instead
protected IVerticalRulerInfo getVerticalRulerInfo()
protected ResourceBundle getResourceBundle()
protected String getResourceKeyPrefix()
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 run(Event)
if they do.
run
in interface IAction
run
in class Action
protected IResource getResource()
null
if there is no applicable resource.
null
protected AbstractMarkerAnnotationModel getAnnotationModel()
AbstractMarkerAnnotationModel
of the editor's input.
protected 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()
protected void addMarker()
protected void removeMarkers(List markers)
markers
- the markers to be deletedprotected boolean askForLabel(Map attributes)
true
if a label
is entered, false
if the user cancels the input dialog.
Sets the value of the attribute message
in the given
map of attributes.
attributes
- the map of attributes
true
if the map of attributes has successfuly been initializedprotected Map getInitialAttributes()
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |