happypdf / PDFAcroButton

Class: PDFAcroButton

Defined in: src/core/acroform/PDFAcroButton.ts:10

Extends

• PDFAcroTerminal

Extended by

• PDFAcroCheckBox
• PDFAcroPushButton
• PDFAcroRadioButton

Constructors

Constructor

protected new PDFAcroButton(dict, ref): PDFAcroButton;

Defined in: src/core/acroform/PDFAcroField.ts:22

Parameters

Parameter	Type
dict	PDFDict
ref	PDFRef

Returns

PDFAcroButton

Inherited from

PDFAcroTerminal.constructor

Properties

dict

readonly dict: PDFDict;

Defined in: src/core/acroform/PDFAcroField.ts:19

Inherited from

PDFAcroTerminal.dict

---

ref

readonly ref: PDFRef;

Defined in: src/core/acroform/PDFAcroField.ts:20

Inherited from

PDFAcroTerminal.ref

Methods

addOpt()

addOpt(opt, useExistingOptIdx): number;

Defined in: src/core/acroform/PDFAcroButton.ts:82

Reuses existing opt if one exists with the same value (assuming useExistingIdx is true). Returns index of existing (or new) opt.

Parameters

Parameter	Type
opt	PDFHexString | PDFString
useExistingOptIdx	boolean

Returns

number

---

addWidget()

addWidget(ref): void;

Defined in: src/core/acroform/PDFAcroTerminal.ts:33

Parameters

Parameter	Type
ref	PDFRef

Returns

void

Inherited from

PDFAcroTerminal.addWidget

---

addWidgetWithOpt()

addWidgetWithOpt(
   widget, 
   opt, 
   useExistingOptIdx): PDFName;

Defined in: src/core/acroform/PDFAcroButton.ts:102

Parameters

Parameter	Type
widget	PDFRef
opt	PDFHexString | PDFString
useExistingOptIdx	boolean

Returns

PDFName

---

ascend()

ascend(visitor): void;

Defined in: src/core/acroform/PDFAcroField.ts:160

Parameters

Parameter	Type
visitor	(node) => any

Returns

void

Inherited from

PDFAcroTerminal.ascend

---

clearFlag()

clearFlag(flag): void;

Defined in: src/core/acroform/PDFAcroField.ts:142

Parameters

Parameter	Type
flag	number

Returns

void

Inherited from

PDFAcroTerminal.clearFlag

---

DA()

DA(): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:49

Returns

| PDFHexString | PDFString | undefined

Inherited from

PDFAcroTerminal.DA

---

Ff()

Ff(): PDFNumber | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:31

Returns

PDFNumber | undefined

Inherited from

PDFAcroTerminal.Ff

---

fromDict()

static fromDict(dict, ref): PDFAcroTerminal;

Defined in: src/core/acroform/PDFAcroTerminal.ts:9

Parameters

Parameter	Type
dict	PDFDict
ref	PDFRef

Returns

PDFAcroTerminal

Inherited from

PDFAcroTerminal.fromDict

---

FT()

FT(): PDFName;

Defined in: src/core/acroform/PDFAcroTerminal.ts:12

Returns

PDFName

Inherited from

PDFAcroTerminal.FT

---

getDefaultAppearance()

getDefaultAppearance(): string | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:97

Returns

string | undefined

Inherited from

PDFAcroTerminal.getDefaultAppearance

---

getExportValues()

getExportValues(): 
  | (PDFHexString | PDFString)[]
  | undefined;

Defined in: src/core/acroform/PDFAcroButton.ts:24

Returns

| (PDFHexString | PDFString)[] | undefined

---

getFlags()

getFlags(): number;

Defined in: src/core/acroform/PDFAcroField.ts:124

Returns

number

Inherited from

PDFAcroTerminal.getFlags

---

getFullyQualifiedName()

getFullyQualifiedName(): string | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:78

Returns

string | undefined

Inherited from

PDFAcroTerminal.getFullyQualifiedName

---

getInheritableAttribute()

getInheritableAttribute(name): PDFObject | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:152

Parameters

Parameter	Type
name	PDFName

Returns

PDFObject | undefined

Inherited from

PDFAcroTerminal.getInheritableAttribute

---

getParent()

getParent(): PDFAcroField | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:59

Returns

PDFAcroField | undefined

Inherited from

PDFAcroTerminal.getParent

---

getPartialName()

getPartialName(): string | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:84

Returns

string | undefined

Inherited from

PDFAcroTerminal.getPartialName

---

getWidgets()

getWidgets(): PDFWidgetAnnotation[];

Defined in: src/core/acroform/PDFAcroTerminal.ts:17

Returns

PDFWidgetAnnotation[]

Inherited from

PDFAcroTerminal.getWidgets

---

hasFlag()

hasFlag(flag): boolean;

Defined in: src/core/acroform/PDFAcroField.ts:132

Parameters

Parameter	Type
flag	number

Returns

boolean

Inherited from

PDFAcroTerminal.hasFlag

---

Kids()

Kids(): PDFArray | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:41

Returns

PDFArray | undefined

Inherited from

PDFAcroTerminal.Kids

---

normalizedEntries()

normalizedEntries(): {
  Kids: PDFArray;
};

Defined in: src/core/acroform/PDFAcroTerminal.ts:54

Returns

{
  Kids: PDFArray;
}

Kids

Kids: PDFArray;

Inherited from

PDFAcroTerminal.normalizedEntries

---

normalizeExportValues()

normalizeExportValues(): void;

Defined in: src/core/acroform/PDFAcroButton.ts:61

Returns

void

---

Opt()

Opt(): 
  | PDFHexString
  | PDFString
  | PDFArray
  | undefined;

Defined in: src/core/acroform/PDFAcroButton.ts:11

Returns

| PDFHexString | PDFString | PDFArray | undefined

---

removeExportValue()

removeExportValue(idx): void;

Defined in: src/core/acroform/PDFAcroButton.ts:44

Parameters

Parameter	Type
idx	number

Returns

void

---

removeWidget()

removeWidget(idx): void;

Defined in: src/core/acroform/PDFAcroTerminal.ts:38

Parameters

Parameter	Type
idx	number

Returns

void

Inherited from

PDFAcroTerminal.removeWidget

---

setDefaultAppearance()

setDefaultAppearance(appearance): void;

Defined in: src/core/acroform/PDFAcroField.ts:93

Parameters

Parameter	Type
appearance	string

Returns

void

Inherited from

PDFAcroTerminal.setDefaultAppearance

---

setFlag()

setFlag(flag): void;

Defined in: src/core/acroform/PDFAcroField.ts:137

Parameters

Parameter	Type
flag	number

Returns

void

Inherited from

PDFAcroTerminal.setFlag

---

setFlags()

setFlags(flags): void;

Defined in: src/core/acroform/PDFAcroField.ts:128

Parameters

Parameter	Type
flags	number

Returns

void

Inherited from

PDFAcroTerminal.setFlags

---

setFlagTo()

setFlagTo(flag, enable): void;

Defined in: src/core/acroform/PDFAcroField.ts:147

Parameters

Parameter	Type
flag	number
enable	boolean

Returns

void

Inherited from

PDFAcroTerminal.setFlagTo

---

setFontSize()

setFontSize(fontSize): void;

Defined in: src/core/acroform/PDFAcroField.ts:107

Parameters

Parameter	Type
fontSize	number

Returns

void

Inherited from

PDFAcroTerminal.setFontSize

---

setKids()

setKids(kids): void;

Defined in: src/core/acroform/PDFAcroField.ts:55

Parameters

Parameter	Type
kids	PDFObject[]

Returns

void

Inherited from

PDFAcroTerminal.setKids

---

setOpt()

setOpt(opt): void;

Defined in: src/core/acroform/PDFAcroButton.ts:20

Parameters

Parameter	Type
opt	PDFObject[]

Returns

void

---

setParent()

setParent(parent): void;

Defined in: src/core/acroform/PDFAcroField.ts:73

Parameters

Parameter	Type
parent	PDFRef | undefined

Returns

void

Inherited from

PDFAcroTerminal.setParent

---

setPartialName()

setPartialName(partialName): void;

Defined in: src/core/acroform/PDFAcroField.ts:88

Parameters

Parameter	Type
partialName	string | undefined

Returns

void

Inherited from

PDFAcroTerminal.setPartialName

---

T()

T(): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:27

Returns

| PDFHexString | PDFString | undefined

Inherited from

PDFAcroTerminal.T

---

V()

V(): PDFObject | undefined;

Defined in: src/core/acroform/PDFAcroField.ts:36

Returns

PDFObject | undefined

Inherited from

PDFAcroTerminal.V