Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class java.awt.font.TextLayout.CaretPolicy

java.lang.Object
  |
  +--java.awt.font.TextLayout.CaretPolicy

public static class TextLayout.CaretPolicy

extends Object

Define a policy for determining the strong caret location. This class contains one method, getStrongCaret, which is used to specify the policy which 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 to getCaretShapes, 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 clients do not need to use this class.

Method Summary

TextHitInfo

getStrongCaret(TextHitInfo hit1, TextHitInfo hit2, TextLayout layout) Choose one of the given TextHitInfo instances as a strong caret in the given TextLayout.

Methods inherited from class java.lang.Object

clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

Method Detail

getStrongCaret

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

Choose one of the given TextHitInfo instances as a strong caret in the given 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:

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