This is an automated email from the ASF dual-hosted git repository.
pjfanning pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/poi.git
The following commit(s) were added to refs/heads/trunk by this push:
new 0599903bbf XWPF: text of wrapped runs in inline SDTs and of custom XML
cells (#1434)
0599903bbf is described below
commit 0599903bbf52a134c4e194bf4fea02e7ab3cee7c
Author: PJ Fanning <[email protected]>
AuthorDate: Sat Oct 17 21:54:57 2026 +0100
XWPF: text of wrapped runs in inline SDTs and of custom XML cells (#1434)
XWPFSDTContent for an inline SDT only took w:r and nested w:sdt, so runs
inside hyperlinks, simple fields, smart tags and custom XML runs were lost
from the SDT's text and from XWPFWordExtractor. Read them the way
XWPFParagraph does.
XWPFTableRow.getTableICells skipped cells wrapped in w:customXml. Include
them, however deeply nested.
Co-authored-by: Claude Opus 5.5 <[email protected]>
---
.../apache/poi/xwpf/usermodel/XWPFSDTContent.java | 20 ++++++++++++-
.../apache/poi/xwpf/usermodel/XWPFTableRow.java | 12 ++++++--
.../poi/xwpf/extractor/TestXWPFWordExtractor.java | 21 +++++++++++++
.../org/apache/poi/xwpf/usermodel/TestXWPFSDT.java | 35 ++++++++++++++++++++++
.../poi/xwpf/usermodel/TestXWPFTableRow.java | 21 +++++++++++++
src/resources/ooxml-lite-report.clazz | 1 +
src/resources/ooxml-lite-report.xsb | 1 +
7 files changed, 108 insertions(+), 3 deletions(-)
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
index fefb62774c..b100a909e0 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
@@ -44,7 +44,15 @@ public class XWPFSDTContent implements ISDTContent {
if (sdtRun == null) {
return;
}
- try (final XmlCursor cursor = sdtRun.newCursor()) {
+ addRuns(sdtRun, part, parent);
+ }
+
+ /**
+ * Add the runs in container, including those inside hyperlinks, simple
fields,
+ * smart tags and custom XML runs, as XWPFParagraph does for its own runs.
+ */
+ private void addRuns(XmlObject container, IBody part, IRunBody parent) {
+ try (final XmlCursor cursor = container.newCursor()) {
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject();
@@ -54,6 +62,16 @@ public class XWPFSDTContent implements ISDTContent {
} else if (o instanceof CTSdtRun sdt) {
XWPFSDT c = new XWPFSDT(sdt, part);
bodyElements.add(c);
+ } else if (o instanceof CTHyperlink link) {
+ for (CTR r : link.getRArray()) {
+ bodyElements.add(new XWPFHyperlinkRun(link, r,
parent));
+ }
+ } else if (o instanceof CTSimpleField field) {
+ for (CTR r : field.getRArray()) {
+ bodyElements.add(new XWPFFieldRun(field, r, parent));
+ }
+ } else if (o instanceof CTSmartTagRun || o instanceof
CTCustomXmlRun) {
+ addRuns(o, part, parent);
}
}
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
index 2bac81b68d..b700968d5b 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
@@ -28,6 +28,7 @@ import org.apache.poi.util.Units;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.openxmlformats.schemas.officeDocument.x2006.sharedTypes.STOnOff1;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCustomXmlCell;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHeight;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
@@ -194,7 +195,13 @@ public class XWPFTableRow {
List<ICell> cells = new ArrayList<>();
//Can't use ctRow.getTcList because that only gets table cells
//Can't use ctRow.getSdtList because that only gets sdts that are at
cell level
- try (XmlCursor cursor = ctRow.newCursor()) {
+ addTableICells(ctRow, cells);
+ return cells;
+ }
+
+ // cells wrapped in custom XML cells (w:customXml) count as cells of this
row
+ private void addTableICells(XmlObject container, List<ICell> cells) {
+ try (XmlCursor cursor = container.newCursor()) {
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject();
@@ -202,10 +209,11 @@ public class XWPFTableRow {
cells.add(new XWPFTableCell((CTTc) o, this,
table.getBody()));
} else if (o instanceof CTSdtCell) {
cells.add(new XWPFSDTCell((CTSdtCell) o, this,
table.getBody()));
+ } else if (o instanceof CTCustomXmlCell) {
+ addTableICells(o, cells);
}
}
}
- return cells;
}
/**
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/extractor/TestXWPFWordExtractor.java
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/extractor/TestXWPFWordExtractor.java
index e1b97e78e5..4d6291d855 100644
---
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/extractor/TestXWPFWordExtractor.java
+++
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/extractor/TestXWPFWordExtractor.java
@@ -41,7 +41,9 @@ import org.apache.poi.xwpf.usermodel.XWPFSDT;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.junit.jupiter.api.Test;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtBlock;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentRun;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtRun;
@@ -545,4 +547,23 @@ class TestXWPFWordExtractor {
return allsdts;
}
+ @Test
+ void testCustomXmlCellsAndWrappedRunsInSdt() throws IOException {
+ try (XWPFDocument doc = new XWPFDocument()) {
+ CTRow row = doc.getDocument().getBody().addNewTbl().addNewTr();
+
row.addNewCustomXml().addNewTc().addNewP().addNewR().addNewT().setStringValue("custom
cell");
+
row.addNewSdt().addNewSdtContent().addNewTc().addNewP().addNewR().addNewT().setStringValue("sdt
cell");
+
+ CTSdtContentRun content =
doc.getDocument().getBody().addNewP().addNewSdt().addNewSdtContent();
+ content.addNewR().addNewT().setStringValue("run ");
+ content.addNewHyperlink().addNewR().addNewT().setStringValue("link
");
+
content.addNewFldSimple().addNewR().addNewT().setStringValue("field ");
+ content.addNewSmartTag().addNewR().addNewT().setStringValue("tag");
+
+ try (XWPFDocument doc2 =
XWPFTestDataSamples.writeOutAndReadBack(doc);
+ XWPFWordExtractor extractor = new XWPFWordExtractor(doc2)) {
+ assertEquals("custom cell\tsdt cell\n\nrun link field tag\n",
extractor.getText());
+ }
+ }
+ }
}
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFSDT.java
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFSDT.java
index 726bd8dad9..7d722bc26f 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFSDT.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFSDT.java
@@ -28,12 +28,47 @@ import java.util.List;
import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.junit.jupiter.api.Test;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentRun;
public final class TestXWPFSDT {
/**
* Test text extraction from nested SDTs
*/
+ /**
+ * Runs inside hyperlinks, simple fields, smart tags and custom XML runs
+ * within an inline SDT are part of its content.
+ */
+ @Test
+ void testInlineSdtWithWrappedRuns() throws IOException {
+ try (XWPFDocument doc = new XWPFDocument()) {
+ CTP ctp = doc.createParagraph().getCTP();
+ CTSdtContentRun content = ctp.addNewSdt().addNewSdtContent();
+ addRunWithText(content.addNewR(), "run ");
+ addRunWithText(content.addNewHyperlink().addNewR(), "link ");
+ addRunWithText(content.addNewFldSimple().addNewR(), "field ");
+ addRunWithText(content.addNewSmartTag().addNewR(), "tag ");
+ addRunWithText(content.addNewCustomXml().addNewR(), "custom");
+
+ XWPFParagraph p = new XWPFParagraph(ctp, doc);
+ XWPFSDT sdt = assertInstanceOf(XWPFSDT.class, p.getIRuns().get(0));
+ XWPFSDTContent sdtContent = assertInstanceOf(XWPFSDTContent.class,
sdt.getContent());
+
+ List<ISDTContents> elements = sdtContent.getBodyElements();
+ assertEquals(5, elements.size());
+ assertInstanceOf(XWPFHyperlinkRun.class, elements.get(1));
+ assertInstanceOf(XWPFFieldRun.class, elements.get(2));
+ assertEquals("run link field tag custom", sdtContent.getText());
+ assertEquals("run link field tag custom", p.getText());
+ }
+ }
+
+ private static void addRunWithText(CTR r, String text) {
+ r.addNewT().setStringValue(text);
+ }
+
@Test
void testNestedSDTs() throws Exception {
try (XWPFDocument doc =
XWPFTestDataSamples.openSampleDocument("Bug64561.docx")) {
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFTableRow.java
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFTableRow.java
index 54772bda18..d088c7cd20 100644
---
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFTableRow.java
+++
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFTableRow.java
@@ -19,16 +19,19 @@ package org.apache.poi.xwpf.usermodel;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
+import java.util.List;
import org.apache.poi.ooxml.util.POIXMLUnits;
import org.apache.poi.util.Units;
import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.junit.jupiter.api.Test;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHeight;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STHeightRule;
class TestXWPFTableRow {
@@ -199,4 +202,22 @@ class TestXWPFTableRow {
assertEquals(twipsPerInch/10.,
Units.toDXA(POIXMLUnits.parseLength(height.xgetVal())), 0);
}
}
+
+ @Test
+ void testTableICellsIncludeCustomXmlCells() throws IOException {
+ try (XWPFDocument doc = new XWPFDocument()) {
+ XWPFTable table = doc.createTable();
+ CTRow ctRow = table.getRow(0).getCtRow();
+
ctRow.addNewCustomXml().addNewTc().addNewP().addNewR().addNewT().setStringValue("custom");
+
ctRow.addNewSdt().addNewSdtContent().addNewTc().addNewP().addNewR().addNewT().setStringValue("sdt");
+
ctRow.addNewCustomXml().addNewCustomXml().addNewTc().addNewP().addNewR().addNewT().setStringValue("nested");
+
+ List<ICell> cells = new XWPFTableRow(ctRow,
table).getTableICells();
+ assertEquals(4, cells.size());
+ assertInstanceOf(XWPFTableCell.class, cells.get(0));
+ assertEquals("custom", assertInstanceOf(XWPFTableCell.class,
cells.get(1)).getText());
+ assertInstanceOf(XWPFSDTCell.class, cells.get(2));
+ assertEquals("nested", assertInstanceOf(XWPFTableCell.class,
cells.get(3)).getText());
+ }
+ }
}
diff --git a/src/resources/ooxml-lite-report.clazz
b/src/resources/ooxml-lite-report.clazz
index f316c852ac..7aad4ea1d6 100644
--- a/src/resources/ooxml-lite-report.clazz
+++ b/src/resources/ooxml-lite-report.clazz
@@ -2563,3 +2563,4 @@
org/openxmlformats/schemas/wordprocessingml/x2006/main/CTCustomXmlRow
org/openxmlformats/schemas/wordprocessingml/x2006/main/impl/CTCustomXmlRowImpl
org/openxmlformats/schemas/wordprocessingml/x2006/main/CTCustomXmlCell
org/openxmlformats/schemas/officeDocument/x2006/sharedTypes/STConformanceClass
+org/openxmlformats/schemas/wordprocessingml/x2006/main/impl/CTCustomXmlCellImpl
diff --git a/src/resources/ooxml-lite-report.xsb
b/src/resources/ooxml-lite-report.xsb
index 4325381a88..b806a72bc1 100644
--- a/src/resources/ooxml-lite-report.xsb
+++ b/src/resources/ooxml-lite-report.xsb
@@ -1194,3 +1194,4 @@ sthpercentwithsymbole671type
sthpercentushort0848type
ctpath2dquadbezierto3f53type
ctcustomxmlrowedd4type
+ctcustomxmlcell706atype
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]