Fancier custom caret class : TextArea « Swing JFC « Java

Fancier custom caret class

Fancier custom caret class
Java Swing, 2nd Edition
By Marc Loy, Robert Eckstein, Dave Wood, James Elliott, Brian Cole
ISBN: 0-596-00408-7
Publisher: O'Reilly 
//Another (fancier) custom caret class.

import java.awt.BorderLayout;
import java.awt.Graphics;
import java.awt.Rectangle;

import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.text.BadLocationException;
import javax.swing.text.DefaultCaret;
import javax.swing.text.JTextComponent;

public class FancyCaret extends DefaultCaret {

  protected synchronized void damage(Rectangle r) {
    if (r == null)

    // give values to x,y,width,height (inherited from java.awt.Rectangle)
    x = r.x;
    y = r.y;
    height = r.height;
    // A value for width was probably set by paint(), which we leave alone.
    // But the first call to damage() precedes the first call to paint(), so
    // in this case we must be prepared to set a valid width, or else
    // paint()
    // will receive a bogus clip area and caret will not get drawn properly.
    if (width <= 0)
      width = getComponent().getWidth();

    repaint(); // calls getComponent().repaint(x, y, width, height)

  public void paint(Graphics g) {
    JTextComponent comp = getComponent();
    if (comp == null)

    int dot = getDot();
    Rectangle r = null;
    char dotChar;
    try {
      r = comp.modelToView(dot);
      if (r == null)
      dotChar = comp.getText(dot, 1).charAt(0);
    } catch (BadLocationException e) {

    if ((x != r.x) || (y != r.y)) {
      // paint() has been called directly, without a previous call to
      // damage(), so do some cleanup. (This happens, for example, when
      // the
      // text component is resized.)
      repaint(); // erase previous location of caret
      x = r.x; // Update dimensions (width gets set later in this method)
      y = r.y;
      height = r.height;

    g.setXORMode(comp.getBackground()); // do this to draw in XOR mode

    if (dotChar == '\n') {
      int diam = r.height;
      if (isVisible())
        g.fillArc(r.x - diam / 2, r.y, diam, diam, 270, 180); // half
                                    // circle
      width = diam / 2 + 2;

    if (dotChar == '\t')
      try {
        Rectangle nextr = comp.modelToView(dot + 1);
        if ((r.y == nextr.y) && (r.x < nextr.x)) {
          width = nextr.x - r.x;
          if (isVisible())
            g.fillRoundRect(r.x, r.y, width, r.height, 12, 12);
        } else
          dotChar = ' ';
      } catch (BadLocationException e) {
        dotChar = ' ';

    width = g.getFontMetrics().charWidth(dotChar);
    if (isVisible())
      g.fillRect(r.x, r.y, width, r.height);

  public static void main(String args[]) {
    JFrame frame = new JFrame("FancyCaret demo");
    JTextArea area = new JTextArea(8, 32);
    area.setCaret(new FancyCaret());
    area.setText("VI\tVirgin Islands \nVA      Virginia\nVT\tVermont");
    frame.getContentPane().add(new JScrollPane(area), BorderLayout.CENTER);


Related examples in the same category

1.Creating a JTextArea Component
2.Insert some text after the 5th character
3.Delete the first 5 characters
4.Enumerating the Lines in a JTextArea Component
5.Modifying Text in a JTextArea Component
6.Show line start end offsets in a JTextAreaShow line start end offsets in a JTextArea
7.A TransferHandler and JTextArea that will accept any drop at allA TransferHandler and JTextArea that will accept any drop at all
8.Drop: TextAreaDrop: TextArea
9.Drag and drop: TextArea 2Drag and drop: TextArea 2
10.Caret SampleCaret Sample
11.TextArea Background ImageTextArea Background Image
12.Cut Paste SampleCut Paste Sample
13.TextArea SampleTextArea Sample
14.TextArea ExampleTextArea Example
15.Wrap textareaWrap textarea
16.Replace text in text areaReplace text in text area
17.TextField ExampleTextField Example
18.TextArea Elements 2TextArea Elements 2
19.TextArea ElementsTextArea Elements
20.TextArea Views 2TextArea Views 2
21.TextArea Views 3TextArea Views 3
22.TextArea with UnicodeTextArea with Unicode
23.Internationalized Graphical User Interfaces: unicode cut and pasteInternationalized Graphical User Interfaces: unicode cut and paste
24.Text Component Demo 2Text Component Demo 2
25.Text Component DemoText Component Demo
26.Text Input DemoText Input Demo
27.Text Components Sampler DemoText Components Sampler Demo
28.TextArea Share ModelTextArea Share Model
29.Set the start of the selection; ignored if new start is < end
30.Set the end of the selection; ignored if new end is > start
31.Set the caret color
32.Simple Editor DemoSimple Editor Demo
33.Setting the Tab Size of a JTextArea Component
34.Moving the Focus with the TAB Key in a JTextArea Component
35.Enabling Word-Wrapping and Line-Wrapping in a JTextArea Component
36.Append some text to JTextArea
37.Replace the first 3 characters with some text
38.Enable word-wrapping
39.Enumerate the content elements with a ElementIterator
40.Highlight of discontinous string
41.Copy selected text from one text area to another