Class TextLayout

public static final TextLayout.CaretPolicy DEFAULT_CARET_POLICY

The default caret policy.

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

public TextLayout(String str,
                  Font font,
                  FontRenderContext frc)

Constructs a TextLayout.

public TextLayout(AttributedCharacterIterator text,
                  FontRenderContext frc)

protected Object clone()

This method may be called to create a new copy of the Object. The typical behavior is as follows:

• o == o.clone() is false
• o.getClass() == o.clone().getClass() is true
• o.equals(o) is true

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 interface Object

Returns:

a copy of the Object

See Also:

Cloneable

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

public boolean equals(TextLayout tl)

public boolean equals(Object obj)

Determine whether this Object is semantically equal to another Object.

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

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

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 interface Object

Parameters:

obj - the Object to compare to

Returns:

whether this Object is semantically equal to another

See Also:

Object.hashCode()

public float getAdvance()

public float getAscent()

public byte getBaseline()

public float[] getBaselineOffsets()

public Shape getBlackBoxBounds(int firstEndpoint,
                               int secondEndpoint)

public Rectangle2D getBounds()

public float[] getCaretInfo(TextHitInfo hit)

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

public Shape getCaretShape(TextHitInfo hit)

public Shape getCaretShape(TextHitInfo hit,
                           Rectangle2D bounds)

public Shape[] getCaretShapes(int offset)

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

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

public int getCharacterCount()

public byte getCharacterLevel(int index)

public float getDescent()

public TextLayout getJustifiedLayout(float justificationWidth)

public float getLeading()

public Shape getLogicalHighlightShape(int firstEndpoint,
                                      int secondEndpoint)

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

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

public TextHitInfo getNextLeftHit(int offset)

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

public TextHitInfo getNextLeftHit(TextHitInfo hit)

public TextHitInfo getNextRightHit(int offset)

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

public TextHitInfo getNextRightHit(TextHitInfo hit)

public Shape getOutline(AffineTransform tx)

public float getVisibleAdvance()

public Shape getVisualHighlightShape(TextHitInfo firstEndpoint,
                                     TextHitInfo secondEndpoint)

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

public 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.

public int hashCode()

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:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

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 interface Object

Returns:

the hash code for this Object

See Also:

Object.equals(Object), System.identityHashCode(Object)

public TextHitInfo hitTestChar(float x,
                               float y)

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

public boolean isLeftToRight()

public boolean isVertical()

public String toString()

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 interface Object

Returns:

the String representing this Object, which may be null

See Also:

getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)