java.awt.font

Class TextLayout

Implemented Interfaces:
Cloneable

public final class TextLayout
extends Object
implements Cloneable

Nested Class Summary

static class
TextLayout.CaretPolicy
Inner class describing a caret policy

Field Summary

static TextLayout.CaretPolicy
DEFAULT_CARET_POLICY
The default caret policy.

Constructor Summary

TextLayout(String string, extends AttributedCharacterIterator.Attribute, ?> attributes, FontRenderContext frc)
TextLayout(String str, Font font, FontRenderContext frc)
Constructs a TextLayout.
TextLayout(AttributedCharacterIterator text, FontRenderContext frc)

Method Summary

protected Object
clone()
void
draw(Graphics2D g2, float x, float y)
boolean
equals(TextLayout tl)
boolean
equals(Object obj)
float
getAdvance()
float
getAscent()
byte
getBaseline()
float[]
getBaselineOffsets()
Shape
getBlackBoxBounds(int firstEndpoint, int secondEndpoint)
Rectangle2D
getBounds()
float[]
getCaretInfo(TextHitInfo hit)
float[]
getCaretInfo(TextHitInfo hit, Rectangle2D bounds)
Shape
getCaretShape(TextHitInfo hit)
Shape
getCaretShape(TextHitInfo hit, Rectangle2D bounds)
Shape[]
getCaretShapes(int offset)
Shape[]
getCaretShapes(int offset, Rectangle2D bounds)
Shape[]
getCaretShapes(int offset, Rectangle2D bounds, TextLayout.CaretPolicy policy)
int
getCharacterCount()
byte
getCharacterLevel(int index)
float
getDescent()
TextLayout
getJustifiedLayout(float justificationWidth)
float
getLeading()
Shape
getLogicalHighlightShape(int firstEndpoint, int secondEndpoint)
Shape
getLogicalHighlightShape(int firstEndpoint, int secondEndpoint, Rectangle2D bounds)
int[]
getLogicalRangesForVisualSelection(TextHitInfo firstEndpoint, TextHitInfo secondEndpoint)
TextHitInfo
getNextLeftHit(int offset)
TextHitInfo
getNextLeftHit(int offset, TextLayout.CaretPolicy policy)
TextHitInfo
getNextLeftHit(TextHitInfo hit)
TextHitInfo
getNextRightHit(int offset)
TextHitInfo
getNextRightHit(int offset, TextLayout.CaretPolicy policy)
TextHitInfo
getNextRightHit(TextHitInfo hit)
Shape
getOutline(AffineTransform tx)
float
getVisibleAdvance()
Shape
getVisualHighlightShape(TextHitInfo firstEndpoint, TextHitInfo secondEndpoint)
Shape
getVisualHighlightShape(TextHitInfo firstEndpoint, TextHitInfo secondEndpoint, Rectangle2D bounds)
TextHitInfo
getVisualOtherHit(TextHitInfo hit)
protected void
handleJustify(float justificationWidth)
This is a protected method of a final class, meaning it exists only to taunt you.
int
hashCode()
TextHitInfo
hitTestChar(float x, float y)
TextHitInfo
hitTestChar(float x, float y, Rectangle2D bounds)
Finds the character hit at the specified point.
boolean
isLeftToRight()
boolean
isVertical()
String
toString()

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CARET_POLICY

public static final TextLayout.CaretPolicy DEFAULT_CARET_POLICY
The default caret policy.

Constructor Details

TextLayout

public TextLayout(String string,
                  extends AttributedCharacterIterator.Attribute,
                  ?> attributes,
                  FontRenderContext frc)

TextLayout

public TextLayout(String str,
                  Font font,
                  FontRenderContext frc)
Constructs a TextLayout.

TextLayout

public TextLayout(AttributedCharacterIterator text,
                  FontRenderContext frc)

Method Details

clone

protected Object clone()
Overrides:
clone in interface Object

draw

public void draw(Graphics2D g2,
                 float x,
                 float y)

equals

public boolean equals(TextLayout tl)

equals

public boolean equals(Object obj)
Overrides:
equals in interface Object

getAdvance

public float getAdvance()

getAscent

public float getAscent()

getBaseline

public byte getBaseline()

getBaselineOffsets

public float[] getBaselineOffsets()

getBlackBoxBounds

public Shape getBlackBoxBounds(int firstEndpoint,
                               int secondEndpoint)

getBounds

public Rectangle2D getBounds()

getCaretInfo

public float[] getCaretInfo(TextHitInfo hit)

getCaretInfo

public float[] getCaretInfo(TextHitInfo hit,
                            Rectangle2D bounds)

getCaretShape

public Shape getCaretShape(TextHitInfo hit)

getCaretShape

public Shape getCaretShape(TextHitInfo hit,
                           Rectangle2D bounds)

getCaretShapes

public Shape[] getCaretShapes(int offset)

getCaretShapes

public Shape[] getCaretShapes(int offset,
                              Rectangle2D bounds)

getCaretShapes

public Shape[] getCaretShapes(int offset,
                              Rectangle2D bounds,
                              TextLayout.CaretPolicy policy)

getCharacterCount

public int getCharacterCount()

getCharacterLevel

public byte getCharacterLevel(int index)

getDescent

public float getDescent()

getJustifiedLayout

public TextLayout getJustifiedLayout(float justificationWidth)

getLeading

public float getLeading()

getLogicalHighlightShape

public Shape getLogicalHighlightShape(int firstEndpoint,
                                      int secondEndpoint)

getLogicalHighlightShape

public Shape getLogicalHighlightShape(int firstEndpoint,
                                      int secondEndpoint,
                                      Rectangle2D bounds)

getLogicalRangesForVisualSelection

public int[] getLogicalRangesForVisualSelection(TextHitInfo firstEndpoint,
                                                TextHitInfo secondEndpoint)

getNextLeftHit

public TextHitInfo getNextLeftHit(int offset)

getNextLeftHit

public TextHitInfo getNextLeftHit(int offset,
                                  TextLayout.CaretPolicy policy)

getNextLeftHit

public TextHitInfo getNextLeftHit(TextHitInfo hit)

getNextRightHit

public TextHitInfo getNextRightHit(int offset)

getNextRightHit

public TextHitInfo getNextRightHit(int offset,
                                   TextLayout.CaretPolicy policy)

getNextRightHit

public TextHitInfo getNextRightHit(TextHitInfo hit)

getOutline

public Shape getOutline(AffineTransform tx)

getVisibleAdvance

public float getVisibleAdvance()

getVisualHighlightShape

public Shape getVisualHighlightShape(TextHitInfo firstEndpoint,
                                     TextHitInfo secondEndpoint)

getVisualHighlightShape

public Shape getVisualHighlightShape(TextHitInfo firstEndpoint,
                                     TextHitInfo secondEndpoint,
                                     Rectangle2D bounds)

getVisualOtherHit

public TextHitInfo getVisualOtherHit(TextHitInfo hit)

handleJustify

protected void handleJustify(float justificationWidth)
This is a protected method of a final class, meaning it exists only to taunt you.

hashCode

public int hashCode()
Overrides:
hashCode in interface Object

hitTestChar

public TextHitInfo hitTestChar(float x,
                               float y)

hitTestChar

public TextHitInfo hitTestChar(float x,
                               float y,
                               Rectangle2D bounds)
Finds the character hit at the specified point. This 'clips' this text layout against the specified bounds rectangle. That means that in the case where a point is outside these bounds, this method returns the leading edge of the first character or the trailing edge of the last character.
Parameters:
x - the X location to test
y - the Y location to test
bounds - the bounds to test against
Returns:
the character hit at the specified point

isLeftToRight

public boolean isLeftToRight()

isVertical

public boolean isVertical()

toString

public String toString()
Overrides:
toString in interface Object

TextLayout.java -- Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.