public class DocxWordWriter extends AbstractWordWriter<java.lang.Object>
WordHelper.PostProcessor
Modifier and Type | Field and Description |
---|---|
static java.util.List<java.lang.String> |
FILE_EXTENSIONS |
TOOL_CUSTOM_DOC_PROP, UML_CUSTOM_DOC_PROP
PAGE_WIDTH, POINTS_FOR_1CM
Constructor and Description |
---|
DocxWordWriter(WordWriterInput input)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
appendHtmlTextInNewParagraphWithStyle(Range<java.lang.Object> range,
java.lang.String newMarkup,
Style style) |
void |
appendNewLine(Range<java.lang.Object> range) |
java.lang.String |
appendRawTextInNewParagraphWithStyle(Range<java.lang.Object> range,
java.lang.String newText,
Style style) |
java.lang.String |
appendText(Range<java.lang.Object> range,
java.lang.String newText) |
java.lang.String |
appendTextInNewParagraph(Range<java.lang.Object> range,
java.lang.String newText) |
java.lang.String |
appendTextWithStyle(Range<java.lang.Object> range,
java.lang.String newText,
Style style) |
boolean |
applyCloseReopen()
Returns whether to apply close/reopen hack (may be needed for performance reasons).
|
void |
closeDoc()
Closes and saves the MS Word document.
|
void |
collapseRangeToEnd(Range<java.lang.Object> range) |
void |
collapseRangeToStart(Range<java.lang.Object> range) |
java.util.Map<CaptionKind,java.util.List<Caption<java.lang.Object>>> |
collectCaptionParagraphsAndFixLabelsAlsoInTOCs()
Expected to be called after styles and caption labels get properly initialised from the
current open document.
|
WordPatternFinder<java.lang.Object> |
createPatternFinder(java.lang.String pattern) |
Range<java.lang.Object> |
createRange(java.lang.Object object) |
Range<java.lang.Object> |
duplicateRange(Range<java.lang.Object> range)
FIXME: could go to Range?
|
java.util.Map<java.lang.String,java.lang.String> |
getCustomDocProperties() |
Range<java.lang.Object> |
getDocumentAsRange() |
java.util.Map<java.lang.String,ExistingStyle> |
getExistingStyles()
Returns non-empty map of non-null styles read from an open document, with style name as key.
|
int |
getRangeParagraphCount(Range<java.lang.Object> range) |
int |
getRangeParagraphOutlineLevel(Range<java.lang.Object> range,
int paraIdx) |
java.lang.String |
getRangeParagraphStyleName(Range<java.lang.Object> range,
int paraIdx) |
java.util.Set<java.lang.String> |
getSupportedFormats()
Returns the set of supported formats, as file extensions; e.g., ".doc", ".xml".
|
void |
insertBookmark(Range<java.lang.Object> range,
java.lang.String label) |
void |
insertCaptionRef(Range<java.lang.Object> insertPointRange,
CaptionKind kind,
int figNumber,
boolean introBeforeCaption)
Inserts reference to the caption
tabNumber at the start of
insertPointRange . |
void |
insertFigure(Range<java.lang.Object> range,
java.io.File pic)
Input
range includes any potential text within a paragraph. |
java.lang.Object |
insertFigureCaption(Range<java.lang.Object> range,
int expectedSeqNum,
java.lang.String captionText) |
void |
insertHyperlink(Range<java.lang.Object> range,
java.lang.String textToDisplay,
java.lang.String url) |
int |
insertTable(Range<java.lang.Object> range,
PropertiesDoc doc,
Style tabhead,
boolean addBookmarks) |
void |
insertTableCaption(Range<java.lang.Object> range,
int expectedSeqNum,
java.lang.String captionText) |
boolean |
isRangeWithTable(java.lang.Object range) |
void |
moveStartChar(Range<java.lang.Object> range,
int count) |
void |
openDoc()
Creates (and caches) the MS Word document.
|
void |
prependNewLine(Range<java.lang.Object> range) |
void |
prependText(Range<java.lang.Object> range,
java.lang.String newText)
Prepends text; prepended paragraph will have the same style as the one in range.
|
void |
setCustomDocProperties(java.util.Map<java.lang.String,java.lang.String> newCustomProps) |
void |
updateFields() |
void |
updateTablesOf(java.lang.String what) |
appendTextInNewParagraphWithStyle, clearUndoCache, closeAndReopenDoc, createCaption, createCursor, createWordApp, exitAppAndSaveDocument, getCursors, getInput, getInputFileNames, getOutputFileNames, getWordAppName, getWordAppVersion, initDocgenOptimisationOptions, isInTOC, pointForPerc, scanHyperlinkPlaceholderRanges, scanPlaceholderRanges, setDocgenOptimisationOptions, toString, unsetDocgenOptimisationOptions, write, writeAbbrTable, writeByTest, writeClassFromPackage, writeDataIndex, writeDiagram, writeExplicitClass, writeFcTable, writeLnMapPackage, writePackage, writePresCondTable, writeProperties, writeSclEnum, writeTrgOpTable
getDocumentMetadata
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDocumentMetadata
public DocxWordWriter(WordWriterInput input) throws UnsupportedInputFormatException, UnsupportedOutputFormatException, java.io.IOException
input
- UnsupportedInputFormatException
UnsupportedOutputFormatException
java.io.IOException
public void openDoc() throws java.io.IOException
WordHelper
java.io.IOException
public void closeDoc() throws java.io.IOException
WordHelper
java.io.IOException
public void insertBookmark(Range<java.lang.Object> range, java.lang.String label)
public void insertHyperlink(Range<java.lang.Object> range, java.lang.String textToDisplay, java.lang.String url)
public java.util.Map<java.lang.String,ExistingStyle> getExistingStyles()
WordHelper
public void updateFields()
public void updateTablesOf(java.lang.String what)
public java.util.Map<java.lang.String,java.lang.String> getCustomDocProperties()
public void setCustomDocProperties(java.util.Map<java.lang.String,java.lang.String> newCustomProps)
public java.util.Map<CaptionKind,java.util.List<Caption<java.lang.Object>>> collectCaptionParagraphsAndFixLabelsAlsoInTOCs()
WordHelper
public Range<java.lang.Object> createRange(java.lang.Object object)
public WordPatternFinder<java.lang.Object> createPatternFinder(java.lang.String pattern)
public Range<java.lang.Object> getDocumentAsRange()
public Range<java.lang.Object> duplicateRange(Range<java.lang.Object> range)
WordHelper
public void prependText(Range<java.lang.Object> range, java.lang.String newText)
WordHelper
public int getRangeParagraphOutlineLevel(Range<java.lang.Object> range, int paraIdx)
public java.lang.String appendRawTextInNewParagraphWithStyle(Range<java.lang.Object> range, java.lang.String newText, Style style)
public java.lang.String appendHtmlTextInNewParagraphWithStyle(Range<java.lang.Object> range, java.lang.String newMarkup, Style style)
public java.lang.String appendTextWithStyle(Range<java.lang.Object> range, java.lang.String newText, Style style)
public java.lang.Object insertFigureCaption(Range<java.lang.Object> range, int expectedSeqNum, java.lang.String captionText)
public void insertTableCaption(Range<java.lang.Object> range, int expectedSeqNum, java.lang.String captionText)
public void insertCaptionRef(Range<java.lang.Object> insertPointRange, CaptionKind kind, int figNumber, boolean introBeforeCaption)
WordHelper
tabNumber
at the start of
insertPointRange
.introBeforeCaption
- TODOpublic void insertFigure(Range<java.lang.Object> range, java.io.File pic)
WordHelper
range
includes any potential text within a paragraph. The method will
overwrite that text with the figure from pic
, and resulting range spans to the
start of the paragraph following the inserted pic
.public int insertTable(Range<java.lang.Object> range, PropertiesDoc doc, Style tabhead, boolean addBookmarks)
public java.lang.String getRangeParagraphStyleName(Range<java.lang.Object> range, int paraIdx)
public int getRangeParagraphCount(Range<java.lang.Object> range)
public void prependNewLine(Range<java.lang.Object> range)
public void appendNewLine(Range<java.lang.Object> range)
public java.lang.String appendText(Range<java.lang.Object> range, java.lang.String newText)
public java.lang.String appendTextInNewParagraph(Range<java.lang.Object> range, java.lang.String newText)
public boolean isRangeWithTable(java.lang.Object range)
public void collapseRangeToEnd(Range<java.lang.Object> range)
public void collapseRangeToStart(Range<java.lang.Object> range)
public void moveStartChar(Range<java.lang.Object> range, int count)
public boolean applyCloseReopen()
WordWriter
public java.util.Set<java.lang.String> getSupportedFormats()
Writer
Copyright 2009-2016 Tatjana (Tanja) Kostic