Question

我实际上是使用Apache POI生成Word文档，我需要自动创建一个引用段落的目录（TOC）及其页面指示。

这是我正在使用的代码（我省略了前置条件和内部方法＆＃39;正文）：

XWPFDocument doc = new XWPFDocument(OPCPackage.openOrCreate(new File(document)));

String strStyleId = "Index Style";
addCustomHeadingStyle(doc, strStyleId, 1);

XWPFParagraph documentControlHeading = doc.createParagraph();
changeText(documentControlHeading, "First try");
documentControlHeading.setAlignment(ParagraphAlignment.LEFT);
documentControlHeading.setPageBreak(true);
documentControlHeading.setStyle(strStyleId);

XWPFParagraph documentControlHeading1 = doc.createParagraph();
changeText(documentControlHeading1, "Second try");
documentControlHeading1.setAlignment(ParagraphAlignment.LEFT);
documentControlHeading1.setPageBreak(true);
documentControlHeading1.setStyle(strStyleId);

doc.createTOC();

当我打开生成的文档时，我得到了这个结果（见蓝色方块）：

在左侧部分，我可以看到生成的TOC。到现在为止还挺好。但是，在文件的正文中，我只能看到一个静态文本＆＃34;目录＆＃34;，根本没有任何指示（既没有段落也没有页面）。我甚至无法与之互动。

如果我点击菜单条目＆＃34;目录＆＃34; （左上角的红色方块），＆＃34;真实＆＃34;正在生成我想要的内容表（当然是按照箭头......）。

我的问题是： 如何从代码中获得第二个结果（红色TOC）？

非常感谢你。

旁注：我甚至尝试在doc.enforceUpdateFields();之后添加doc.createTOC();，但是TOC的每个参考都会以这种方式消失。

@Sucy，我添加了您请求的方法。不过，不知道你是否能发现它们有用：

/*
 * Adds a custom style with the given indentation level at the given document.
 */
private static void addCustomHeadingStyle(XWPFDocument docxDocument, String strStyleId, int headingLevel) {

    CTStyle ctStyle = CTStyle.Factory.newInstance();
    ctStyle.setStyleId(strStyleId);

    CTString styleName = CTString.Factory.newInstance();
    styleName.setVal(strStyleId);
    ctStyle.setName(styleName);

    CTDecimalNumber indentNumber = CTDecimalNumber.Factory.newInstance();
    indentNumber.setVal(BigInteger.valueOf(headingLevel));

    // lower number > style is more prominent in the formats bar
    ctStyle.setUiPriority(indentNumber);

    CTOnOff onoffnull = CTOnOff.Factory.newInstance();
    ctStyle.setUnhideWhenUsed(onoffnull);

    // style shows up in the formats bar
    ctStyle.setQFormat(onoffnull);

    // style defines a heading of the given level
    CTPPr ppr = CTPPr.Factory.newInstance();
    ppr.setOutlineLvl(indentNumber);
    ctStyle.setPPr(ppr);

    XWPFStyle style = new XWPFStyle(ctStyle);

    // is a null op if already defined
    XWPFStyles styles = docxDocument.createStyles();

    style.setType(STStyleType.PARAGRAPH);
    styles.addStyle(style);

}

/*
 * Changes the text of a given paragraph.
 */
public static void changeText(XWPFParagraph p, String newText) {
    if (p != null) {
        List<XWPFRun> runs = p.getRuns();
        for (int i = runs.size() - 1; i >= 0; i--) {
            p.removeRun(i);
        }

        if (runs.size() == 0) {
            p.createRun();
        }

        XWPFRun run = runs.get(0);
        run.setText(newText, 0);
    }
}

Answer 1

您所看到的XWPF课程正在进行中，没有真正的总体架构。随着时间的推移，这将随着时间的推移而发生变化，但与此同时，您可以尝试以这种方式向段落添加简单的TOC字段。

XWPFParagraph p;
...
// get or create your paragraph
....
CTP ctP = p.getCTP();
CTSimpleField toc = ctP.addNewFldSimple();
toc.setInstr("TOC \\h");
toc.setDirty(STOnOff.TRUE);

这将创建一个目录，其中包含指向页面的超链接，当Word打开它时应重新计算，目录将基于预定义的HeaderX样式。

Answer 2

我已经解开了这个谜团，不幸的是（对于有同样问题的人），没有好消息。 ~~Apache POI的createTOC()被窃听（说实话，这似乎是一种方法，其实现已经开始但从未以适当的方式完成）~~（请考虑jmarkmurphy接受的答案）。

Documentation没有解释有关方法本身的任何内容（它仅报告签名，仅此而已），这是可疑的。

观看XWPFDocument的课程代码：

public void createTOC() {
    CTSdtBlock block = getDocument().getBody().addNewSdt();
    TOC toc = new TOC(block);
    for (XWPFParagraph par : this.paragraphs) {
        String parStyle = par.getStyle();
        if ((parStyle != null) && (parStyle.startsWith("Heading"))) try {
            int level = Integer.valueOf(parStyle.substring("Heading".length())).intValue();
            toc.addRow(level, par.getText(), 1, "112723803");
        } catch (NumberFormatException e) {
            e.printStackTrace();
        }
    }
}

Apache POI搜索名为“HeadingX”的样式的段落，其中X为数字。因此，我的变量strStyleId应该被归类为Heading1，作为示例。但这并没有解决问题。事实上，createTOC()始终将1作为页码传递给addRow()方法，这种方法始终将页面设置为1。它绝对没有任何东西可以实现这一目标。

这是最终的，无用的结果（正如你所看到的，它也是一个“假的”TOC，而不是你可以使用问题中的红色方形按钮通过Microsoft Word创建的那个）：

因此，无法通过dinamically检索Word文档的页码（正如我在其他帖子中读到的那样），甚至Apache POI似乎无法做到这一点，遗憾的是。

Answer 3

toc.setInstr("TOC \\h");

h开关必须与＆＃39; \＆＃39;一起使用，而不是＆＃39; /＆＃39;，因为它只适用于＆＃39; \＆＃39;。有关使用TOC开关的更多详细信息：Use Word's TOC field to fine-tune your table of contents

Answer 4

最近我遇到了同样的问题，但是我想添加一个深度为2的目录（不包括标题3）。我已经创建了一个副本，并在Word文档中手动添加了ToC，并将两者都从.docx重命名为.zip。

在每个zip文档中，都有一个XML文件位于document.zip/word/document.xml中。该文档是文档内容。

我比较了两个XML文件，发现添加ToC时Word添加了以下值：

<w:fldSimple w:instr="TOC \o "1-2" \h \z \u"/>

我使用以下代码更新了代码：

CTP ctP = paragraph.getCTP();
CTSimpleField toc = ctP.addNewFldSimple();
toc.setInstr("TOC \\o \"1-2\" \\h \\z \\u");
toc.setDirty(STOnOff.ON);

当您打开文档时，Word将要求您更新引用，并且ToC变得完美。因为我希望生成过程完全自动化，所以我仍在研究该部分。

Answer 5

如果有人仍在寻找答案，我会遵循@jmarkmurphy提供的建议。

下面是工作代码

import java.io.FileOutputStream;
import java.math.BigInteger;

import org.apache.poi.xwpf.usermodel.BreakType;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.apache.poi.xwpf.usermodel.XWPFStyle;
import org.apache.poi.xwpf.usermodel.XWPFStyles;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDecimalNumber;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSettings;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTString;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyle;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STStyleType;

public class ApachePOIWordTOCDemo {

    public static void main(String[] args) throws Exception {

    XWPFDocument doc = new XWPFDocument();

    doc.createTOC();
    addCustomHeadingStyle(doc, "heading 1", 1);
    addCustomHeadingStyle(doc, "heading 2", 2);
    addCustomHeadingStyle(doc, "heading 3", 3);

    // the body content
    XWPFParagraph paragraph = doc.createParagraph();

    CTP ctP = paragraph.getCTP();
    CTSimpleField toc = ctP.addNewFldSimple();
    toc.setInstr("TOC \\h");
    toc.setDirty(STOnOff.TRUE);
    

    XWPFRun run = paragraph.createRun();

    paragraph = doc.createParagraph();
    run = paragraph.createRun();
    run.setText("Heading 1");
    paragraph.setStyle("heading 1");

    paragraph = doc.createParagraph();
    run = paragraph.createRun();
    run.addBreak(BreakType.PAGE);
    run.setText("Heading 2");
    paragraph.setStyle("heading 2");
    
    paragraph = doc.createParagraph();
    run = paragraph.createRun();
    run.addBreak(BreakType.PAGE);
    run.setText("Heading 3");
    paragraph.setStyle("heading 3");
    
    FileOutputStream fos = new FileOutputStream("createTOC.docx");
    doc.write(fos);
    }

    private static void addCustomHeadingStyle(XWPFDocument docxDocument, String strStyleId, int headingLevel) {

    CTStyle ctStyle = CTStyle.Factory.newInstance();
    ctStyle.setStyleId(strStyleId);

    CTString styleName = CTString.Factory.newInstance();
    styleName.setVal(strStyleId);
    ctStyle.setName(styleName);

    CTDecimalNumber indentNumber = CTDecimalNumber.Factory.newInstance();
    indentNumber.setVal(BigInteger.valueOf(headingLevel));

    // lower number > style is more prominent in the formats bar
    ctStyle.setUiPriority(indentNumber);

    CTOnOff onoffnull = CTOnOff.Factory.newInstance();
    ctStyle.setUnhideWhenUsed(onoffnull);

    // style shows up in the formats bar
    ctStyle.setQFormat(onoffnull);

    // style defines a heading of the given level
    CTPPr ppr = CTPPr.Factory.newInstance();
    ppr.setOutlineLvl(indentNumber);
    ctStyle.setPPr(ppr);

    XWPFStyle style = new XWPFStyle(ctStyle);

    // is a null op if already defined
    XWPFStyles styles = docxDocument.createStyles();

    style.setType(STStyleType.PARAGRAPH);
    styles.addStyle(style);

    }
}

使用页码和＃39;创建XWPFDocument的目录。迹象

5 个答案: