com.ibm.lpex.alef
Class LpexMarkerRulerAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.texteditor.ResourceAction
              |
              +--org.eclipse.ui.texteditor.MarkerRulerAction
                    |
                    +--com.ibm.lpex.alef.LpexMarkerRulerAction

All Implemented Interfaces:

org.eclipse.jface.action.IAction, org.eclipse.ui.texteditor.IUpdate

public class LpexMarkerRulerAction

extends org.eclipse.ui.texteditor.MarkerRulerAction

Variation of MarkerRulerAction for LPEX. A ruler action which can add and remove markers which have a visual representation in the vertical ruler.

IDocument is not kept up-to-date, therefore the latest marker information is only available from LPEX's corresponding marks. Note that includesRulerLine(Position position, IDocument document) is not supported in LpexMarkerRulerAction.

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

LpexMarkerRulerAction(java.util.ResourceBundle bundle, java.lang.String key, org.eclipse.jface.text.source.IVerticalRuler ruler, org.eclipse.ui.texteditor.ITextEditor editor, java.lang.String markerType, boolean askForLabel)
Create a new action for the given ruler and editor.

Method Summary

protected java.util.Map	getInitialAttributes() Return the attributes with which a newly created marker will be initialized.
protected java.util.List	getMarkers() Return all markers which include the ruler's line of mouse activity.

Methods inherited from class org.eclipse.ui.texteditor.MarkerRulerAction

addMarker, askForLabel, getAnnotationModel, getDocument, getResource, getResourceBundle, getResourceKeyPrefix, getTextEditor, getVerticalRuler, handleCoreException, includesRulerLine, removeMarkers, run, update

Methods inherited from class org.eclipse.ui.texteditor.ResourceAction

getString, setHelpContextId

Methods inherited from class org.eclipse.jface.action.Action

addPropertyChangeListener, findKeyCode, findModifier, firePropertyChange, firePropertyChange, getAccelerator, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removeAcceleratorText, removePropertyChangeListener, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LpexMarkerRulerAction

public LpexMarkerRulerAction(java.util.ResourceBundle bundle,
                             java.lang.String key,
                             org.eclipse.jface.text.source.IVerticalRuler ruler,
                             org.eclipse.ui.texteditor.ITextEditor editor,
                             java.lang.String markerType,
                             boolean askForLabel)

Create a new action for the given ruler and editor. The action configures its visual representation from the given resource bundle.

Parameters:

bundle - the resource bundle

key - action's key prefix in the resource bundle, or null if none

ruler - the vertical ruler

editor - the text editor

markerType - the type of marker

askForLabel - true if the user should be asked for a label when a new marker is created

Method Detail

getInitialAttributes

protected java.util.Map getInitialAttributes()

Return the attributes with which a newly created marker will be initialized.

Overrides:

getInitialAttributes in class org.eclipse.ui.texteditor.MarkerRulerAction

Returns:

the initial marker attributes

getMarkers

protected java.util.List getMarkers()

Return all markers which include the ruler's line of mouse activity. Marks & markers are assumed to be defined inside the LPEX document section currently loaded & inside a corresponding IDocument.

Overrides:

getMarkers in class org.eclipse.ui.texteditor.MarkerRulerAction