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: Stringfont: Fontgstate: GraphicStatetstate: TextStatematrix: 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:
doubleDeprecated, 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.
The advnace width is the amount by which the current point advances when the text run is drawn. Advance width is returned in user space.
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.Gets the current Clip for an Element.
getFont
FontgetFont()Returns:
FontThe font of this TextRun.
getGraphicState
GraphicStategetGraphicState()Returns:
GraphicStateGet the graphic state of the text run.
May return null if this element does not have a GraphicState.
getMatrix
MatrixgetMatrix()Returns:
MatrixThe transformation matrix for the element.
getRawText
byte[]getRawText()Returns:
byte[]The raw, un-interpreted text as char codes of this TextRun.
getText
StringgetText()Returns:
StringThe text of this TextRun.
getTextState
TextStategetTextState()Returns:
TextStateThe TextState of this TextRun.
rotate
voidrotate(doubletheta)Parameters
theta: double
Returns:
voidRotate an element by T degrees counterclockwise units using the matrix [ cos T sin T -sin T cos T 0 0 ].
scale
voidscale(doublesx, doublesy)Parameters
sx: doublesy: double
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.
Returns:
voidSets the current Clip for an Element.
setFont
voidsetFont(Fontfont)Parameters
font: Font
Returns:
voidThe font of 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: String
Returns:
voidThe text of this TextRun.
translate
voidtranslate(doubletx, doublety)Parameters
tx: doublety: double
Returns:
voidTranslate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].