public class MarkerRulerAction extends ResourceAction implements IUpdate
This class may be instantiated but is not intended for sub-classing.
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 and Description |
---|
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 |
Modifier and Type | Method and Description |
---|---|
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 String |
getLabelProposal(IDocument document,
int offset,
int length)
Returns the initial label for the marker.
|
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 text 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.
|
getString, initialize, setHelpContextId
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
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
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(ResourceBundle, String)
public MarkerRulerAction(ResourceBundle bundle, String prefix, IVerticalRuler ruler, ITextEditor editor, String markerType, boolean askForLabel)
MarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo, String, boolean)
insteadbundle
- the resource bundleprefix
- a prefix to be prepended to the various resource keysruler
- the rulereditor
- the editormarkerType
- the type of the markeraskForLabel
- true
if the user should be asked for a labelprotected ITextEditor getTextEditor()
protected IVerticalRuler getVerticalRuler()
getVerticalRulerInfo
insteadprotected IVerticalRulerInfo getVerticalRulerInfo()
protected ResourceBundle getResourceBundle()
protected String getResourceKeyPrefix()
public void update()
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
How radio buttons are handled
,
How check boxes are handled
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 totrue
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 attributestrue
if the map of attributes has successfully been initializedprotected Map getInitialAttributes()
String
, value type:
Object
)protected String getLabelProposal(IDocument document, int offset, int length)
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
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.