Enhancement to XWPFFootnote and related APIs #114
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
My first pass at enhancing the XWPFFootnote API.
Adds new methods createParagraph() and createTable()/createTable(rows, cols) to XWPFFootnote.
Adds new methods createFootnote() and removeFootnote() to XWPFDocument and XWPFFootnotes
Adds new method addFootnoteReference(XWPFFootnote) to XWPFParagraph
Creation of new footnote does not add any body elements. However, adding the first paragraph or table automatically creates the required footnote ref run in the first paragraph (adding the paragraph if necessary).
I also made a pass over the javadocs for XWPFFootnote.
I tested with the included unit tests and also in the context of my real-world project that is driving this update. That verifies, for example, that a multi-paragraph footnote with a table works as it should.