public final class LineHighlightPlugin extends java.lang.Object implements javax.swing.event.CaretListener, javax.swing.event.DocumentListener, EditorPlugin
LineHighlightPlugin
is an editor plugin which
applies a background highlight to the current caret line. This
background highlight will always track the current line so if the
user applies edits or moves the caret, the line highlight will move
with it. Note that the line highlight is currently disabled by
default. Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CARET_LINE_HIGHLIGHT
The name of the line highlight.
|
static int |
DEFAULT_LINE_PRIORITY
The default priority level given to the line highlight.
|
Constructor and Description |
---|
LineHighlightPlugin()
Constructs a new
LineHighlightPlugin instance that |
Modifier and Type | Method and Description |
---|---|
void |
caretUpdate(javax.swing.event.CaretEvent event)
Called when the caret position is updated.
|
void |
changedUpdate(javax.swing.event.DocumentEvent event)
Gives notification that an attribute or set of attributes changed.
|
void |
deinstall(BasicEditorPane editor)
Called when the plugin is being removed from the BasicEditorPane
(for example when the editor is closed.) This is used to notify
plugins that they should unregister any listeners that were
attached.
|
void |
insertUpdate(javax.swing.event.DocumentEvent event)
Gives notification that there was an insert into the document.
|
void |
install(BasicEditorPane editor)
Called when this plugin is being installed into the BasicEditorPane.
|
void |
propertyChange(java.beans.PropertyChangeEvent event)
This method gets called when a bound property is changed.
|
static void |
registerHighlights() |
void |
removeUpdate(javax.swing.event.DocumentEvent event)
Gives notification that a portion of the document has been
removed.
|
public static final int DEFAULT_LINE_PRIORITY
public static final java.lang.String CARET_LINE_HIGHLIGHT
public LineHighlightPlugin()
LineHighlightPlugin
instance thatpublic void install(BasicEditorPane editor)
install
in interface EditorPlugin
editor
- the editor panepublic void deinstall(BasicEditorPane editor)
deinstall
in interface EditorPlugin
editor
- the editor panepublic void propertyChange(java.beans.PropertyChangeEvent event)
propertyChange
in interface java.beans.PropertyChangeListener
event
- A PropertyChangeEvent object describing the event source
and the property that has changed.public void caretUpdate(javax.swing.event.CaretEvent event)
caretUpdate
in interface javax.swing.event.CaretListener
event
- the caret eventpublic void insertUpdate(javax.swing.event.DocumentEvent event)
insertUpdate
in interface javax.swing.event.DocumentListener
event
- the document eventpublic void removeUpdate(javax.swing.event.DocumentEvent event)
removeUpdate
in interface javax.swing.event.DocumentListener
event
- the document eventpublic void changedUpdate(javax.swing.event.DocumentEvent event)
changedUpdate
in interface javax.swing.event.DocumentListener
event
- the document eventpublic static void registerHighlights()