TextRun Class Documentation
classTextRun : ElementNamespace: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
Constructor & Destructor Documentation
TextRun
TextRun(Stringtext, Fontfont, GraphicStategstate, TextStatetstate, Matrixmatrix)Parameters
text: StringThe text content for this run.
font: FontThe font to use for rendering the text.
gstate: GraphicStateThe graphic state (colors, line width, etc.) for this text run.
tstate: TextStateThe text state (character spacing, word spacing, font size, etc.) for this text run.
matrix: MatrixThe 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
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()clone
Elementclone()Returns:
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.
clone
Elementclone(java.util.EnumSet< ElementCloneFlags >cloneFlags)Parameters
cloneFlags: java.util.EnumSet< ElementCloneFlags >Flags that modify the cloning operation.
Returns:
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.
delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidgetAdvance
doublegetAdvance()Returns:
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.
getBoundingBox
RectgetBoundingBox()Returns:
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.
getClip
ClipgetClip()Returns:
The current Clip for this Element, or NULL if no clip is set.Gets the current Clip for an Element.
getFont
FontgetFont()Returns:
The font for this text run.The font used to render this TextRun.
getGraphicState
GraphicStategetGraphicState()Returns:
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.
getMatrix
MatrixgetMatrix()Returns:
The current transformation matrix applied to this element.The transformation matrix for the element.
getRawText
byte[]getRawText()Returns:
A byte array containing the raw character codes.The raw, un-interpreted text as character codes of this TextRun.
getText
StringgetText()Returns:
The text string for this run.The Unicode text content of this TextRun.
getTextState
TextStategetTextState()Returns:
The TextState for this text run.The text state parameters (character spacing, word spacing, font size, etc.) of this TextRun.
rotate
voidrotate(doubletheta)Parameters
theta: doubleThe rotation angle in degrees.
Returns:
voidRotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].
scale
voidscale(doublesx, doublesy)Parameters
sx: doubleThe horizontal scale factor.
sy: doubleThe vertical scale factor.
Returns:
voidScale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].
setClip
voidsetClip(Clipclip)Parameters
clip: ClipThe clip to set as the current clip for this element, or NULL to remove clipping.
Returns:
voidSets the current Clip for an Element.
setFont
voidsetFont(Fontfont)Parameters
font: FontThe new font for this text run.
Returns:
voidThe font used to render this TextRun.
setGraphicState
voidsetGraphicState(GraphicStategstate)Parameters
gstate: GraphicStatethe new/updated Graphic State for the text run.
Returns:
voidSet the Graphic State of the text run.
setMatrix
voidsetMatrix(Matrixmatrix)Parameters
matrix: MatrixThe transformation matrix for the element.
Returns:
voidSet the transformation matrix for the element.
setText
voidsetText(Stringtext)Parameters
text: StringThe new text content for this run.
Returns:
voidThe Unicode text content of this TextRun.
translate
voidtranslate(doubletx, doublety)Parameters
tx: doubleThe horizontal translation distance in user space units.
ty: doubleThe vertical translation distance in user space units.
Returns:
voidTranslate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].