javax.swing.text

Interface Caret

All Known Implementing Classes:

BasicTextUI.BasicCaret, DefaultCaret

public interface Caret

Defines the method to be implemented by a caret that can be used in Swing text components.

Method Summary

Methods

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.

Method Detail

addChangeListener

void addChangeListener(ChangeListener l)

Registers a ChangeListener that is notified whenever that state of this Caret changes.

Parameters:

l - the listener to register to this caret

removeChangeListener

void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the list of registered listeners.

Parameters:

l - the listener to remove

install

void install(JTextComponent c)

Installs this 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.

Parameters:

c - the text component to install this caret to

deinstall

void deinstall(JTextComponent c)

Deinstalls this 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.

Parameters:

c - the text component to deinstall this caret from

getBlinkRate

int getBlinkRate()

Returns the blink rate of this 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

setBlinkRate

void setBlinkRate(int rate)

Sets the blink rate of this Caret in milliseconds. A value of 0 means that the caret does not blink.

Parameters:

rate - the new blink rate to set

getDot

int getDot()

Returns the current position of this Caret within the Document.

Returns:

the current position of this Caret within the Document

setDot

void setDot(int dot)

Sets the current position of this Caret within the Document. This also sets the mark to the new location.

Parameters:

dot - the new position to be set

See Also:

moveDot(int)

moveDot

void moveDot(int dot)

Moves the dot location without touching the mark. This is used when making a selection.

Parameters:

dot - the location where to move the dot

See Also:

setDot(int)

getMark

int getMark()

Returns the current position of the 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

getMagicCaretPosition

Point getMagicCaretPosition()

Returns the current visual position of this Caret.

Returns:

the current visual position of this Caret

See Also:

setMagicCaretPosition(java.awt.Point)

setMagicCaretPosition

void setMagicCaretPosition(Point p)

Sets the current visual position of this Caret.

Parameters:

p - the Point to use for the saved location. May be null to indicate that there is no visual location

isSelectionVisible

boolean isSelectionVisible()

Returns true if the selection is currently visible, false otherwise.

Returns:

true if the selection is currently visible, false otherwise

setSelectionVisible

void setSelectionVisible(boolean v)

Sets the visiblity state of the selection.

Parameters:

v - true if the selection should be visible, false otherwise

isVisible

boolean isVisible()

Returns 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

setVisible

void setVisible(boolean v)

Sets the visibility state of the caret. true shows the Caret, false hides it.

Parameters:

v - the visibility to set

paint

void paint(Graphics g)

Paints this Caret to the specified Graphics context.

Parameters:

g - the graphics context to render to