TextLayout.CaretPolicy (Java 2 Platform SE 5.0) (original) (raw)

java.awt.font

Class TextLayout.CaretPolicy

java.lang.Object extended by java.awt.font.TextLayout.CaretPolicy

Enclosing class:

public static class TextLayout.CaretPolicy

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 and getNextRightHit to customize strong caret selection.

To specify alternate caret policies, subclass CaretPolicy and override getStrongCaret. getStrongCaret should inspect the two TextHitInfo arguments and choose one of them as the strong caret.

Most clients do not need to use this class.

Constructor Summary
TextLayout.CaretPolicy() Constructs a CaretPolicy.

Method Summary
TextHitInfo	[getStrongCaret](../../../java/awt/font/TextLayout.CaretPolicy.html#getStrongCaret%28java.awt.font.TextHitInfo, java.awt.font.TextHitInfo, java.awt.font.TextLayout%29)(TextHitInfo hit1,TextHitInfo hit2,TextLayout layout) Chooses one of the specified TextHitInfo instances as a strong caret in the specified TextLayout.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

TextLayout.CaretPolicy

public TextLayout.CaretPolicy()

Constructs a CaretPolicy.

Method Detail

getStrongCaret

public TextHitInfo getStrongCaret(TextHitInfo hit1, TextHitInfo hit2, TextLayout layout)

Chooses one of the specified TextHitInfo instances as a strong caret in the specified TextLayout.

Parameters:

hit1 - a valid hit in layout

hit2 - a valid hit in layout

layout - the TextLayout in which hit1 and hit2 are used

Returns:

hit1 or hit2 (or an equivalent TextHitInfo), indicating the strong caret.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.