public interface FigureDoc extends ObjectDoc
Here the layout you may use for a diagram within the package or class:
getFigureFile() [Figure # - ] + getCaptionText() [Figure #: ] + getDescription()or the legacy one, with the figure introduction before the figure (when "docgen.word.introToFigureBefore"=true):
[Figure # ] + getIntroText() getFigureFile() [Figure # - ] + getCaptionText() getDescription()A writer needs to supply what is enclosed in [] and for the rest you call methods of this interface.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CAPTION_TEXT_FORMAT |
static java.lang.String |
INTRO_TEXT_FORMAT |
DEFAULT_PREFIX_FMT
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaptionText()
Returns text that describes the caption.
|
java.io.File |
getFigureFile()
Returns file with the figure.
|
java.lang.String |
getIntroText()
Returns text that will introduce the table.
|
getBmRegistry, getBookmarkID, getDescription, getDocgenCfg, getHeadingText
copyCell, copyNonEmptyCell, getCell, getCells, hasKey, putCell, putCellNonEmpty
static final java.lang.String INTRO_TEXT_FORMAT
static final java.lang.String CAPTION_TEXT_FORMAT
java.lang.String getIntroText()
java.io.File getFigureFile()
java.lang.String getCaptionText()
Copyright 2009-2016 Tatjana (Tanja) Kostic