|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A template anaylsis provides details about a (populable) template that may help in processing the template (performance hints). It also may provide hints that can be used when constructing a DataProvider as to what forms of data might be required. This allows data providers to pre-fetch data based on specifics of the template it is populating.
Method Summary | |
TemplateField[] |
getFields()
Return only the fields in the template in the order they appear in the template. |
long |
getLength()
Obtain the total size of the analysis stream. |
ListTree |
getListTree()
Get the ListTree describing relationships between numbered lists in the template |
String |
getOriginalMD5()
The the MD5 hash string that the template had at the time of storing. |
boolean |
getProcessedAllowingPaddedFields()
Determine if this template was processed allowing fields to be padded (eg << abc >>) |
boolean |
getProcessedWithExternalConverter()
Determine if this template was processed with the external converter |
TemplateSection[] |
getSections()
Get the breakdown of a template as a set of sections. |
char[] |
getStaticNewStyles()
Get any new styles derived during analysis |
TemplateAnalysis |
getStyleAnalysis()
Get the analysis of the styles of the template. |
MessageAndSuggestions[] |
getTemplateErrorMessages()
Get the error messages from the template (if any). |
ImageAnalysis |
getTemplateImages()
Get information about the images in the template. |
TextWritableSafeAreas |
getWritableSafeAreas()
Get the writable safe areas for validation |
boolean |
hasDynamicTableStyling()
Determine if this template has tables with dynamic styling. |
boolean |
hasTableWithMergedNonBreakingRows()
Determine if tables are present with merged rows and the "don't-break row" property set. |
boolean |
hasTemplateErrors()
Determine if the template has errors in it. |
boolean |
hasTOC()
Determine if the template has a Table of Contents (TOC) |
Method Detail |
public TemplateSection[] getSections()
public TemplateField[] getFields()
public long getLength()
public String getOriginalMD5()
public boolean hasDynamicTableStyling()
public boolean hasTemplateErrors()
public MessageAndSuggestions[] getTemplateErrorMessages()
public char[] getStaticNewStyles()
public ImageAnalysis getTemplateImages()
public boolean hasTOC()
public TemplateAnalysis getStyleAnalysis()
public boolean hasTableWithMergedNonBreakingRows()
public boolean getProcessedWithExternalConverter()
public boolean getProcessedAllowingPaddedFields()
public TextWritableSafeAreas getWritableSafeAreas()
public ListTree getListTree()
|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |