happypdf / PDFAcroListBox

Class: PDFAcroListBox

Defined in: src/core/acroform/PDFAcroListBox.ts:6

Extends

• PDFAcroChoice

Constructors

Constructor

protected new PDFAcroListBox(dict, ref): PDFAcroListBox;

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

Parameters

Parameter	Type
dict	PDFDict
ref	PDFRef

Returns

PDFAcroListBox

Inherited from

PDFAcroChoice.constructor

Properties

dict

readonly dict: PDFDict;

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

Inherited from

PDFAcroChoice.dict

---

ref

readonly ref: PDFRef;

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

Inherited from

PDFAcroChoice.ref

Methods

addWidget()

addWidget(ref): void;

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

Parameters

Parameter	Type
ref	PDFRef

Returns

void

Inherited from

PDFAcroChoice.addWidget

---

ascend()

ascend(visitor): void;

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

Parameters

Parameter	Type
visitor	(node) => any

Returns

void

Inherited from

PDFAcroChoice.ascend

---

clearFlag()

clearFlag(flag): void;

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

Parameters

Parameter	Type
flag	number

Returns

void

Inherited from

PDFAcroChoice.clearFlag

---

create()

static create(context): PDFAcroListBox;

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

Parameters

Parameter	Type
context	PDFContext

Returns

PDFAcroListBox

---

DA()

DA(): 
  | PDFHexString
  | PDFString
  | undefined;

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

Returns

| PDFHexString | PDFString | undefined

Inherited from

PDFAcroChoice.DA

---

Ff()

Ff(): PDFNumber | undefined;

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

Returns

PDFNumber | undefined

Inherited from

PDFAcroChoice.Ff

---

fromDict()

static fromDict(dict, ref): PDFAcroListBox;

Defined in: src/core/acroform/PDFAcroListBox.ts:7

Parameters

Parameter	Type
dict	PDFDict
ref	PDFRef

Returns

PDFAcroListBox

Overrides

PDFAcroChoice.fromDict

---

FT()

FT(): PDFName;

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

Returns

PDFName

Inherited from

PDFAcroChoice.FT

---

getDefaultAppearance()

getDefaultAppearance(): string | undefined;

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

Returns

string | undefined

Inherited from

PDFAcroChoice.getDefaultAppearance

---

getFlags()

getFlags(): number;

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

Returns

number

Inherited from

PDFAcroChoice.getFlags

---

getFullyQualifiedName()

getFullyQualifiedName(): string | undefined;

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

Returns

string | undefined

Inherited from

PDFAcroChoice.getFullyQualifiedName

---

getInheritableAttribute()

getInheritableAttribute(name): PDFObject | undefined;

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

Parameters

Parameter	Type
name	PDFName

Returns

PDFObject | undefined

Inherited from

PDFAcroChoice.getInheritableAttribute

---

getOptions()

getOptions(): {
  display: PDFHexString | PDFString;
  value: PDFHexString | PDFString;
}[];

Defined in: src/core/acroform/PDFAcroChoice.ts:106

Returns

{ display: PDFHexString | PDFString; value: PDFHexString | PDFString; }[]

Inherited from

PDFAcroChoice.getOptions

---

getParent()

getParent(): PDFAcroField | undefined;

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

Returns

PDFAcroField | undefined

Inherited from

PDFAcroChoice.getParent

---

getPartialName()

getPartialName(): string | undefined;

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

Returns

string | undefined

Inherited from

PDFAcroChoice.getPartialName

---

getValues()

getValues(): (PDFHexString | PDFString)[];

Defined in: src/core/acroform/PDFAcroChoice.ts:62

Returns

(PDFHexString | PDFString)[]

Inherited from

PDFAcroChoice.getValues

---

getWidgets()

getWidgets(): PDFWidgetAnnotation[];

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

Returns

PDFWidgetAnnotation[]

Inherited from

PDFAcroChoice.getWidgets

---

hasFlag()

hasFlag(flag): boolean;

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

Parameters

Parameter	Type
flag	number

Returns

boolean

Inherited from

PDFAcroChoice.hasFlag

---

Kids()

Kids(): PDFArray | undefined;

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

Returns

PDFArray | undefined

Inherited from

PDFAcroChoice.Kids

---

normalizedEntries()

normalizedEntries(): {
  Kids: PDFArray;
};

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

Returns

{
  Kids: PDFArray;
}

Kids

Kids: PDFArray;

Inherited from

PDFAcroChoice.normalizedEntries

---

Opt()

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

Defined in: src/core/acroform/PDFAcroChoice.ts:83

Returns

| PDFHexString | PDFString | PDFArray | undefined

Inherited from

PDFAcroChoice.Opt

---

removeWidget()

removeWidget(idx): void;

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

Parameters

Parameter	Type
idx	number

Returns

void

Inherited from

PDFAcroChoice.removeWidget

---

setDefaultAppearance()

setDefaultAppearance(appearance): void;

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

Parameters

Parameter	Type
appearance	string

Returns

void

Inherited from

PDFAcroChoice.setDefaultAppearance

---

setFlag()

setFlag(flag): void;

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

Parameters

Parameter	Type
flag	number

Returns

void

Inherited from

PDFAcroChoice.setFlag

---

setFlags()

setFlags(flags): void;

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

Parameters

Parameter	Type
flags	number

Returns

void

Inherited from

PDFAcroChoice.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

PDFAcroChoice.setFlagTo

---

setFontSize()

setFontSize(fontSize): void;

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

Parameters

Parameter	Type
fontSize	number

Returns

void

Inherited from

PDFAcroChoice.setFontSize

---

setKids()

setKids(kids): void;

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

Parameters

Parameter	Type
kids	PDFObject[]

Returns

void

Inherited from

PDFAcroChoice.setKids

---

setOptions()

setOptions(options): void;

Defined in: src/core/acroform/PDFAcroChoice.ts:92

Parameters

Parameter	Type
options	{ display?: PDFHexString | PDFString; value: PDFHexString | PDFString; }[]

Returns

void

Inherited from

PDFAcroChoice.setOptions

---

setParent()

setParent(parent): void;

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

Parameters

Parameter	Type
parent	PDFRef | undefined

Returns

void

Inherited from

PDFAcroChoice.setParent

---

setPartialName()

setPartialName(partialName): void;

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

Parameters

Parameter	Type
partialName	string | undefined

Returns

void

Inherited from

PDFAcroChoice.setPartialName

---

setValues()

setValues(values): void;

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

Parameters

Parameter	Type
values	(PDFHexString | PDFString)[]

Returns

void

Inherited from

PDFAcroChoice.setValues

---

T()

T(): 
  | PDFHexString
  | PDFString
  | undefined;

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

Returns

| PDFHexString | PDFString | undefined

Inherited from

PDFAcroChoice.T

---

updateSelectedIndices()

updateSelectedIndices(values): void;

Defined in: src/core/acroform/PDFAcroChoice.ts:46

Parameters

Parameter	Type
values	(PDFHexString | PDFString)[]

Returns

void

Inherited from

PDFAcroChoice.updateSelectedIndices

---

V()

V(): PDFObject | undefined;

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

Returns

PDFObject | undefined

Inherited from

PDFAcroChoice.V

---

valuesAreValid()

valuesAreValid(values): boolean;

Defined in: src/core/acroform/PDFAcroChoice.ts:35

Parameters

Parameter	Type
values	(PDFHexString | PDFString)[]

Returns

boolean

Inherited from

PDFAcroChoice.valuesAreValid