Overview  Package   Class  Use  Deprecated  Index
Home >> All >> java >> awt >> [ font overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

java.awt.font
Class TextLayout  

java.lang.Object
  java.awt.font.TextLayout

All Implemented Interfaces:

java.lang.Cloneable

---

public final class TextLayout

extends java.lang.Object

implements java.lang.Cloneable

---

Nested Class Summary
static class	TextLayout.CaretPolicy

 

Field Summary
static TextLayout.CaretPolicy	DEFAULT_CARET_POLICY
(package private)  gnu.java.awt.peer.ClasspathTextLayoutPeer	peer

 

Constructor Summary

TextLayout(java.text.AttributedCharacterIterator text, FontRenderContext frc)

TextLayout(java.lang.String string, java.awt.Font font, FontRenderContext frc)

TextLayout(java.lang.String string, java.util.Map attributes, FontRenderContext frc)

 

Method Summary
protected  java.lang.Object	clone()           This method may be called to create a new copy of the Object.
void	draw(java.awt.Graphics2D g2, float x, float y)
boolean	equals(java.lang.Object obj)           Determine whether this Object is semantically equal to another Object.
boolean	equals(TextLayout tl)
float	getAdvance()
float	getAscent()
byte	getBaseline()
float[]	getBaselineOffsets()
java.awt.Shape	getBlackBoxBounds(int firstEndpoint, int secondEndpoint)
java.awt.geom.Rectangle2D	getBounds()
float[]	getCaretInfo(TextHitInfo hit)
float[]	getCaretInfo(TextHitInfo hit, java.awt.geom.Rectangle2D bounds)
java.awt.Shape	getCaretShape(TextHitInfo hit)
java.awt.Shape	getCaretShape(TextHitInfo hit, java.awt.geom.Rectangle2D bounds)
java.awt.Shape[]	getCaretShapes(int offset)
java.awt.Shape[]	getCaretShapes(int offset, java.awt.geom.Rectangle2D bounds)
java.awt.Shape[]	getCaretShapes(int offset, java.awt.geom.Rectangle2D bounds, TextLayout.CaretPolicy policy)
int	getCharacterCount()
byte	getCharacterLevel(int index)
float	getDescent()
TextLayout	getJustifiedLayout(float justificationWidth)
float	getLeading()
java.awt.Shape	getLogicalHighlightShape(int firstEndpoint, int secondEndpoint)
java.awt.Shape	getLogicalHighlightShape(int firstEndpoint, int secondEndpoint, java.awt.geom.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)
java.awt.Shape	getOutline(java.awt.geom.AffineTransform tx)
float	getVisibleAdvance()
java.awt.Shape	getVisualHighlightShape(TextHitInfo firstEndpoint, TextHitInfo secondEndpoint)
java.awt.Shape	getVisualHighlightShape(TextHitInfo firstEndpoint, TextHitInfo secondEndpoint, java.awt.geom.Rectangle2D bounds)
TextHitInfo	getVisualOtherHit(TextHitInfo hit)
protected  void	handleJustify(float justificationWidth)
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, java.awt.geom.Rectangle2D bounds)
boolean	isLeftToRight()
boolean	isVertical()
java.lang.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

---

peer

gnu.java.awt.peer.ClasspathTextLayoutPeer peer

Constructor Detail

TextLayout

public TextLayout(java.text.AttributedCharacterIterator text,
                  FontRenderContext frc)

---

TextLayout

public TextLayout(java.lang.String string,
                  java.awt.Font font,
                  FontRenderContext frc)

---

TextLayout

public TextLayout(java.lang.String string,
                  java.util.Map attributes,
                  FontRenderContext frc)

Method Detail

clone

protected java.lang.Object clone()

Description copied from class: java.lang.Object

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)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.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());
     }
 }
 

---

draw

public void draw(java.awt.Graphics2D g2,
                 float x,
                 float y)

---

equals

public boolean equals(java.lang.Object obj)

Description copied from class: java.lang.Object

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 java.lang.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 java.lang.NullPointerException.

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

The default implementation returns this == o.

---

equals

public boolean equals(TextLayout tl)

---

getAdvance

public float getAdvance()

---

getAscent

public float getAscent()

---

getBaseline

public byte getBaseline()

---

getBaselineOffsets

public float[] getBaselineOffsets()

---

getBlackBoxBounds

public java.awt.Shape getBlackBoxBounds(int firstEndpoint,
                                        int secondEndpoint)

---

getBounds

public java.awt.geom.Rectangle2D getBounds()

---

getCaretInfo

public float[] getCaretInfo(TextHitInfo hit)

---

getCaretInfo

public float[] getCaretInfo(TextHitInfo hit,
                            java.awt.geom.Rectangle2D bounds)

---

getCaretShape

public java.awt.Shape getCaretShape(TextHitInfo hit)

---

getCaretShape

public java.awt.Shape getCaretShape(TextHitInfo hit,
                                    java.awt.geom.Rectangle2D bounds)

---

getCaretShapes

public java.awt.Shape[] getCaretShapes(int offset)

---

getCaretShapes

public java.awt.Shape[] getCaretShapes(int offset,
                                       java.awt.geom.Rectangle2D bounds)

---

getCaretShapes

public java.awt.Shape[] getCaretShapes(int offset,
                                       java.awt.geom.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 java.awt.Shape getLogicalHighlightShape(int firstEndpoint,
                                               int secondEndpoint)

---

getLogicalHighlightShape

public java.awt.Shape getLogicalHighlightShape(int firstEndpoint,
                                               int secondEndpoint,
                                               java.awt.geom.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 java.awt.Shape getOutline(java.awt.geom.AffineTransform tx)

---

getVisibleAdvance

public float getVisibleAdvance()

---

getVisualHighlightShape

public java.awt.Shape getVisualHighlightShape(TextHitInfo firstEndpoint,
                                              TextHitInfo secondEndpoint)

---

getVisualHighlightShape

public java.awt.Shape getVisualHighlightShape(TextHitInfo firstEndpoint,
                                              TextHitInfo secondEndpoint,
                                              java.awt.geom.Rectangle2D bounds)

---

getVisualOtherHit

public TextHitInfo getVisualOtherHit(TextHitInfo hit)

---

handleJustify

protected void handleJustify(float justificationWidth)

---

hashCode

public int hashCode()

Description copied from class: java.lang.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:

• 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 java.util.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)

---

hitTestChar

public TextHitInfo hitTestChar(float x,
                               float y)

---

hitTestChar

public TextHitInfo hitTestChar(float x,
                               float y,
                               java.awt.geom.Rectangle2D bounds)

---

isLeftToRight

public boolean isLeftToRight()

---

isVertical

public boolean isVertical()

---

toString

public java.lang.String toString()

Description copied from class: java.lang.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() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.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()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> java >> awt >> [ font overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---