java.awt.font
Class TextLayout.CaretPolicy
- 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,getNextLeftHitandgetNextRightHitto customize strong caret selection.To specify alternate caret policies, subclass
CaretPolicyand overridegetStrongCaret.getStrongCaretshould inspect the twoTextHitInfoarguments and choose one of them as the strong caret.Most clients do not need to use this class.
-
-
Constructor Summary
Constructors Constructor and Description CaretPolicy()Constructs aCaretPolicy.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description TextHitInfogetStrongCaret(TextHitInfo hit1, TextHitInfo hit2, TextLayout layout)Chooses one of the specifiedTextHitInfoinstances as a strong caret in the specifiedTextLayout.
-
-
-
Method Detail
getStrongCaret
public TextHitInfo getStrongCaret(TextHitInfo hit1, TextHitInfo hit2, TextLayout layout)
Chooses one of the specifiedTextHitInfoinstances as a strong caret in the specifiedTextLayout.- Parameters:
-
hit1- a valid hit inlayout -
hit2- a valid hit inlayout -
layout- theTextLayoutin whichhit1andhit2are used - Returns:
-
hit1orhit2(or an equivalentTextHitInfo), indicating the strong caret.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
