All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.java.swing.text.Caret

public interface Caret
A place within a document view that represents where things can be inserted into the document model. It gives a way to navigate through the document view while abstracting away the details of how the view is arranged. This can be useful because some views may filter out portions of the associated model, and some views may not allow navigation in certain areas such as read-only areas.

Method Index

o addChangeListener(ChangeListener)
Adds a listener to track whenever the caret position has been changed.
o deinstall(JTextComponent)
Called when the UI is being removed from the interface of a JTextComponent.
o getBlinkRate()
Gets the blink rate of the caret.
o getDot()
Fetches the current position of the caret.
o getMagicCaretPosition()
Gets the current caret position.
o getMark()
Fetches the current position of the mark.
o install(JTextComponent)
Called when the UI is being installed into the interface of a JTextComponent.
o isSelectionVisible()
Determines if the selection is currently visible.
o isVisible()
Determines if the caret is currently visible.
o moveDot(int)
Moves the caret position to some other position, leaving behind the mark.
o paint(Graphics)
Renders the caret.
o removeChangeListener(ChangeListener)
Removes a listener that was tracking caret position changes.
o setBlinkRate(int)
Sets the blink rate of the caret.
o setDot(int)
Sets the caret position to some position.
o setMagicCaretPosition(Point)
Saves the current caret position.
o setSelectionVisible(boolean)
Sets the visibility of the selection
o setVisible(boolean)
Sets the visibility of the caret.

Methods

o install 
 public abstract void install(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.

Parameters:
c - the JTextComponent
o deinstall 
 public abstract void deinstall(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.

Parameters:
c - the JTextComponent
o paint 
 public abstract void paint(Graphics g)
Renders the caret.

Parameters:
g - the graphics context
o addChangeListener 
 public abstract void addChangeListener(ChangeListener l)
Adds a listener to track whenever the caret position has been changed.

Parameters:
l - the change listener
o removeChangeListener 
 public abstract void removeChangeListener(ChangeListener l)
Removes a listener that was tracking caret position changes.

Parameters:
l - the change listener
o isVisible 
 public abstract boolean isVisible()
Determines if the caret is currently visible.

Returns:
true if the caret is visible else false
o setVisible 
 public abstract void setVisible(boolean v)
Sets the visibility of the caret.

Parameters:
v - true if the caret should be shown, and false if the caret should be hidden
o isSelectionVisible 
 public abstract boolean isSelectionVisible()
Determines if the selection is currently visible.

Returns:
true if the caret is visible else false
o setSelectionVisible 
 public abstract void setSelectionVisible(boolean v)
Sets the visibility of the selection

Parameters:
v - true if the caret should be shown, and false if the caret should be hidden
o setMagicCaretPosition 
 public abstract void setMagicCaretPosition(Point p)
Saves the current caret position. This is used when caret up or down actions occur, moving between lines that have uneven end positions.

Parameters:
p - the Point to use for the saved position
o getMagicCaretPosition 
 public abstract Point getMagicCaretPosition()
Gets the current caret position.

Returns:
the position
See Also:
setMagicCaretPosition
o setBlinkRate 
 public abstract 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.

Parameters:
rate - the delay in milliseconds >= 0. If this is zero the caret will not blink.
o getBlinkRate 
 public abstract 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.

Returns:
s the delay in milliseconds >= 0. If this is zero the caret will not blink.
o getDot 
 public abstract int getDot()
Fetches the current position of the caret.

Returns:
the position >= 0
o getMark 
 public abstract int getMark()
Fetches the current position of the mark. If there is a selection, the mark will not be the same as the dot.

Returns:
the position >= 0
o setDot 
 public abstract 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.

Parameters:
dot - the new position to set the caret to >= 0
o moveDot 
 public abstract void moveDot(int dot)
Moves the caret position to some other position, leaving behind the mark. This is useful for making selections.

Parameters:
dot - the new position to move the caret to >= 0 
All Packages  Class Hierarchy  This Package  Previous  Next  Index