PdfPageTextObject

Kotlin |Java

class PdfPageTextObject : PdfPageObject

kotlin.Any
↳	android.graphics.pdf.component.PdfPageObject
	↳	android.graphics.pdf.component.PdfPageTextObject

Represents a text object on a PDF page. This class extends PageObject and provides methods to access and modify the text content.

Summary

Constants
static Int	`RENDER_MODE_FILL` Fill Mode : Only the interior of the glyphs is filled with the fill color.
static Int	`RENDER_MODE_FILL_STROKE` FillStroke Mode : Both the interior and outline of the glyphs are rendered using the fill abd stroke colors respectively.
static Int	`RENDER_MODE_STROKE` Stroke Mode : Only the outline of the glyphs is stroked with the stroke color.
static Int	`RENDER_MODE_UNKNOWN` Unknown Render Mode.

Public constructors
`PdfPageTextObject(text: String, font: PdfPageTextObjectFont, fontSize: Float)` Constructor for the PdfPageTextObject.

Public methods
Int	`getFillColor()` Returns the fill color of the object.
PdfPageTextObjectFont	`getFont()` Returns the font of the text.
Float	`getFontSize()` Returns the font size of the object.
Int	`getRenderMode()` Returns the render mode of the object.
Int	`getStrokeColor()` Returns the stroke color of the object.
Float	`getStrokeWidth()` Returns the stroke width of the object.
String	`getText()` Returns the text content of the object.
Unit	`setFillColor(fillColor: Int)` Sets the fill color of the object.
Unit	`setRenderMode(renderMode: Int)` Sets the android.
Unit	`setStrokeColor(strokeColor: Int)` Sets the stroke color of the object.
Unit	`setStrokeWidth(strokeWidth: Float)` Sets the stroke width of the object.
Unit	`setText(text: String)` Sets the text content of the object.

Inherited functions

From class PdfPageObject

`FloatArray`	`getMatrix()` Returns the transformation matrix of the object.
`Int`	`getPdfObjectType()` Returns the type of the page object.
`Unit`	`setMatrix(matrix: Matrix)` Sets the transformation matrix of the object.
`Unit`	`transform(a: Float, b: Float, c: Float, d: Float, e: Float, f: Float)` Transform the page object The matrix is composed as: \|a c e\| \|b d f\| and can be used to scale, rotate, shear and translate the \|page_object\|.

Constants

RENDER_MODE_FILL

Added in S Extensions 18

static val RENDER_MODE_FILL: Int

Fill Mode : Only the interior of the glyphs is filled with the fill color.

Value: 0

RENDER_MODE_FILL_STROKE

Added in S Extensions 18

static val RENDER_MODE_FILL_STROKE: Int

FillStroke Mode : Both the interior and outline of the glyphs are rendered using the fill abd stroke colors respectively.

Value: 2

RENDER_MODE_STROKE

Added in S Extensions 18

static val RENDER_MODE_STROKE: Int

Stroke Mode : Only the outline of the glyphs is stroked with the stroke color.

Value: 1

RENDER_MODE_UNKNOWN

Added in S Extensions 18

static val RENDER_MODE_UNKNOWN: Int

Unknown Render Mode.

Value: -1

Public constructors

PdfPageTextObject

Added in S Extensions 18

PdfPageTextObject(
    text: String, 
    font: PdfPageTextObjectFont, 
    fontSize: Float)

Constructor for the PdfPageTextObject. Sets the object type to TEXT and initializes the text color to black.

Parameters
`font`	PdfPageTextObjectFont: The font of the text. This value cannot be `null`.
`fontSize`	Float: The font size of the text.
`text`	String: This value cannot be `null`.

Public methods

getFillColor

Added in S Extensions 18

fun getFillColor(): Int

Returns the fill color of the object. Returns android.graphics.Color#BLACK by default if not set.

Return
`Int`	The fill color of the object.

getFont

Added in S Extensions 18

fun getFont(): PdfPageTextObjectFont

Returns the font of the text.

Return
`PdfPageTextObjectFont`	A copy of the font object. This value cannot be `null`.

getFontSize

Added in S Extensions 18

fun getFontSize(): Float

Returns the font size of the object.

Return
`Float`	The font size.

getRenderMode

Added in S Extensions 18

fun getRenderMode(): Int

Returns the render mode of the object.

Return
`Int`	The render mode of the object. Value is `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_UNKNOWN`, `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_FILL`, `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_STROKE`, or `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_FILL_STROKE`

getStrokeColor

Added in S Extensions 18

fun getStrokeColor(): Int

Returns the stroke color of the object. Returns android.graphics.Color#BLACK by default if not set.

Return
`Int`	The stroke color of the object.

getStrokeWidth

Added in S Extensions 18

fun getStrokeWidth(): Float

Returns the stroke width of the object.

Return
`Float`	The stroke width of the object.

getText

Added in S Extensions 18

fun getText(): String

Returns the text content of the object.

Return
`String`	The text content. This value cannot be `null`.

setFillColor

Added in S Extensions 18

fun setFillColor(fillColor: Int): Unit

Sets the fill color of the object. Setting the fillColor will have no effect if android.graphics.pdf.component.PdfPageTextObject.RenderMode is not RENDER_MODE_FILL or RENDER_MODE_FILL_STROKE.

Parameters
`fillColor`	Int: The fill color of the object.

setRenderMode

Added in S Extensions 18

fun setRenderMode(renderMode: Int): Unit

Sets the android.graphics.pdf.component.PdfPageTextObject.RenderMode of the object.

Parameters
`renderMode`	Int: The android.graphics.pdf.component.PdfPageTextObject.RenderMode to be set. Value is `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_UNKNOWN`, `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_FILL`, `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_STROKE`, or `android.graphics.pdf.component.PdfPageTextObject#RENDER_MODE_FILL_STROKE`

Exceptions
`java.lang.IllegalArgumentException`	if the provided renderMode is invalid.

setStrokeColor

Added in S Extensions 18

fun setStrokeColor(strokeColor: Int): Unit

Sets the stroke color of the object. Setting the strokeColor will have no effect if android.graphics.pdf.component.PdfPageTextObject.RenderMode is not RENDER_MODE_STROKE or RENDER_MODE_FILL_STROKE.

Parameters
`strokeColor`	Int: The stroke color of the object.

setStrokeWidth

Added in S Extensions 18

fun setStrokeWidth(strokeWidth: Float): Unit

Sets the stroke width of the object.

Parameters
`strokeWidth`	Float: The stroke width of the object.

setText

Added in S Extensions 18

fun setText(text: String): Unit

Sets the text content of the object.

Parameters
`text`	String: The text content to set. This value cannot be `null`.