public class LineGutterPlugin.Column.Mark extends java.lang.Object implements GutterMark
MARK_OPTION_NONE, MARK_OPTION_SHOW_IN_FILE_OVERVIEW_MARGIN, MARK_OPTION_STATIONARY, MARK_OPTION_SUPPORTS_CLICKS
Modifier | Constructor and Description |
---|---|
protected |
LineGutterPlugin.Column.Mark(int line,
int lineStart,
javax.swing.Icon icon,
HighlightStyle highlightStyle,
int markOrder,
int markOptions,
java.awt.Color overviewColor)
Constructs a new Mark.
|
Modifier and Type | Method and Description |
---|---|
Gutter |
getGutter()
Fetches the Gutter that this mark has been created in.
|
GutterColumn |
getGutterColumn()
Fetches the
GutterColumn that this mark was created in |
HighlightStyle |
getHighlightStyle()
Fetches the HighlightStyle associated with this GutterMark when
it was created.
|
javax.swing.Icon |
getIcon()
Gets the Icon that is associated with this GutterMark.
|
int |
getLine()
Fetches the line that this GutterMark is currently located on.
|
protected int |
getOffset()
Fetches the offset that this GutterMark is tracking.
|
protected int |
getOptions()
Fetch the options for this mark.
|
int |
getOrder()
Fetch the ordering that this GutterMark is currently using.
|
int |
getSelectionLength() |
int |
getSelectionStart() |
java.lang.String |
getToolTipText(java.awt.event.MouseEvent mouseEvent) |
java.lang.Object |
getUserData()
Fetch the user data object set by a prior call to
setUserData() for this mark. |
boolean |
isOptionSet(int optionFlag)
Fetch whether the given option is set or not.
|
boolean |
isVisible()
Fetch whether this mark should be visible.
|
protected void |
removeHighlight()
Utility routine to remove the highlight when the mark is
removed.
|
void |
setIcon(javax.swing.Icon icon)
Sets the icon associated with this GutterMark.
|
protected void |
setLine(int newLine)
Changes the line that this GutterMark is tracking.
|
protected void |
setOffset(int offset)
Changes the offset that this GutterMark is tracking.
|
void |
setUserData(java.lang.Object userData)
Stores an opaque, user-defined object to be associated with this
GutterMark instance. |
void |
setVisible(boolean visible)
Sets whether this mark should be visible or not.
|
protected void |
updateHighlight(LineMap lineMap)
Utility routine to create or update the highlight when
the mark is created or moved.
|
protected LineGutterPlugin.Column.Mark(int line, int lineStart, javax.swing.Icon icon, HighlightStyle highlightStyle, int markOrder, int markOptions, java.awt.Color overviewColor)
protected void updateHighlight(LineMap lineMap)
protected void removeHighlight()
protected void setLine(int newLine)
newLine
- the new line of the markprotected int getOffset()
protected void setOffset(int offset)
offset
- the new offset of the markpublic boolean isOptionSet(int optionFlag)
optionFlag
- the option to checkprotected int getOptions()
public GutterColumn getGutterColumn()
GutterColumn
that this mark was created ingetGutterColumn
in interface GutterMark
public Gutter getGutter()
getGutter
in interface GutterMark
public javax.swing.Icon getIcon()
getIcon
in interface GutterMark
public void setIcon(javax.swing.Icon icon)
setIcon
in interface GutterMark
public HighlightStyle getHighlightStyle()
getHighlightStyle
in interface GutterMark
public int getLine()
getLine
in interface GutterMark
public int getOrder()
getOrder
in interface GutterMark
public void setVisible(boolean visible)
setVisible
in interface GutterMark
visible
- whether this mark should be visiblepublic boolean isVisible()
isVisible
in interface GutterMark
public java.lang.Object getUserData()
setUserData()
for this mark.getUserData
in interface GutterMark
public void setUserData(java.lang.Object userData)
GutterMark
instance. This user-defined object will
be returned by getUserData()
. Note that if this
mark is removed, this user object will become garbage-collectable
unless a client holds an additional reference to it.setUserData
in interface GutterMark
userData
- the user data object to associate with this markpublic java.lang.String getToolTipText(java.awt.event.MouseEvent mouseEvent)
public int getSelectionStart()
public int getSelectionLength()