File	Doc	Category	Size	Date	Package
Caret.java	API Doc	Java SE 6 API	5673	Tue Jun 10 00:26:56 BST 2008	javax.swing.text

Caret

Fields Summary

Constructors Summary

Methods Summary
public void	addChangeListener(javax.swing.event.ChangeListener l) Adds a listener to track whenever the caret position has been changed. param l the change listener
public void	deinstall(javax.swing.text.JTextComponent c) Called when the UI is being removed from the interface of a JTextComponent. This is used to unregister any listeners that were attached. param c the JTextComponent
public int	getBlinkRate() Gets the blink rate of the caret. This determines if and how fast the caret blinks, commonly used as one way to attract attention to the caret. return the delay in milliseconds >= 0. If this is zero the caret will not blink.
public int	getDot() Fetches the current position of the caret. return the position >= 0
public java.awt.Point	getMagicCaretPosition() Gets the current caret visual location. return the visual position. see #setMagicCaretPosition
public int	getMark() Fetches the current position of the mark. If there is a selection, the mark will not be the same as the dot. return the position >= 0
public void	install(javax.swing.text.JTextComponent c) Called when the UI is being installed into the interface of a JTextComponent. This can be used to gain access to the model that is being navigated by the implementation of this interface. param c the JTextComponent
public boolean	isSelectionVisible() Determines if the selection is currently visible. return true if the caret is visible else false
public boolean	isVisible() Determines if the caret is currently visible. return true if the caret is visible else false
public void	moveDot(int dot) Moves the caret position (dot) to some other position, leaving behind the mark. This is useful for making selections. param dot the new position to move the caret to >= 0
public void	paint(java.awt.Graphics g) Renders the caret. This method is called by UI classes. param g the graphics context
public void	removeChangeListener(javax.swing.event.ChangeListener l) Removes a listener that was tracking caret position changes. param l the change listener
public void	setBlinkRate(int rate) Sets the blink rate of the caret. This determines if and how fast the caret blinks, commonly used as one way to attract attention to the caret. param rate the delay in milliseconds >= 0. If this is zero the caret will not blink.
public void	setDot(int dot) Sets the caret position to some position. This causes the mark to become the same as the dot, effectively setting the selection range to zero. If the parameter is negative or beyond the length of the document, the caret is placed at the beginning or at the end, respectively. param dot the new position to set the caret to
public void	setMagicCaretPosition(java.awt.Point p) Set the current caret visual location. This can be used when moving between lines that have uneven end positions (such as when caret up or down actions occur). If text flows left-to-right or right-to-left the x-coordinate will indicate the desired navigation location for vertical movement. If the text flow is top-to-bottom, the y-coordinate will indicate the desired navigation location for horizontal movement. param p the Point to use for the saved position. This can be null to indicate there is no visual location.
public void	setSelectionVisible(boolean v) Sets the visibility of the selection param v true if the caret should be shown, and false if the caret should be hidden
public void	setVisible(boolean v) Sets the visibility of the caret. param v true if the caret should be shown, and false if the caret should be hidden