java 为带有页码指示的XWPFDocument创建目录

jdzmm42g  于 2023-02-18  发布在  Java
关注(0)|答案(5)|浏览(418)

我实际上是用Apache POI生成一个Word文档,我需要自动创建一个引用段落的目录(Table of Contents,TOC),并带有它们的页面指示。
这是我正在使用的代码(我省略了前置条件和内部方法的主体):

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();

当我打开生成的文档时,我得到了以下结果(见蓝色方块):

在左边,我可以看到生成的目录。到目前为止,一切都很好。然而,在文档的正文中,我只能看到一个静态文本"目录",没有任何指示(既没有段落也没有页面)。我甚至不能与它交互。
如果我单击菜单项"Table of Contents"(左上角的红色方块),就会生成我想要的"真正的" Table of Contents(当然是沿着箭头方向...)。

    • 我的问题是:**如何从代码中获得第二个结果(红色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);
    }
}
nx7onnlm

nx7onnlm1#

正如您所看到的,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样式。

vpfxa7rd

vpfxa7rd2#

我已经解开了这个谜团,不幸的是(对于有同样问题的人来说),没有好消息。Apache POI的createTOC()有bug(老实说,它似乎是一个方法,其实现已经开始,但从未以正确的方式完成)(请考虑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();
        }
    }
}

ApachePOI搜索样式名为“HeadingX”的段落,其中X是一个数字。因此,作为示例,我的变量strStyleId应该被赋值为Heading1。但这并没有解决问题。事实上,createTOC()总是将1作为页码传递给addRow()方法,该方法总是将页码设置为1。这样。它完全不做任何事情来达到动态的。
这是最终的无用结果(如您所见,它也是一个“假”TOC,而不是您可以通过Microsoft Word使用问题中的红色方形按钮创建的TOC):

因此,Word文档的页码不能动态检索(正如我在其他帖子中读到的),不幸的是,即使是Apache POI似乎也不能做到这一点。

piztneat

piztneat3#

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

h开关必须与“\”而不是“/”一起使用,因为它只能与“\”一起使用。有关使用TOC开关的详细信息:Use Word's TOC field to fine-tune your table of contents

1l5u6lss

1l5u6lss4#

最近我遇到了同样的问题,但我想添加一个深度为2的目录(不包括标题3)。我创建了一个副本,并在Word文档中手动添加了目录,并将两者从.docx重命名为. zip。
在每个zip文档中,都有一个位于www.example.com的XML文件document.zip/word/document.xml。此文档是文档内容。
我比较了这两个XML文件,发现Word在您添加ToC时添加了以下值:

<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会要求你更新引用,目录就变得完美了。因为我想让生成过程完全自动化,所以我还在做这部分。

jum4pzuy

jum4pzuy5#

如果有人还在寻找答案,我就按照@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(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
    CTPPrGeneral ppr = CTPPrGeneral.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);

    }
}

相关问题