Package org.eclipse.ui.texteditor
Class MarkerRulerAction
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.MarkerRulerAction
- Direct Known Subclasses:
MarkerRulerInfoAction
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 sub-classing.
- 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
ConstructorsConstructorDescriptionMarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor, String markerType, boolean askForLabel) Deprecated.MarkerRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor, IVerticalRulerInfo ruler, String markerType, boolean askForLabel) Creates a new action for the given ruler and editor. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidCreates a new marker according to the specification of this action and adds it to the marker resource.protected booleanaskForLabel(Map<String, Object> attributes) Asks the user for a marker label.protected AbstractMarkerAnnotationModelReturns theAbstractMarkerAnnotationModelof the editor's input.protected IDocumentReturns theIDocumentof the editor's input.Returns the attributes with which a newly created marker will be initialized.protected StringgetLabelProposal(IDocument document, int offset, int length) Returns the initial label for the marker.Returns all markers which include the ruler's line of activity.protected IResourceReturns the resource for which to create the marker, ornullif there is no applicable resource.protected ResourceBundleReturns this action's resource bundle.protected StringReturns this action's resource key prefix.protected ITextEditorReturns this action's text editor.protected IVerticalRulerDeprecated.usegetVerticalRulerInfoinsteadprotected IVerticalRulerInfoReturns this action's vertical ruler info.protected voidhandleCoreException(CoreException exception, String message) Handles core exceptions.protected booleanincludesRulerLine(Position position, IDocument document) Checks whether a position includes the ruler's line of activity.protected voidremoveMarkers(List<? extends IMarker> markers) Removes the given markers.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
-
MarkerRulerAction
public MarkerRulerAction(ResourceBundle bundle, String prefix, ITextEditor editor, IVerticalRulerInfo ruler, String markerType, boolean askForLabel) 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 rulermarkerType- the type of markeraskForLabel-trueif the user should be asked for a label when a new marker is created- Since:
- 2.0
- See Also:
-
MarkerRulerAction
@Deprecated public MarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor, String markerType, boolean askForLabel) Deprecated.useMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo, String, boolean)insteadCreates 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 editormarkerType- the type of the markeraskForLabel-trueif the user should be asked for a label
-
-
Method Details
-
getTextEditor
Returns this action's text editor.- Returns:
- this action's text editor
-
getVerticalRuler
Deprecated.usegetVerticalRulerInfoinsteadReturns this action's vertical ruler.- Returns:
- this action's vertical ruler
-
getVerticalRulerInfo
Returns this action's vertical ruler info.- Returns:
- this action's vertical ruler info
- Since:
- 2.0
-
getResourceBundle
Returns this action's resource bundle.- Returns:
- this action's resource bundle
-
getResourceKeyPrefix
Returns this action's resource key prefix.- Returns:
- this action's resource key prefix
-
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. -
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
-
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:
- all a list of markers which include the ruler's line of activity
-
addMarker
protected void addMarker()Creates a new marker according to the specification of this action and adds it to the marker resource. -
removeMarkers
Removes the given markers.- Parameters:
markers- the markers to be deleted
-
askForLabel
Asks the user for a marker label. Returnstrueif a label is entered,falseif the user cancels the input dialog. Sets the value of the attributemessagein the given map of attributes.- Parameters:
attributes- the map of attributes- Returns:
trueif the map of attributes has successfully been initialized
-
getInitialAttributes
Returns the attributes with which a newly created marker will be initialized.- Returns:
- the initial marker attributes
-
getLabelProposal
Returns the initial label for the marker.- Parameters:
document- the document from which to extract a label proposaloffset- the document offset of the range from which to extract the label proposallength- the length of the range from which to extract the label proposal- Returns:
- the label proposal
- Since:
- 3.0
-
MarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo, String, boolean)instead