TextRun Class Documentation
class TextRun : 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(String text, Font font, GraphicState gstate, TextState tstate, Matrix matrix)Parameters
text: Stringfont: Fontgstate: GraphicStatetstate: TextStatematrix: Matrix
Member Function Documentation
clone
Element clone()Returns:
ElementThe 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
Element clone(java.util.EnumSet< ElementCloneFlags > cloneFlags)Parameters
cloneFlags: java.util.EnumSet< ElementCloneFlags >Flags that modify the cloning operation.
Returns:
ElementThe 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 void delete(Boolean disposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized void delete()Returns:
synchronized voidfinalize
void finalize()Returns:
voidgetAdvance
double getAdvance()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
Rect getBoundingBox()Returns:
RectThe 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
Clip getClip()Returns:
Clip- The current Clip for this Element.
Gets the current Clip for an Element.
getFont
Font getFont()Returns:
FontThe font of this TextRun.
getGraphicState
GraphicState getGraphicState()Returns:
GraphicStateGet the graphic state of the text run.
May return null if this element does not have a GraphicState.
getMatrix
Matrix getMatrix()Returns:
MatrixThe transformation matrix for the element.
getRawText
byte[] getRawText()Returns:
byte[]The raw, un-interpreted text as char codes of this TextRun.
getText
String getText()Returns:
StringThe text of this TextRun.
getTextState
TextState getTextState()Returns:
TextStateThe TextState of this TextRun.
rotate
void rotate(double theta)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
void scale(double sx, double sy)Parameters
sx: doublesy: double
Returns:
voidScale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].
setClip
void setClip(Clip clip)Parameters
clip: ClipThe clip to set as the current clip for this element.
Returns:
voidSets the current Clip for an Element.
setFont
void setFont(Font font)Parameters
font: Font
Returns:
voidThe font of this TextRun.
setGraphicState
void setGraphicState(GraphicState gstate)Parameters
gstate: GraphicStatethe new/updated Graphic State for the text run.
Returns:
voidSet the Graphic State of the text run.
setMatrix
void setMatrix(Matrix matrix)Parameters
matrix: Matrixthe transformation matrix for the element.
Returns:
voidSet the transformation matrix for the element.
setText
void setText(String text)Parameters
text: String
Returns:
voidThe text of this TextRun.
translate
void translate(double tx, double ty)Parameters
tx: doublety: double
Returns:
voidTranslate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].