All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.DefaultCaret 

java.lang.Object
   |
   +----com.sun.java.swing.text.DefaultCaret
public class DefaultCaret
extends Object
implements Caret, Serializable
An implementation of Caret for a view that maps over the entire portion of the model represented (ie there are no holes in the area represented) and renders the insert position as a vertical line. The foreground color of the component is the color of the caret and the background color of the component is the color of the selections made by moving the caret. The Highlighter implementation of the associated UI is used to actually render the selection.

See Also:
Caret

Variable Index

o changeEvent
o listenerList

Constructor Index

o DefaultCaret()
Constructs a caret with given color settings.

Method Index

o addChangeListener(ChangeListener)
Adds a listener to track whenever the caret position has been changed.
o adjustVisibility(Rectangle)
Scrolls the associated view (if necessary) to make the caret visible.
o damage(Rectangle)
Damages the area surrounding the caret to cause it to be repainted.
o deinstall(JTextComponent)
Called when the UI is being removed from the interface of a JTextComponent.
o fireStateChanged()
o getComponent()
o getDot()
Fetches the current position of the caret.
o getMagicCaretPosition()
Gets the saved caret position.
o getMark()
Fetches the current position of the mark.
o getSelectionPainter()
o install(JTextComponent)
Called when the UI is being installed into the interface of a JTextComponent.
o isVisible()
Determines if the caret is currently visible.
o moveDot(int)
Moves the caret position to some other position.
o paint(Graphics)
Renders the caret as a vertical line.
o removeChangeListener(ChangeListener)
Removes a listener that was tracking caret position changes.
o setBlinkRate(int)
Sets the caret blink rate.
o setDot(int)
Sets the caret position and mark to some position.
o setMagicCaretPosition(Point)
Saves the current caret position.
o setVisible(boolean)
Sets the caret visibility.

Variables

o listenerList 
 protected EventListenerList listenerList
o changeEvent 
 protected ChangeEvent changeEvent

Constructors

o DefaultCaret 
 public DefaultCaret()
Constructs a caret with given color settings.

Parameters:
c - the caret color
h - the highlight color for selections (that is, indicating the range spaned by the dot/mark combination)

Methods

o getComponent 
 protected final JTextComponent getComponent()
o damage 
 protected void damage(Rectangle r)
Damages the area surrounding the caret to cause it to be repainted. If paint() is reimplemented, this method should also be reimplemented.

Parameters:
r - the current location of the caret
See Also:
paint
o adjustVisibility 
 protected void adjustVisibility(Rectangle nloc)
Scrolls the associated view (if necessary) to make the caret visible. Since how this should be done is somewhat of a policy, this method can be reimplemented to change the behavior. By default the scrollRectToVisible method is called on the associated component.

Parameters:
nloc - the new position
o getSelectionPainter 
 protected Highlighter. HighlightPainter getSelectionPainter()
o paint 
 public void paint(Graphics g)
Renders the caret as a vertical line. If this is reimplemented the damage method should also be reimplemented as it assumes the shape of the caret is a vertical line.

Parameters:
g - the graphics context
See Also:
damage
o install 
 public 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 component
See Also:
install
o deinstall 
 public 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 component
See Also:
deinstall
o addChangeListener 
 public void addChangeListener(ChangeListener l)
Adds a listener to track whenever the caret position has been changed.

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

Parameters:
l - the listener
See Also:
removeChangeListener
o fireStateChanged 
 protected void fireStateChanged()
o isVisible 
 public boolean isVisible()
Determines if the caret is currently visible.

Returns:
true if visible else false
See Also:
isVisible
o setVisible 
 public void setVisible(boolean e)
Sets the caret visibility.

Parameters:
e - the visibility specifier
See Also:
setVisible
o setBlinkRate 
 public void setBlinkRate(int rate)
Sets the caret blink rate.

Parameters:
rate - the rate
See Also:
setBlinkRate
o getDot 
 public int getDot()
Fetches the current position of the caret.

Returns:
the position
See Also:
getDot
o getMark 
 public int getMark()
Fetches the current position of the mark. If there is a selection, the dot and mark will not be the same.

Returns:
the position
See Also:
getMark
o setDot 
 public void setDot(int dot)
Sets the caret position and mark to some position. This implicitly sets the selection range to zero.

Parameters:
dot - the position
See Also:
setDot
o moveDot 
 public void moveDot(int dot)
Moves the caret position to some other position.

Parameters:
dot - the position
See Also:
moveDot
o setMagicCaretPosition 
 public void setMagicCaretPosition(Point p)
Saves the current caret position. This is used when caret up/down actions occur, moving between lines that have uneven end positions.

Parameters:
p - the position
See Also:
getMagicCaretPosition, UpAction, DownAction
o getMagicCaretPosition 
 public Point getMagicCaretPosition()
Gets the saved caret position.

Returns:
the position see #setMagicCaretPosition 
All Packages  Class Hierarchy  This Package  Previous  Next  Index