- 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 and Description TextLayout.CaretPolicy()
Constructs aCaretPolicy
.
-
Method Summary
Methods Modifier and Type Method and 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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/font/textlayout.caretpolicy.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.