Class FlatCaret

java.lang.Object

java.awt.geom.RectangularShape

java.awt.geom.Rectangle2D

java.awt.Rectangle

javax.swing.text.DefaultCaret

com.formdev.flatlaf.ui.FlatCaret

All Implemented Interfaces:

FocusListener, MouseListener, MouseMotionListener, Shape, Serializable, Cloneable, EventListener, UIResource, Caret

public class FlatCaret
extends DefaultCaret
implements UIResource

Caret that can select all text on focus gained. Also fixes Swing's double-click-and-drag behavior so that dragging after a double-click extends selection by whole words.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Rectangle2D

Rectangle2D.Double, Rectangle2D.Float

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ALWAYS
private int	dragSelectionEnd
private int	dragSelectionStart
private boolean	inInstall
private boolean	isLineSelection
private boolean	isMousePressed
private boolean	isWordSelection
private static final String	KEY_CARET_INFO
private static final int	NEVER
private static final int	ONCE
private final String	selectAllOnFocusPolicy
private final boolean	selectAllOnMouseClick
private boolean	wasFocused
private boolean	wasFocusTemporaryLost

Fields inherited from class DefaultCaret

ALWAYS_UPDATE, changeEvent, listenerList, NEVER_UPDATE, UPDATE_WHEN_ON_EDT

Fields inherited from class Rectangle

height, width, x, y

Fields inherited from class Rectangle2D

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Constructor Summary

Constructors

Constructor	Description
FlatCaret(String selectAllOnFocusPolicy, boolean selectAllOnMouseClick)

Method Summary

Modifier and Type	Method	Description
protected void	adjustVisibility(Rectangle nloc)
void	deinstall(JTextComponent c)
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
private Object	getClientProperty(String key)
private int	getSelectAllOnFocusPolicy()
void	install(JTextComponent c)
private boolean	isSelectAllOnMouseClick()
void	mouseDragged(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	moveDot(int dot)
void	scrollCaretToVisible()
private void	select(int mark, int dot)
protected void	selectAllOnFocusGained()
void	setDot(int dot)

Methods inherited from class DefaultCaret

addChangeListener, damage, equals, fireStateChanged, getBlinkRate, getChangeListeners, getComponent, getDot, getDotBias, getListeners, getMagicCaretPosition, getMark, getMarkBias, getSelectionPainter, getUpdatePolicy, isActive, isSelectionVisible, isVisible, mouseClicked, mouseEntered, mouseExited, mouseMoved, moveCaret, moveDot, paint, positionCaret, removeChangeListener, repaint, setBlinkRate, setDot, setMagicCaretPosition, setSelectionVisible, setUpdatePolicy, setVisible, toString

Methods inherited from class Rectangle

add, add, add, contains, contains, contains, contains, createIntersection, createUnion, getBounds, getBounds2D, getHeight, getLocation, getSize, getWidth, getX, getY, grow, inside, intersection, intersects, isEmpty, move, outcode, reshape, resize, setBounds, setBounds, setLocation, setLocation, setRect, setSize, setSize, translate, union

Methods inherited from class Rectangle2D

add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union

Methods inherited from class RectangularShape

clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Shape

contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects

Field Details

KEY_CARET_INFO

private static final String KEY_CARET_INFO

See Also:

• Constant Field Values

NEVER

private static final int NEVER

See Also:

• Constant Field Values

ONCE

private static final int ONCE

See Also:

• Constant Field Values

ALWAYS

private static final int ALWAYS

See Also:

• Constant Field Values

selectAllOnFocusPolicy

private final String selectAllOnFocusPolicy

selectAllOnMouseClick

private final boolean selectAllOnMouseClick

inInstall

private boolean inInstall

wasFocused

private boolean wasFocused

wasFocusTemporaryLost

private boolean wasFocusTemporaryLost

isMousePressed

private boolean isMousePressed

isWordSelection

private boolean isWordSelection

isLineSelection

private boolean isLineSelection

dragSelectionStart

private int dragSelectionStart

dragSelectionEnd

private int dragSelectionEnd

Constructor Details

FlatCaret

public FlatCaret(String selectAllOnFocusPolicy,
 boolean selectAllOnMouseClick)

Method Details

install

public void install(JTextComponent c)

Specified by:

install in interface Caret

Overrides:

install in class DefaultCaret

deinstall

public void deinstall(JTextComponent c)

Specified by:

deinstall in interface Caret

Overrides:

deinstall in class DefaultCaret

adjustVisibility

protected void adjustVisibility(Rectangle nloc)

Overrides:

adjustVisibility in class DefaultCaret

setDot

public void setDot(int dot)

Specified by:

setDot in interface Caret

Overrides:

setDot in class DefaultCaret

moveDot

public void moveDot(int dot)

Specified by:

moveDot in interface Caret

Overrides:

moveDot in class DefaultCaret

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

Overrides:

focusGained in class DefaultCaret

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

Overrides:

focusLost in class DefaultCaret

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class DefaultCaret

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class DefaultCaret

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class DefaultCaret

selectAllOnFocusGained

protected void selectAllOnFocusGained()

select

private void select(int mark,
 int dot)

getSelectAllOnFocusPolicy

private int getSelectAllOnFocusPolicy()

isSelectAllOnMouseClick

private boolean isSelectAllOnMouseClick()

getClientProperty

private Object getClientProperty(String key)

scrollCaretToVisible

public void scrollCaretToVisible()

Since:

1.4