Class PdfDefaultAppearance

Value object that parses and builds DA (Default Appearance) strings. DA format: "/FontName FontSize Tf ColorOp"

Extends PdfString so it can be stored directly in dictionaries without additional wrapping.

Hierarchy (View Summary)

PdfString
- PdfDefaultAppearance

Index

Constructors

constructor

new PdfDefaultAppearance(
    fontName: string,
    fontSize: number,
    colorOp: string,
): PdfDefaultAppearance
Parameters
- fontName: string
- fontSize: number
- colorOp: string
Returns PdfDefaultAppearance
Overrides PdfString.constructor
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:16

Properties

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

Accessors

colorOp

get colorOp(): string
Returns string
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:41
set colorOp(op: string): void
Parameters
- op: string
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:45

fontName

get fontName(): string
Returns string
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:23
set fontName(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:27

isUTF16BE

get isUTF16BE(): boolean
Checks if this string is UTF-16BE encoded (has UTF-16BE BOM). UTF-16BE strings start with the byte order mark 0xFE 0xFF.

Returns boolean
Inherited from PdfString.isUTF16BE
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:58

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfString.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:19

raw

get raw(): ByteArray
Returns ByteArray
Inherited from PdfString.raw
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:39
set raw(raw: ByteArray): void
Parameters
- raw: ByteArray
Returns void
Inherited from PdfString.raw
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:43

value

get value(): string
Returns string
Inherited from PdfString.value
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:81
set value(str: string): void
Parameters
- str: string
Returns void
Inherited from PdfString.value
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:64

Methods

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfString.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:77

clone

clone(): this
Creates a deep clone of the object

Returns this
Inherited from PdfString.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:91

cloneImpl

cloneImpl(): this
Creates a deep clone of the object. Override this method in subclasses to ensure all properties are cloned correctly

Returns this
Inherited from PdfString.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:95

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfString.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:98

isImmutable

isImmutable(): boolean
Indicates whether the object is immutable (cannot be modified)

Returns boolean
Inherited from PdfString.isImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:34

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Inherited from PdfString.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:24

setImmutable

setImmutable(immutable?: boolean): void
Sets the immutable state of the object
Parameters
- immutable: boolean = true
Returns void
Inherited from PdfString.setImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:39

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfString.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:29

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfString.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:53

`Protected`tokenize

tokenize(): PdfStringToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfStringToken[]
Inherited from PdfString.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-string.ts:91

toString

toString(): string
Converts the object to a string representation

Returns string
Overrides PdfString.toString
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:55

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfString.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:44

`Static`parse

parse(da: string): PdfDefaultAppearance | null
Parameters
- da: string
Returns PdfDefaultAppearance | null
- Defined in packages/pdf-lite/src/acroform/fields/pdf-default-appearance.ts:59

Class PdfDefaultAppearance

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfDefaultAppearance

Properties

Protectedimmutable

Protectedmodified

OptionalpostTokens

OptionalpreTokens

Accessors

colorOp

Returns string

Parameters

Returns void

fontName

Returns string

Parameters

Returns void

fontSize

Returns number

Parameters

Returns void

isUTF16BE

Returns boolean

objectType

Returns string

raw

Returns ByteArray

Parameters

Returns void

value

Returns string

Parameters

Returns void

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

cloneImpl

Returns this

equals

Parameters

Returns boolean

isImmutable

Returns boolean

isModified

Returns boolean

setImmutable

Parameters

Returns void

setModified

Parameters

Returns void

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfStringToken[]

toString

Returns string

toTokens

Returns PdfToken[]

Staticparse

Parameters

Returns PdfDefaultAppearance | null

Settings

On This Page

`Protected`immutable

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize

`Static`parse