All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.text.DefaultCaret

java.lang.Object
    |
    +----java.awt.swing.text.DefaultCaret

public class DefaultCaret

extends Object

implements Caret, Serializable

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.

getBlinkRate()

Gets the caret blink rate.

getComponent()

Gets the 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.

isVisible()

Determines if the caret is currently visible.

moveDot(int)

Moves the caret position to some other position.

paint(Graphics)

Renders the caret as a vertical line.

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.

setVisible(boolean)

Sets the caret visibility.

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

protected Highlighter.HighlightPainter getSelectionPainter()

Gets the painter for the Highlighter.

Returns:

the painter

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

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

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.

See Also:

EventListenerList

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.

Parameters:

e - the visibility specifier

See Also:

setVisible

public void setBlinkRate(int rate)

Sets the caret blink rate.

Parameters:

rate - the rate

See Also:

setBlinkRate

public int getBlinkRate()

Gets the caret blink rate.

See Also:

getBlinkRate

public int getDot()

Fetches the current position of the caret.

Returns:

the position

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

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

See Also:

setDot

public void moveDot(int dot)

Moves the caret position to some other position.

Parameters:

dot - the position

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