Text (Apache Ant API)
Description: declaration: package: org.apache.tools.ant.types.optional.imageio, class: Text

Package org.apache.tools.ant.types.optional.imageio

# Class Text

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.optional.imageio.ImageOperation
org.apache.tools.ant.types.optional.imageio.Text

All Implemented Interfaces:
  `Cloneable`, `DrawOperation`

public class Text extends ImageOperation implements DrawOperation

See Also:
  - `ImageIOTask`

- ## Field Summary

  ### Fields inherited from class org.apache.tools.ant.types.optional.imageio.ImageOperation

  `instructions`

  ### Fields inherited from class org.apache.tools.ant.types.DataType

  `checked, ref`

  ### Fields inherited from class org.apache.tools.ant.ProjectComponent

  `description, location, project`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Text()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `BufferedImage`
  `executeDrawOperation()`
  Draw the text.
  `void`
  `setBold(boolean state)`
  `void`
  `setColor(String c)`
  Set the color of the text.
  `void`
  `setFont(String f)`
  Set the font to be used to draw the text.
  `void`
  `setItalic(boolean state)`
  `void`
  `setPoint(String p)`
  Set the number of points to be used.
  `void`
  `setString(String str)`
  Set the string to be used as text.

  ### Methods inherited from class org.apache.tools.ant.types.optional.imageio.ImageOperation

  `addDraw, addRotate, addScale`

  ### Methods inherited from class org.apache.tools.ant.types.DataType

  `checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString`

  ### Methods inherited from class org.apache.tools.ant.ProjectComponent

  `getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject`

  ### Methods inherited from class java.lang.Object

  `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### Text

    public Text()

- ## Method Details

  - ### setString

    public void setString(String str)
    Set the string to be used as text.
    Parameters:
      `str` - the string to be used.

  - ### setFont

    public void setFont(String f)
    Set the font to be used to draw the text.
    Parameters:
      `f` - the font to be used.

  - ### setPoint

    public void setPoint(String p)
    Set the number of points to be used.
    Parameters:
      `p` - an integer value as a string.

  - ### setColor

    public void setColor(String c)
    Set the color of the text.
    Parameters:
      `c` - the color name.

  - ### setBold

    public void setBold(boolean state)
    Parameters:
      `state` - not used at the moment.
    To do:
      is this used?

  - ### setItalic

    public void setItalic(boolean state)
    Parameters:
      `state` - not used at the moment.
    To do:
      is this used?

  - ### executeDrawOperation

    public BufferedImage executeDrawOperation()
    Draw the text.
    Specified by:
      `executeDrawOperation` in interface `DrawOperation`
    Returns:
      the resultant image.