public interface GutterColumn<M extends GutterMark>
GutterColumn
interface describes the non-visual
container that is used for creating GutterMark
instances for displaying icons in a Gutter
.Gutter
,
GutterColumnListener
,
GutterMark
Modifier and Type | Field and Description |
---|---|
static int |
LAYOUT_MERGE_RESERVED_WIDTHS
Deprecated.
the gutter no longer uses reserved widths to determine sizing.
|
static int |
LAYOUT_OVERLAY
Layout constraint indicating that if icon(s) from this column and from
the referenced column are both present on a line, only those from this
column will be visible.
|
static int |
LAYOUT_UNCONSTRAINED
Layout constraint indicating that the layout of this columns is not constrained.
|
Modifier and Type | Method and Description |
---|---|
M |
addGutterMark(int line,
javax.swing.Icon icon,
HighlightStyle highlightStyle,
int markOrder,
int markOptions)
Adds a new
GutterMark to this column for the given
line. |
M |
addGutterMark(int line,
javax.swing.Icon icon,
HighlightStyle highlightStyle,
int markOrder,
int markOptions,
java.awt.Color overviewColor)
Adds a new
GutterMark to this column for the given
line. |
void |
beginBlockAdd()
Begins a block add.
|
void |
endBlockAdd()
Ends a block add.
|
java.lang.String |
getColumnName()
Fetch the name of this column.
|
Gutter |
getGutter()
Fetch the
Gutter instance that this column is
associated with. |
M[] |
lookupGutterMarks(int line)
Fetch the
GutterMark instances contained within
this column for the specified line (if any). |
void |
removeAllGutterMarks()
Removes all marks from this column.
|
void |
removeGutterMark(GutterMark mark)
Removes the mark from this column.
|
void |
setLayoutConstraint(java.lang.String column,
int constraint)
Sets a layout constraint on this column.
|
void |
setReservedWidth(int width)
Deprecated.
the gutter no longer uses reserved widths to determine sizing.
|
static final int LAYOUT_UNCONSTRAINED
@Deprecated static final int LAYOUT_MERGE_RESERVED_WIDTHS
static final int LAYOUT_OVERLAY
@Deprecated void setReservedWidth(int width)
width
- the width to reserve when no icon is displayed.void setLayoutConstraint(java.lang.String column, int constraint)
LAYOUT_UNCONSTRAINED
.column
- the name of the column referenced by the constraint.constraint
- the constraint to establish, either
LAYOUT_UNCONSTRAINED
,
LAYOUT_MERGE_RESERVED_WIDTHS
, or
LAYOUT_OVERLAY
.java.lang.IllegalArgumentException
- if the column name is the name of this
column.Gutter getGutter()
Gutter
instance that this column is
associated with.java.lang.String getColumnName()
M addGutterMark(int line, javax.swing.Icon icon, HighlightStyle highlightStyle, int markOrder, int markOptions)
GutterMark
to this column for the given
line. The provided icon will be displayed visually, and the
highlight used to highlight the entire line. If there is
a GutterColumnListener
associated with this
column, then it will receive notifications when the mark is
moved, removed, or clicked upon.line
- the line (1-based) on which to create the GutterMarkicon
- the icon to display visually on the given line of
the gutterhighlightStyle
- the highlight style to use for highlighting
the line, or null for no highlightmarkOrder
- the ordering to use for this mark (in relation to
other marks on the same line) for left-to-right positioningmarkOptions
- to affect user interaction with the mark, such
as GutterMark.MARK_OPTION_SUPPORTS_CLICKS
GutterMark
or null if the
line is invalidM addGutterMark(int line, javax.swing.Icon icon, HighlightStyle highlightStyle, int markOrder, int markOptions, java.awt.Color overviewColor)
GutterMark
to this column for the given
line. The provided icon will be displayed visually, and the
highlight used to highlight the entire line. If there is
a GutterColumnListener
associated with this
column, then it will receive notifications when the mark is
moved, removed, or clicked upon.line
- the line (1-based) on which to create the GutterMarkicon
- the icon to display visually on the given line of
the gutterhighlightStyle
- the highlight style to use for highlighting
the line, or null for no highlightmarkOrder
- the ordering to use for this mark (in relation to
other marks on the same line) for left-to-right positioningmarkOptions
- to affect user interaction with the mark, such
as GutterMark.MARK_OPTION_SUPPORTS_CLICKS
overviewColor
- color of the overview mark if option
GutterMark.MARK_OPTION_SHOW_IN_FILE_OVERVIEW_MARGIN
is set.GutterMark
or null if the
line is invalidvoid beginBlockAdd()
void endBlockAdd()
M[] lookupGutterMarks(int line)
GutterMark
instances contained within
this column for the specified line (if any).line
- the line to lookup gutter marks forvoid removeGutterMark(GutterMark mark)
mark
- the gutter mark to removevoid removeAllGutterMarks()