Skip to content

Fix Bug 66263 — Add support for reading SDT row in tables #971

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

Open
hostedbygnome wants to merge 7 commits into
base: trunk
Choose a base branch
from
Open

Fix Bug 66263 — Add support for reading SDT row in tables #971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
85f4837
Fix Bug 66263 — Add support for SDT row in tables
Dec 16, 2025
e0f3da1
remove repeated if
Dec 16, 2025
5c75ebe
add missing imports
Dec 16, 2025
9ba7239
add tests
Apr 6, 2026
34f3fa6
add tests
Apr 6, 2026
fe8e05f
add tests with file + fix paragraph duplication
Apr 6, 2026
d992752
fix indentation
Apr 6, 2026
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
25 changes: 24 additions & 1 deletion poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,22 @@ private void buildRunsInOrderFromXml(XmlObject object) {
if (o instanceof CTSdtBlock) {
XWPFSDT cc = new XWPFSDT((CTSdtBlock) o, part);
iruns.add(cc);
CTSdtContentBlock content = ((CTSdtBlock)o).getSdtContent();
if (content != null) {
for (CTP ctp : content.getPList()) {
processCTRs(ctp.getRList());
}
}
}
if (o instanceof CTSdtRun) {
XWPFSDT cc = new XWPFSDT((CTSdtRun) o, part);
XWPFSDT cc = new XWPFSDT((CTSdtRun)o, part);
iruns.add(cc);

CTSdtContentRun sdtContent = ((CTSdtRun)o).getSdtContent();
if (sdtContent != null)
{
processCTRs(sdtContent.getRList());
}
}
if (o instanceof CTRunTrackChange) {
final CTRunTrackChange parentRecord = (CTRunTrackChange) o;
Expand All @@ -164,6 +176,17 @@ private void buildRunsInOrderFromXml(XmlObject object) {
}
}

private void processCTRs(List<CTR> ctrs) {
if (ctrs == null) {
return;
}
for (CTR ctr : ctrs) {
if (ctr.getRPr() != null) {
runs.add(new XWPFRun(ctr, (IRunBody)this));
}
}
}

@Internal
public CTP getCTP() {
return paragraph;
Expand Down
65 changes: 52 additions & 13 deletions poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFTable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,15 @@ Licensed to the Apache Software Foundation (ASF) under one or more
import org.apache.poi.ooxml.util.POIXMLUnits;
import org.apache.poi.util.Internal;
import org.apache.poi.util.Units;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDecimalNumber;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTJcTable;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTString;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblBorders;
Expand Down Expand Up @@ -168,24 +172,59 @@ public XWPFTable(CTTbl table, IBody part, boolean initRow) {
createEmptyTable(table);
}

for (CTRow row : table.getTrList()) {
StringBuilder rowText = new StringBuilder();
XWPFTableRow tabRow = new XWPFTableRow(row, this);
tableRows.add(tabRow);
for (CTTc cell : row.getTcList()) {
for (CTP ctp : cell.getPList()) {
XWPFParagraph p = new XWPFParagraph(ctp, part);
if (rowText.length() > 0) {
rowText.append('\t');
try (XmlCursor cursor = table.newCursor()) {
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
XmlObject xmlObject = cursor.getObject();
if (xmlObject instanceof CTRow) {
processCTRow((CTRow)xmlObject);
}
else if (xmlObject instanceof CTSdtRow) {
List<CTRow> rows = new ArrayList<>();
collectCTRowsInnerSdtRow((CTSdtRow)xmlObject, rows);
for (CTRow row : rows)
{
processCTRow(row);
}
rowText.append(p.getText());
}
}
if (rowText.length() > 0) {
this.text.append(rowText);
this.text.append('\n');
}
}

private void processCTRow(CTRow row) {
StringBuilder rowText = new StringBuilder();
XWPFTableRow tableRow = new XWPFTableRow(row, this);
tableRows.add(tableRow);
for (CTTc cell : row.getTcList()) {
for (CTP ctp : cell.getPList()) {
XWPFParagraph p = new XWPFParagraph(ctp, part);
if (rowText.length() > 0) {
rowText.append('\t');
}
rowText.append(p.getText());
}
}
if (rowText.length() > 0) {
this.text.append(rowText);
this.text.append('\n');
}
}

private void collectCTRowsInnerSdtRow(CTSdtRow sdtRow, List<CTRow> rows) {
CTSdtContentRow sdtContent = sdtRow.getSdtContent();
if (sdtContent == null) {
return;
}

List<CTRow> rowsInnerSdtContent = sdtContent.getTrList();
if (!rowsInnerSdtContent.isEmpty()) {
rows.addAll(rowsInnerSdtContent);
return;
}

for (CTSdtRow innerSdt : sdtContent.getSdtList()) {
collectCTRowsInnerSdtRow(innerSdt, rows);
}
}

private void createEmptyTable(CTTbl table) {
Expand Down
155 changes: 155 additions & 0 deletions poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFParagraph.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Licensed to the Apache Software Foundation (ASF) under one or more
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPBdr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtBlock;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentBlock;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentRun;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtRun;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacing;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTextAlignment;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder;
Expand Down Expand Up @@ -975,4 +979,155 @@ private static void checkSearchText(XWPFParagraph paragraph, String search, int
assertEquals(beginChar, result.getBeginChar(), "beginChar");
assertEquals(endChar, result.getEndChar(), "endChar");
}

@Test
void testParagraphWithSdtRunAndContent() throws IOException {
try (XWPFDocument doc = new XWPFDocument()) {
XWPFParagraph p = doc.createParagraph();

CTP ctp = p.getCTP();

CTR normalRun = ctp.addNewR();
normalRun.addNewT().setStringValue("Before ");

CTSdtRun sdtRun = ctp.addNewSdt();
CTSdtContentRun content = sdtRun.addNewSdtContent();

CTR innerRun = content.addNewR();
innerRun.addNewRPr().addNewB().setVal(STOnOff1.ON);
innerRun.addNewT().setStringValue("SDT Run Content");

CTR innerRun2 = content.addNewR();
innerRun2.addNewRPr().addNewI().setVal(STOnOff1.ON);
innerRun2.addNewT().setStringValue(" More");

CTR afterRun = ctp.addNewR();
afterRun.addNewT().setStringValue(" After");

XWPFParagraph newParagraph = new XWPFParagraph(ctp, doc);

// getRuns() includes: normal runs (always) + SDT content runs with RPr
// Before (1) + SDT Run Content (1) + More (1) + After (1) = 4 runs
List<XWPFRun> runs = newParagraph.getRuns();
assertEquals(4, runs.size(), "Should have 4 runs (2 normal + 2 SDT with RPr)");

// getIRuns() includes SDT elements, but SDT runs from processCTRs are NOT in iruns
// Before (1) + SDT (1) + After (1) = 3
List<IRunElement> iruns = newParagraph.getIRuns();
assertEquals(3, iruns.size(), "Should have 3 elements (SDT runs are not in iruns)");

// Verify text includes SDT content (text is also duplicated)
String text = newParagraph.getText();
assertTrue(text.contains("Before"), "Text should contain 'Before'");
assertTrue(text.contains("SDT Run Content"), "Text should contain 'SDT Run Content'");
assertTrue(text.contains(" More"), "Text should contain ' More'");
assertTrue(text.contains("After"), "Text should contain 'After'");
}
}

@Test
void testParagraphWithMultipleSdtRuns() throws IOException {
try (XWPFDocument doc = new XWPFDocument()) {
XWPFParagraph p = doc.createParagraph();

CTP ctp = p.getCTP();

CTSdtRun sdtRun1 = ctp.addNewSdt();
CTSdtContentRun content1 = sdtRun1.addNewSdtContent();
CTR innerRun1 = content1.addNewR();
innerRun1.addNewRPr().addNewB().setVal(STOnOff1.ON);
innerRun1.addNewT().setStringValue("First");

CTR normalRun = ctp.addNewR();
normalRun.addNewT().setStringValue(" Middle ");

CTSdtRun sdtRun2 = ctp.addNewSdt();
CTSdtContentRun content2 = sdtRun2.addNewSdtContent();
CTR innerRun2 = content2.addNewR();
innerRun2.addNewRPr().addNewI().setVal(STOnOff1.ON);
innerRun2.addNewT().setStringValue("Second");

XWPFParagraph newParagraph = new XWPFParagraph(ctp, doc);

// getRuns() includes: normal run (always) + SDT content runs with RPr
// First (1) + Middle (1) + Second (1) = 3 runs
List<XWPFRun> runs = newParagraph.getRuns();
assertEquals(3, runs.size(), "Should have 3 runs (1 normal + 2 SDT with RPr)");

// getIRuns() includes SDT elements, but SDT runs from processCTRs are NOT in iruns
// SDT1 (1) + Middle (1) + SDT2 (1) = 3 (SDT runs are in runs, not iruns)
List<IRunElement> iruns = newParagraph.getIRuns();
assertEquals(3, iruns.size(), "Should have 3 elements (SDT runs are in runs, not iruns)");

// Verify text includes all content
String text = newParagraph.getText();
assertTrue(text.contains("First"), "Text should contain 'First' from SDT run");
assertTrue(text.contains("Middle"), "Text should contain 'Middle' from normal run");
assertTrue(text.contains("Second"), "Text should contain 'Second' from SDT run");
}
}

/**
* Bug 66263 — Test SDT runs in paragraph using sample document.
* Verifies that SDT runs with and without RPr are processed correctly.
*/
@Test
void testSdtRunsFromSampleDocument() throws IOException {
try (XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Bug66263-paragraph.docx")) {
List<XWPFParagraph> paragraphs = doc.getParagraphs();

// Paragraph 1: SDT Run with RPr
XWPFParagraph paragraph1 = paragraphs.get(0);
String paragraph1Text = paragraph1.getText();
assertTrue(paragraph1Text.contains("Before"), "Paragraph 1 should contain 'Before'");
assertTrue(paragraph1Text.contains("SDT Run with RPr"), "Paragraph 1 should contain SDT run with RPr");
assertTrue(paragraph1Text.contains("After"), "Paragraph 1 should contain 'After'");

// getRuns() contains: 2 normal runs (always added) + 1 SDT run (added because it has RPr) = 3 runs
List<XWPFRun> runs1 = paragraph1.getRuns();
assertEquals(3, runs1.size(), "Paragraph 1 should have 3 runs (2 normal + 1 SDT with RPr)");
assertEquals("Before ", runs1.get(0).toString(), "First run should be 'Before'");
assertEquals("SDT Run with RPr", runs1.get(1).toString(), "Second run should be SDT content");
assertEquals(" After", runs1.get(2).toString(), "Third run should be 'After'");

// getIRuns() should contain all elements including SDT
List<IRunElement> iruns1 = paragraph1.getIRuns();
assertEquals(3, iruns1.size(), "Paragraph 1 should have 3 elements in getIRuns() (2 normal runs + 1 SDT)");

// Paragraph 2: SDT Run without RPr
XWPFParagraph paragraph2 = paragraphs.get(1);
String paragraph2Text = paragraph2.getText();
assertTrue(paragraph2Text.contains("Before No RPr"), "Paragraph 2 should contain 'Before No RPr'");
assertTrue(paragraph2Text.contains("SDT Run without RPr"), "Paragraph 2 should contain SDT run without RPr");
assertTrue(paragraph2Text.contains("After"), "Paragraph 2 should contain 'After'");

// getRuns() contains: 2 normal runs (always added) + 0 SDT runs (no RPr) = 2 runs
List<XWPFRun> runs2 = paragraph2.getRuns();
assertEquals(2, runs2.size(), "Paragraph 2 should have 2 runs (normal runs only, no SDT runs without RPr)");
assertEquals("Before No RPr ", runs2.get(0).toString(), "First run should be 'Before No RPr'");
assertEquals(" After", runs2.get(1).toString(), "Second run should be 'After'");

// getIRuns() should still contain all elements
List<IRunElement> iruns2 = paragraph2.getIRuns();
assertEquals(3, iruns2.size(), "Paragraph 2 should have 3 elements in getIRuns() (2 normal runs + 1 SDT)");

// Paragraph 3: Multiple SDT Runs
XWPFParagraph paragraph3 = paragraphs.get(2);
String paragraph3Text = paragraph3.getText();
assertTrue(paragraph3Text.contains("First"), "Paragraph 3 should contain 'First' from first SDT");
assertTrue(paragraph3Text.contains("Middle"), "Paragraph 3 should contain 'Middle'");
assertTrue(paragraph3Text.contains("Second"), "Paragraph 3 should contain 'Second' from second SDT");

// getRuns() contains: 1 normal run (always added) + 2 SDT runs (both have RPr) = 3 runs
List<XWPFRun> runs3 = paragraph3.getRuns();
assertEquals(3, runs3.size(), "Paragraph 3 should have 3 runs (1 normal + 2 SDT runs with RPr)");
assertTrue(runs3.get(0).toString().contains("First"), "First run should contain 'First'");
assertEquals(" Middle ", runs3.get(1).toString(), "Second run should be 'Middle'");
assertTrue(runs3.get(2).toString().contains("Second"), "Third run should contain 'Second'");

// getIRuns() should contain 3 elements (2 SDTs + 1 normal run)
List<IRunElement> iruns3 = paragraph3.getIRuns();
assertEquals(3, iruns3.size(), "Paragraph 3 should have 3 elements in getIRuns() (2 SDTs + 1 normal run)");
}
}
}
Loading