public class BasicEditorOverviewMark extends java.lang.Object implements OverviewMark<java.lang.Integer>, Disposable
The overview mark can be created with raw character offsets, and the offset mark will automatically update it's position as the buffer changes.
To account for code folding, the mark returns its getStart()/getEnd() locations in row, rather than line, number.
Constructor and Description |
---|
BasicEditorOverviewMark(BasicEditorPane editor,
java.lang.Integer startOffset,
java.lang.Integer endOffset,
float priority,
java.awt.Color color)
Create an overview mark.
|
BasicEditorOverviewMark(BasicEditorPane editor,
java.lang.Integer startOffset,
java.lang.Integer endOffset,
float priority,
java.awt.Color color,
boolean isStationary)
Create an overview mark.
|
BasicEditorOverviewMark(BasicEditorPane editor,
java.lang.Integer startOffset,
java.lang.Integer endOffset,
float priority,
java.awt.Color color,
boolean isStationary,
boolean autoRemove)
Create an overview mark.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(OverviewMark o) |
void |
dispose()
This mark is no longer used, call to free up resources it may have used.
|
java.awt.Color |
getColor() |
java.lang.Integer |
getEnd() |
java.lang.Integer |
getEndOffset() |
float |
getPriority() |
java.lang.Integer |
getStart() |
java.lang.Integer |
getStartOffset() |
protected javax.swing.JComponent |
getTipComponent(oracle.ide.hover.Hover hover) |
public BasicEditorOverviewMark(BasicEditorPane editor, java.lang.Integer startOffset, java.lang.Integer endOffset, float priority, java.awt.Color color)
The mark will automatically update its offsets as the text in the editor changes
editor
- startOffset
- character offset on which the mark beginsendOffset
- character offset on which the mark endspriority
- the priority of the markcolor
- the color to render the mark in the overviewpublic BasicEditorOverviewMark(BasicEditorPane editor, java.lang.Integer startOffset, java.lang.Integer endOffset, float priority, java.awt.Color color, boolean isStationary)
editor
- startOffset
- character offset on which the mark beginsendOffset
- character offset on which the mark endspriority
- the priority of the markcolor
- the color to render the mark in the overviewisStationary
- if true the mark will not automatically adjust its offsets as the text buffer changespublic BasicEditorOverviewMark(BasicEditorPane editor, java.lang.Integer startOffset, java.lang.Integer endOffset, float priority, java.awt.Color color, boolean isStationary, boolean autoRemove)
editor
- startOffset
- character offset on which the mark beginsendOffset
- character offset on which the mark endspriority
- the priority of the markcolor
- the color to render the mark in the overviewisStationary
- if true the mark will not automatically adjust its offsets as the text buffer changesautoRemove
- if true the mark will be automatically if its length becomes zeropublic java.lang.Integer getStart()
getStart
in interface OverviewMark<java.lang.Integer>
public java.lang.Integer getEnd()
getEnd
in interface OverviewMark<java.lang.Integer>
public java.lang.Integer getStartOffset()
public java.lang.Integer getEndOffset()
public java.awt.Color getColor()
getColor
in interface OverviewMark<java.lang.Integer>
public float getPriority()
getPriority
in interface OverviewMark<java.lang.Integer>
public void dispose()
dispose
in interface Disposable
protected javax.swing.JComponent getTipComponent(oracle.ide.hover.Hover hover)
hover
- the hover that will contain the tip.public int compareTo(OverviewMark o)
compareTo
in interface java.lang.Comparable<OverviewMark>