java.awt.font
Class TextLayout

java.lang.Object
  extended by java.awt.font.TextLayout
All 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(AttributedCharacterIterator text, FontRenderContext frc)
           
TextLayout(String str, Font font, FontRenderContext frc)
          Constructs a TextLayout.
TextLayout(String string, Map<? extends AttributedCharacterIterator.Attribute,?> attributes, FontRenderContext frc)
           
 
Method Summary
protected  Object clone()
          This method may be called to create a new copy of the Object.
 void draw(Graphics2D g2, float x, float y)
           
 boolean equals(Object obj)
          Determine whether this Object is semantically equal to another Object.
 boolean equals(TextLayout tl)
           
 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()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 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()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_CARET_POLICY

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

Constructor Detail

TextLayout

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


TextLayout

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

TextLayout

public TextLayout(AttributedCharacterIterator text,
                  FontRenderContext frc)
Method Detail

clone

protected Object clone()
Description copied from class: Object
This method may be called to create a new copy of the Object. The typical behavior is as follows:

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

Overrides:
clone in class Object
Returns:
a copy of the Object
See Also:
Cloneable

draw

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

equals

public boolean equals(Object obj)
Description copied from class: Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in class Object
Parameters:
obj - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()

equals

public boolean equals(TextLayout tl)

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.


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()

hashCode

public int hashCode()
Description copied from class: Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

toString

public String toString()
Description copied from class: Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in class Object
Returns:
the String representing this Object, which may be null
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)