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, FocusListener, MouseListener, MouseMotionListener

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Caret

changeEvent

The change event for the model.

listenerList

The event listener list.

DefaultCaret()

Constructs a default caret.

addChangeListener(ChangeListener)

Adds a listener to track whenever the caret position has been changed.

adjustVisibility(Rectangle)

Scrolls the associated view (if necessary) to make the caret visible.

damage(Rectangle)

Damages the area surrounding the caret to cause it to be repainted.

deinstall(JTextComponent)

Called when the UI is being removed from the interface of a JTextComponent.

fireStateChanged()

Notifies all listeners that have registered interest for notification on this event type.

focusGained(FocusEvent)

Called when the component containing the caret gains focus.

focusLost(FocusEvent)

Called when the component containing the caret loses focus.

getBlinkRate()

Gets the caret blink rate.

getComponent()

Gets the editor component that this caret is for.

getDot()

Fetches the current position of the caret.

getMagicCaretPosition()

Gets the saved caret position.

getMark()

Fetches the current position of the mark.

getSelectionPainter()

Gets the painter for the Highlighter.

install(JTextComponent)

Called when the UI is being installed into the interface of a JTextComponent.

isSelectionVisible()

Checks whether the current selection is visible.

isVisible()

Determines if the caret is currently visible.

mouseClicked(MouseEvent)

Called when the mouse is clicked.

mouseDragged(MouseEvent)

Moves the caret position according to the mouse pointer's current location.

mouseEntered(MouseEvent)

Called when the mouse enters a region.

mouseExited(MouseEvent)

Called when the mouse exits a region.

mouseMoved(MouseEvent)

Called when the mouse is moved.

mousePressed(MouseEvent)

Requests focus on the associated text component, and tries to set the cursor position.

mouseReleased(MouseEvent)

Called when the mouse is released.

moveCaret(MouseEvent)

Tries to move the position of the caret from the coordinates of a mouse event, using viewToModel().

moveDot(int)

Moves the caret position to some other position.

paint(Graphics)

Renders the caret as a vertical line.

positionCaret(MouseEvent)

Tries to set the position of the caret from the coordinates of a mouse event, using viewToModel().

removeChangeListener(ChangeListener)

Removes a listener that was tracking caret position changes.

setBlinkRate(int)

Sets the caret blink rate.

setDot(int)

Sets the caret position and mark to some position.

setMagicCaretPosition(Point)

Saves the current caret position.

setSelectionVisible(boolean)

Changes the selection visibility.

setVisible(boolean)

Sets the caret visibility, and repaints the caret.

 protected EventListenerList listenerList

The event listener list.

 protected ChangeEvent changeEvent

The change event for the model. Only one ChangeEvent is needed per model instance since the event's only (read-only) state is the source property. The source of events generated here is always "this".

 public DefaultCaret()

Constructs a default caret.

 protected final JTextComponent getComponent()

Gets the editor component that this caret is for.

Returns:

the component

 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

 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 to scroll to

 protected Highlighter. HighlightPainter getSelectionPainter()

Gets the painter for the Highlighter.

Returns:

the painter

 protected void positionCaret(MouseEvent e)

Tries to set the position of the caret from the coordinates of a mouse event, using viewToModel().

Parameters:

e - the mouse event

 protected void moveCaret(MouseEvent e)

Tries to move the position of the caret from the coordinates of a mouse event, using viewToModel(). This will cause a selection if the dot and mark are different.

Parameters:

e - the mouse event

 public void focusGained(FocusEvent e)

Called when the component containing the caret gains focus. This is implemented to set the caret to visible if the component is editable, and sets the selection to visible.

Parameters:

e - the focus event

See Also:

focusGained

 public void focusLost(FocusEvent e)

Called when the component containing the caret loses focus. This is implemented to set the caret to visibility to false, and to set the selection visibility to false.

Parameters:

e - the focus event

See Also:

focusLost

 public void mouseClicked(MouseEvent e)

Called when the mouse is clicked. A double click selects a word, and a triple click the current line.

Parameters:

e - the mouse event

See Also:

mouseClicked

 public void mousePressed(MouseEvent e)

Requests focus on the associated text component, and tries to set the cursor position.

Parameters:

e - the mouse event

See Also:

mousePressed

 public void mouseReleased(MouseEvent e)

Called when the mouse is released.

Parameters:

e - the mouse event

See Also:

mouseReleased

 public void mouseEntered(MouseEvent e)

Called when the mouse enters a region.

Parameters:

e - the mouse event

See Also:

mouseEntered

 public void mouseExited(MouseEvent e)

Called when the mouse exits a region.

Parameters:

e - the mouse event

See Also:

mouseExited

 public void mouseDragged(MouseEvent e)

Moves the caret position according to the mouse pointer's current location. This effectively extends the selection.

Parameters:

e - the mouse event

See Also:

mouseDragged

 public void mouseMoved(MouseEvent e)

Called when the mouse is moved.

Parameters:

e - the mouse event

See Also:

mouseMoved

 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. Sets the caret color to the value returned by getCaretColor().

Parameters:

g - the graphics context

See Also:

damage

 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. Sets the dot and mark to 0, and establishes document, property change, focus, mouse, and mouse motion listeners.

Parameters:

c - the component

See Also:

install

 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

 public void addChangeListener(ChangeListener l)

Adds a listener to track whenever the caret position has been changed.

Parameters:

l - the listener

See Also:

addChangeListener

 public void removeChangeListener(ChangeListener l)

Removes a listener that was tracking caret position changes.

Parameters:

l - the listener

See Also:

removeChangeListener

 protected void fireStateChanged()

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method. The listener list is processed last to first.

See Also:

EventListenerList

 public void setSelectionVisible(boolean vis)

Changes the selection visibility.

Parameters:

vis - the new visibility

 public boolean isSelectionVisible()

Checks whether the current selection is visible.

Returns:

true if the selection is visible

 public boolean isVisible()

Determines if the caret is currently visible.

Returns:

true if visible else false

See Also:

isVisible

 public void setVisible(boolean e)

Sets the caret visibility, and repaints the caret.

Parameters:

e - the visibility specifier

See Also:

setVisible

 public void setBlinkRate(int rate)

Sets the caret blink rate.

Parameters:

rate - the rate in milliseconds, 0 to stop blinking

See Also:

setBlinkRate

 public int getBlinkRate()

Gets the caret blink rate.

Returns:

s the delay in milliseconds. If this is zero the caret will not blink.

See Also:

getBlinkRate

 public int getDot()

Fetches the current position of the caret.

Returns:

the position >= 0

See Also:

getDot

 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 >= 0

See Also:

getMark

 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 >= 0

See Also:

setDot

 public void moveDot(int dot)

Moves the caret position to some other position.

Parameters:

dot - the position >= 0

See Also:

moveDot

 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

 public Point getMagicCaretPosition()

Gets the saved caret position.

Returns:

the position see #setMagicCaretPosition

All Packages  Class Hierarchy  This Package  Previous  Next  Index