com.daylight
Class DepictorText

java.lang.Object
  extended by com.daylight.DaylightCppObject
      extended by com.daylight.DepictorText

public class DepictorText
extends DaylightCppObject

Object representing depictor text


Field Summary
 
Fields inherited from class com.daylight.DaylightCppObject
ref
 
Constructor Summary
DepictorText()
           
 
Method Summary
protected  void finalize()
          Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
 float getAngleInRadians()
          The desired angle in radians of text to the horizontal baseline.
 float getBaseSize()
          The vertical size of the text in the units of the depiction coordinate space.
 HorizontalJustification getHorizontalJustification()
          The horizontal justification for the text.
 java.awt.geom.Point2D.Float getLocation()
          The desired location of the text in the depiction coordinate space.
 float[] getSizes()
          The size of each letter of text as an array.
 float[] getSuperSubscripts()
          the superscript or subscript indication for each letter of text as an array.
 java.lang.String getText()
          The text to be displayed.
 VerticalJustification getVerticalJustification()
          The vertical justification for the text.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DepictorText

public DepictorText()
Method Detail

getText

public java.lang.String getText()
                         throws DaylightException
The text to be displayed.

Throws:
DaylightException

getSizes

public float[] getSizes()
                 throws DaylightException
The size of each letter of text as an array. The sizes are relative to the base size (getBaseSize()).

Throws:
DaylightException

getSuperSubscripts

public float[] getSuperSubscripts()
                           throws DaylightException
the superscript or subscript indication for each letter of text as an array. Values are between -.8 and .8, with negative values indicating subscripts, positive values superscripts, and 0 indicating no super or subscripting.

Throws:
DaylightException

getVerticalJustification

public VerticalJustification getVerticalJustification()
                                               throws DaylightException
The vertical justification for the text.

Throws:
DaylightException

getHorizontalJustification

public HorizontalJustification getHorizontalJustification()
                                                   throws DaylightException
The horizontal justification for the text.

Throws:
DaylightException

getLocation

public java.awt.geom.Point2D.Float getLocation()
                                        throws DaylightException
The desired location of the text in the depiction coordinate space.

Throws:
DaylightException

getBaseSize

public float getBaseSize()
                  throws DaylightException
The vertical size of the text in the units of the depiction coordinate space.

Throws:
DaylightException

getAngleInRadians

public float getAngleInRadians()
                        throws DaylightException
The desired angle in radians of text to the horizontal baseline.

Throws:
DaylightException

finalize

protected void finalize()
                 throws java.lang.Throwable
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable