- java.lang.Object
-
- java.awt.font.TextLayout.CaretPolicy
-
- Enclosing class:
- TextLayout
public static class TextLayout.CaretPolicy extends Object
Defines a policy for determining the strong caret location. This class contains one method,getStrongCaret
, which is used to specify the policy that determines the strong caret in dual-caret text. The strong caret is used to move the caret to the left or right. Instances of this class can be passed togetCaretShapes
,getNextLeftHit
andgetNextRightHit
to customize strong caret selection.To specify alternate caret policies, subclass
CaretPolicy
and overridegetStrongCaret
.getStrongCaret
should inspect the twoTextHitInfo
arguments and choose one of them as the strong caret.Most clients do not need to use this class.
-
-
Constructor Summary
Constructors Constructor Description CaretPolicy()
Constructs aCaretPolicy
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TextHitInfo
getStrongCaret(TextHitInfo hit1, TextHitInfo hit2, TextLayout layout)
Chooses one of the specifiedTextHitInfo
instances as a strong caret in the specifiedTextLayout
.
-
-
-
Method Detail
-
getStrongCaret
public TextHitInfo getStrongCaret(TextHitInfo hit1, TextHitInfo hit2, TextLayout layout)
Chooses one of the specifiedTextHitInfo
instances as a strong caret in the specifiedTextLayout
.- Parameters:
hit1
- a valid hit inlayout
hit2
- a valid hit inlayout
layout
- theTextLayout
in whichhit1
andhit2
are used- Returns:
hit1
orhit2
(or an equivalentTextHitInfo
), indicating the strong caret.
-
-