PdfPagePathObject

Kotlin |Java

class PdfPagePathObject : PdfPageObject

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

Represents a path object on a PDF page. This class extends PdfPageObject and provides methods to access and modify the path's content, such as its shape, fill color, stroke color and line width.

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
`PdfPagePathObject(path: Path)` Constructor for the PdfPagePathObject.

Public methods
Int	`getFillColor()` Returns the fill color of the object.
Int	`getRenderMode()` Returns the android.
Int	`getStrokeColor()` Returns the stroke color of the object.
Float	`getStrokeWidth()` Returns the stroke width 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.
Path	`toPath()` Returns the path 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

PdfPagePathObject

Added in S Extensions 18

PdfPagePathObject(path: Path)

Constructor for the PdfPagePathObject. Sets the object type to PdfPageObjectType.PATH.

Parameters
`path`	Path: This value cannot be `null`.

Public methods

getFillColor

Added in S Extensions 18

fun getFillColor(): Int

Returns the fill color of the object. Returns Color.BLACK if #mFillColor is not set.

Return
`Int`	The fill color of the object.

getRenderMode

Added in S Extensions 18

fun getRenderMode(): Int

Returns the android.graphics.pdf.component.PdfPagePathObject.RenderMode of the object. Returns android.graphics.pdf.component.PdfPagePathObject.RenderMode#RENDER_MODE_FILL by default if android.graphics.pdf.component.PdfPagePathObject#mRenderMode is not set.

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

getStrokeColor

Added in S Extensions 18

fun getStrokeColor(): Int

Returns the stroke color of the object.

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.

setFillColor

Added in S Extensions 18

fun setFillColor(fillColor: Int): Unit

Sets the fill color of the object.

Note: The fillColor cannot be transparent and setting the fillColor will have no effect if android.graphics.pdf.component.PdfPagePathObject.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.PdfPagePathObject.RenderMode of the object.

Parameters
`renderMode`	Int: The android.graphics.pdf.component.PdfPagePathObject.RenderMode to be set. Value is `android.graphics.pdf.component.PdfPagePathObject#RENDER_MODE_UNKNOWN`, `android.graphics.pdf.component.PdfPagePathObject#RENDER_MODE_FILL`, `android.graphics.pdf.component.PdfPagePathObject#RENDER_MODE_STROKE`, or `android.graphics.pdf.component.PdfPagePathObject#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.

Note: The strokeColor cannot be transparent and setting the strokeColor will have no effect if android.graphics.pdf.component.PdfPagePathObject.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.

toPath

Added in S Extensions 18

fun toPath(): Path

Returns the path of the object. The returned path object might be an approximation of the one used to create the original one if the original object has elements with curvature.

Note: The path is immutable because the underlying library does not allow modifying the path once it is created.

Return
`Path`	The path. This value cannot be `null`.