public class DocxWordWriter extends AbstractWordWriter<java.lang.Object>
WordHelper.PostProcessor
Modifier and Type | Field and Description |
---|---|
private static org.apache.log4j.Logger |
_logger |
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) |
private void |
collapseRangeToStart(Range<java.lang.Object> range) |
java.util.Map<Caption.CaptionKind,java.util.List<Caption<java.lang.Object>>> |
collectCaptions() |
WordPatternFinder<java.lang.Object> |
createPatternFinder() |
Range<java.lang.Object> |
createRange(java.lang.Object object) |
private int |
doInsertTable(Range<java.lang.Object> range,
PropertiesDoc doc,
Style tabhead) |
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,java.lang.String> |
getExistingStyleNames()
Returns names of existing styles.
|
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".
|
java.lang.String |
getWordAppName()
Returns the MS Word application name.
|
java.lang.String |
getWordAppVersion()
Returns the MS Word application version.
|
private static void |
insertCaption(Range<java.lang.Object> range,
Caption.CaptionKind label,
boolean positionAbove,
java.lang.String text,
java.lang.String logMsg) |
private void |
insertCaptionRef(Range<java.lang.Object> range,
Caption.CaptionKind kind,
int idx) |
void |
insertFigure(Range<java.lang.Object> range,
java.io.File pic) |
void |
insertFigureCaption(Range<java.lang.Object> range,
java.lang.String text,
java.lang.String logMsg) |
void |
insertFigureRef(Range<java.lang.Object> insertPointRange,
int figNumber) |
int |
insertTable(Range<java.lang.Object> range,
PropertiesDoc doc,
Style tabhead) |
void |
insertTableCaption(Range<java.lang.Object> range,
java.lang.String text,
java.lang.String logMsg) |
void |
insertTableRef(Range<java.lang.Object> insertPointRange,
int tabNumber) |
boolean |
isRangeWithTable(java.lang.Object range) |
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, initCursorsFromPlaceholders, initDocgenOptimisationOptions, isInTOC, pointForPerc, scanAndPostprocess, setDocgenOptimisationOptions, toString, unsetDocgenOptimisationOptions, write, writeAbbrTable, writeClass, writeDataIndex, writeDiagram, writeFcTable, writeLnMapPackage, writePackage, writePresCondTable, writeProperties, writeSclEnum, writeTrgOpTable
getDocumentMetadata
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDocumentMetadata
private static final org.apache.log4j.Logger _logger
public static final java.util.List<java.lang.String> FILE_EXTENSIONS
public DocxWordWriter(WordWriterInput input) throws UnsupportedInputFormatException, UnsupportedOutputFormatException, java.io.IOException
input
- UnsupportedInputFormatException
- if configured with template in unsupported formatUnsupportedOutputFormatException
- if configured with output in unsupported formatjava.io.IOException
private int doInsertTable(Range<java.lang.Object> range, PropertiesDoc doc, Style tabhead)
public java.lang.String getWordAppName()
WordHelper
public java.lang.String getWordAppVersion()
WordHelper
public void openDoc() throws java.io.IOException
WordHelper
java.io.IOException
public void closeDoc() throws java.io.IOException
WordHelper
java.io.IOException
public java.util.Map<java.lang.String,java.lang.String> getExistingStyleNames()
WordHelper
public void updateFields()
This is no-op: you need to open the document in MS Word.
public void updateTablesOf(java.lang.String what)
This is no-op: you need to open the document in MS Word.
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<Caption.CaptionKind,java.util.List<Caption<java.lang.Object>>> collectCaptions()
public Range<java.lang.Object> createRange(java.lang.Object object)
public WordPatternFinder<java.lang.Object> createPatternFinder()
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 void insertFigureCaption(Range<java.lang.Object> range, java.lang.String text, java.lang.String logMsg)
public void insertTableCaption(Range<java.lang.Object> range, java.lang.String text, java.lang.String logMsg)
private static void insertCaption(Range<java.lang.Object> range, Caption.CaptionKind label, boolean positionAbove, java.lang.String text, java.lang.String logMsg)
public void insertFigureRef(Range<java.lang.Object> insertPointRange, int figNumber)
public void insertTableRef(Range<java.lang.Object> insertPointRange, int tabNumber)
private void insertCaptionRef(Range<java.lang.Object> range, Caption.CaptionKind kind, int idx)
public void insertFigure(Range<java.lang.Object> range, java.io.File pic)
public int insertTable(Range<java.lang.Object> range, PropertiesDoc doc, Style tabhead)
Returns expanded range to the end of the table. We do not collapse original range here, as we assume the caption will need to be inserted before the table.
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 appendTextInNewParagraph(Range<java.lang.Object> range, java.lang.String newText)
public java.lang.String appendText(Range<java.lang.Object> range, java.lang.String newText)
public boolean isRangeWithTable(java.lang.Object range)
public void collapseRangeToEnd(Range<java.lang.Object> range)
private void collapseRangeToStart(Range<java.lang.Object> range)
public boolean applyCloseReopen()
WordWriter
public java.util.Set<java.lang.String> getSupportedFormats()
Writer
Copyright 2009-2015 Tatjana (Tanja) Kostic