javax.swing.text
public interface Caret
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ChangeListener l)
Registers a
ChangeListener that is notified whenever that state
of this Caret changes. |
void |
deinstall(JTextComponent c)
Deinstalls this
Caret from the specified text component. |
int |
getBlinkRate()
Returns the blink rate of this
Caret in milliseconds. |
int |
getDot()
Returns the current position of this
Caret within the
Document . |
Point |
getMagicCaretPosition()
Returns the current visual position of this
Caret . |
int |
getMark()
Returns the current position of the
mark . |
void |
install(JTextComponent c)
Installs this
Caret on the specified text component. |
boolean |
isSelectionVisible()
Returns
true if the selection is currently visible,
false otherwise. |
boolean |
isVisible()
Returns
true if this Caret is currently visible,
and false if it is not. |
void |
moveDot(int dot)
Moves the
dot location without touching the
mark . |
void |
paint(Graphics g)
Paints this
Caret to the specified Graphics
context. |
void |
removeChangeListener(ChangeListener l)
Removes a
ChangeListener from the list of registered listeners. |
void |
setBlinkRate(int rate)
Sets the blink rate of this
Caret in milliseconds. |
void |
setDot(int dot)
Sets the current position of this
Caret within the
Document . |
void |
setMagicCaretPosition(Point p)
Sets the current visual position of this
Caret . |
void |
setSelectionVisible(boolean v)
Sets the visiblity state of the selection.
|
void |
setVisible(boolean v)
Sets the visibility state of the caret.
|
void addChangeListener(ChangeListener l)
ChangeListener
that is notified whenever that state
of this Caret
changes.l
- the listener to register to this caretvoid removeChangeListener(ChangeListener l)
ChangeListener
from the list of registered listeners.l
- the listener to removevoid install(JTextComponent c)
Caret
on the specified text component. This
usually involves setting up listeners.
This method is called by JTextComponent.setCaret(Caret)
after
this caret has been set on the text component.c
- the text component to install this caret tovoid deinstall(JTextComponent c)
Caret
from the specified text component.
This usually involves removing listeners from the text component.
This method is called by JTextComponent.setCaret(Caret)
before
this caret is removed from the text component.c
- the text component to deinstall this caret fromint getBlinkRate()
Caret
in milliseconds.
A value of 0
means that the caret does not blink.Caret
or 0
if
this caret does not blinkvoid setBlinkRate(int rate)
Caret
in milliseconds.
A value of 0
means that the caret does not blink.rate
- the new blink rate to setint getDot()
Caret
within the
Document
.Caret
within the
Document
void setDot(int dot)
Caret
within the
Document
. This also sets the mark
to the
new location.dot
- the new position to be setmoveDot(int)
void moveDot(int dot)
dot
location without touching the
mark
. This is used when making a selection.dot
- the location where to move the dotsetDot(int)
int getMark()
mark
. The
mark
marks the location in the Document
that
is the end of a selection. If there is no selection, the mark
is the same as the dot
.Point getMagicCaretPosition()
Caret
.Caret
setMagicCaretPosition(java.awt.Point)
void setMagicCaretPosition(Point p)
Caret
.p
- the Point to use for the saved location. May be null
to indicate that there is no visual locationboolean isSelectionVisible()
true
if the selection is currently visible,
false
otherwise.true
if the selection is currently visible,
false
otherwisevoid setSelectionVisible(boolean v)
v
- true
if the selection should be visible,
false
otherwiseboolean isVisible()
true
if this Caret
is currently visible,
and false
if it is not.true
if this Caret
is currently visible,
and false
if it is notvoid setVisible(boolean v)
true
shows the
Caret
, false
hides it.v
- the visibility to set