Skip to content

Fixed radio/checkbox return values in getAllFieldsTypes() #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
modesty merged 6 commits into from
May 23, 2025
Merged

Fixed radio/checkbox return values in getAllFieldsTypes() #383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a2ef586
Fixed return values for checkboxes and radiogroups
bogie Feb 23, 2025
73e8dd2
Only return field value for selected(checked) radio button
bogie Feb 23, 2025
6c31e69
added missing typescript definition
bogie Mar 10, 2025
260166d
Fixed parsing of checked status for LibreOffice PDFs
bogie Mar 25, 2025
370d12f
Changed typescript version
bogie Apr 15, 2025
f7e860a
Moved parsing of filled out fields to getAllFieldData
bogie Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/pdf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,10 @@ export default class PDFJSClass extends EventEmitter {
return PDFField.getAllFieldsTypes({ Pages: this.pages || [] });
}

getAllFieldData() {
return PDFField.getAllFieldData({ Pages: this.pages || [] });
}

getMergedTextBlocksIfNeeded() {
for (let p = 0; p < this.pages.length; p++) {
let prevText = null;
Expand Down
7 changes: 4 additions & 3 deletions lib/pdfanno.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ import nodeUtil from "util";

//BEGIN - MQZ 9/19/2012. Helper functions to parse acroForm elements
function setupRadioButton(annotation, item) {
let asName = '';
//let asName = '';
//PDF Spec p.689: parent item's DV holds the item's value that is selected by default
const po = annotation.get('Parent');
if (po) {
po.forEach((key, val) => {
if (key === 'DV') {
asName = val.name || '';
//asName = val.name || '';
}
else if (key === 'TU') {
//radio buttons use the alternative text from the parent
Expand All @@ -28,7 +28,8 @@ function setupRadioButton(annotation, item) {
if (key.toLowerCase() !== "off") {
//value if selected
item.value = key; //export value
item.checked = (key === asName); //initial selection state

item.checked = (item.fieldValue === item.value); //initial selection state
}
});

Expand Down
42 changes: 42 additions & 0 deletions lib/pdffield.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@ export default class PDFField {
//static public method to generate fieldsType object based on parser result
static getAllFieldsTypes(data) {
const isFieldReadOnly = field => (field.AM & kFBANotOverridable) ? true : false;

const getFieldBase = field => ({
id: field.id.Id,
type: field.T.Name,
Expand All @@ -295,4 +296,45 @@ export default class PDFField {
});
return retVal;
}

//static public method to generate data output for all field types
static getAllFieldData(data) {
const isFieldReadOnly = field => (field.AM & kFBANotOverridable) ? true : false;

function getFieldValue(field) {
switch(field.T.Name) {
case 'box':
return field.checked === undefined ? false : field.checked;
case 'alpha':
case 'date':
default:
return field.V;
}
}
const getFieldBase = field => ({
id: field.id.Id,
type: field.T.Name,
calc: isFieldReadOnly(field),
value: getFieldValue(field)
});

const retVal = [];
data.Pages.forEach( page => {
page.Boxsets.forEach( boxsets => {
if (boxsets.boxes.length > 1) { //radio button
boxsets.boxes.forEach( box => {
if(box.checked)
retVal.push({ id: boxsets.id.Id, type: "radio", calc: isFieldReadOnly(box), value: box.id.Id });
});
}
else { //checkbox
retVal.push(getFieldBase(boxsets.boxes[0]));
}
});

page.Fields.forEach(field => retVal.push(getFieldBase(field)));

});
return retVal;
}
}
Loading