javax.swing.text
public interface Caret
| Method Summary | |
|---|---|
| void | addChangeListener(ChangeListener l)
Registers a {@link 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 {@link 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. |
Caret changes.
Parameters: l the listener to register to this caret
Caret from the specified text component.
This usually involves removing listeners from the text component.
This method is called by {@link JTextComponent#setCaret(Caret)} before
this caret is removed from the text component.
Parameters: c the text component to deinstall this caret from
Caret in milliseconds.
A value of 0 means that the caret does not blink.
Returns: the blink rate of this Caret or 0 if
this caret does not blink
Caret within the
Document.
Returns: the current position of this Caret within the
Document
Caret.
Returns: the current visual position of this Caret
See Also: Caret
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.
Returns: the current position of the mark
Caret on the specified text component. This
usually involves setting up listeners.
This method is called by {@link JTextComponent#setCaret(Caret)} after
this caret has been set on the text component.
Parameters: c the text component to install this caret to
true if the selection is currently visible,
false otherwise.
Returns: true if the selection is currently visible,
false otherwise
true if this Caret is currently visible,
and false if it is not.
Returns: true if this Caret is currently visible,
and false if it is not
dot location without touching the
mark. This is used when making a selection.
Parameters: dot the location where to move the dot
See Also: Caret
Caret to the specified Graphics
context.
Parameters: g the graphics context to render to
Parameters: l the listener to remove
Caret in milliseconds.
A value of 0 means that the caret does not blink.
Parameters: rate the new blink rate to set
Caret within the
Document. This also sets the mark to the
new location.
Parameters: dot the new position to be set
See Also: Caret
Caret.
Parameters: p the Point to use for the saved location. May be null
to indicate that there is no visual location
Parameters: v true if the selection should be visible,
false otherwise
true shows the
Caret, false hides it.
Parameters: v the visibility to set