TextRun Class

class TextRun : Element

Namespace:com::datalogics::PDFL

Inherits from:: Element

Detailed Description

Represents one or more contiguous characters in a text object. All the characters contained within a text run have the same style, color, font, and size.

Referenced by

Text

Uses types

Clip Element Font GraphicState Matrix Rect TextState

Constructor & Destructor Documentation

TextRun(String text, Font font, GraphicState gstate, TextState tstate, Matrix matrix)

Parameters

text: String: The text content for this run.
font: Font: The font to use for rendering the text.
gstate: GraphicState: The graphic state (colors, line width, etc.) for this text run.
tstate: TextState: The text state (character spacing, word spacing, font size, etc.) for this text run.
matrix: Matrix: The transformation matrix positioning this text run in user space.

Creates a new TextRun with the specified text, font, graphic state, text state, and matrix.

Member Function Documentation

Element clone()

Returns:

Element

The copied element.

Makes a copy of the element.

Make a copy of an element to obtain a new element that has a distinct set of attributes.

Note: TextRun objects may not be cloned.

Element clone(java.util.EnumSet< ElementCloneFlags > cloneFlags)

Parameters

cloneFlags: java.util.EnumSet< ElementCloneFlags >: Flags that modify the cloning operation.

Returns:

Element

The copied element.

Makes a copy of the element.

Make a copy of an element to obtain a new element that has a distinct set of attributes.

Note: TextRun objects may not be cloned.

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

void finalize()

Returns:

void

double getAdvance()

Returns:

double

The advance width of this text run.

Deprecated, use Text.GetAdvanceForTextRun(int textRunIndex) instead. This version does not indicate the direction of the advance width.

The advance width of this run of text, in user space.

The advance width is the amount by which the current point advances when the text run is drawn.

Rect getBoundingBox()

Returns:

Rect

The bounding box for this element. The coordinates of the bounding box are specified in user space coordinates, relative to the element's Content. Note that user space coordinates correspond to unrotated pages; any rotation specified in the page dictionary is not taken into account.

The bounding box for this element. The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

Clip getClip()

Returns:

Clip

The current Clip for this Element, or NULL if no clip is set.

Gets the current Clip for an Element.

Font getFont()

Returns:

Font

The font for this text run.

The font used to render this TextRun.

GraphicState getGraphicState()

Returns:

GraphicState

The GraphicState for this text run, or null.

The graphic state (colors, line width, etc.) of the text run.

May return null if this element does not have a GraphicState.

Matrix getMatrix()

Returns:

Matrix

The current transformation matrix applied to this element.

The transformation matrix for the element.

byte[] getRawText()

Returns:

byte[]

A byte array containing the raw character codes.

The raw, un-interpreted text as character codes of this TextRun.

String getText()

Returns:

String

The text string for this run.

The Unicode text content of this TextRun.

TextState getTextState()

Returns:

TextState

The TextState for this text run.

The text state parameters (character spacing, word spacing, font size, etc.) of this TextRun.

void rotate(double theta)

Parameters

theta: double: The rotation angle in degrees.

Returns:

void

Rotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].

void scale(double sx, double sy)

Parameters

sx: double: The horizontal scale factor.
sy: double: The vertical scale factor.

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

void setClip(Clip clip)

Parameters

clip: Clip: The clip to set as the current clip for this element, or NULL to remove clipping.

Returns:

void

Sets the current Clip for an Element.

void setFont(Font font)

Parameters

font: Font: The new font for this text run.

Returns:

void

The font used to render this TextRun.

void setGraphicState(GraphicState gstate)

Parameters

gstate: GraphicState: the new/updated Graphic State for the text run.

Returns:

void

Set the Graphic State of the text run.

void setMatrix(Matrix matrix)

Parameters

matrix: Matrix: The transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

void setText(String text)

Parameters

text: String: The new text content for this run.

Returns:

void

The Unicode text content of this TextRun.

void translate(double tx, double ty)

Parameters

tx: double: The horizontal translation distance in user space units.
ty: double: The vertical translation distance in user space units.

Returns:

void

Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].