FlattenerContext (XFA Flattener API reference)

java.lang.Object
- com.itextpdf.tool.xml.xtra.xfa.resolver.FlattenerContext

All Implemented Interfaces:: com.itextpdf.tool.xml.CustomContext

public class FlattenerContext
extends Object
implements com.itextpdf.tool.xml.CustomContext

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`currentPageNumber`
`protected Integer`	`currentSheetNumber`
`protected Integer`	`pageCount`
`protected Integer`	`sheetCount`

Constructor Summary

Constructors
Constructor and Description
`FlattenerContext(com.itextpdf.text.FontProvider fontProvider, com.itextpdf.text.Document document, com.itextpdf.text.pdf.PdfArray xfaImagesArr)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addScriptVariableToBeEvaluated(JsScript script)`
`void`	`addUnresolvedTextDrawer(TextDrawer textDrawer)`
`void`	`drawUnresolvedTextDrawers()`
`void`	`evaluateScriptVariables()`
`AppConfig`	`getAppConfig()`
`ConfigResolver`	`getConfigResolver()`
`Positioner`	`getCurrentNode()`
`Integer`	`getCurrentPageNumber()`
`Integer`	`getCurrentSheetNumber()`
`com.itextpdf.text.Document`	`getDocument()`
`SubFormPositioner`	`getDomPositioner()`
`List<String>`	`getExtraEventList()`
`com.itextpdf.text.Font`	`getFont(FormNode node, String encoding)`
`FormNode`	`getFontNode(FormNode node)`
`com.itextpdf.text.FontProvider`	`getFontProvider()`
`FormatResolver`	`getFormatResolver()`
`FormBuilder`	`getFormBuilder()`
`HostConfig`	`getHostConfig()`
`com.itextpdf.text.pdf.PdfObject`	`getImage(String imgRef)`
`Integer`	`getLastNumberedPage()`
`LocaleResolver`	`getLocaleResolver()`
`Integer`	`getPageCount()`
`PageSet`	`getPageSet()`
`com.itextpdf.text.pdf.PdfReader`	`getReader()`
`Integer`	`getSheetCount()`
`Map<String,com.itextpdf.text.pdf.PdfDictionary>`	`getSignatureFields()`
`XFAFlattener.ViewMode`	`getViewMode()`
`com.itextpdf.text.pdf.PdfWriter`	`getVoidPdfWriter()` Gets a `PdfWriter` dummy instance that can be used to write content into it but the content eventually gets discarded
`float`	`getXfaVersion()`
`boolean`	`isCacheOriginalContentArea()`
`boolean`	`isLegacyPlusPrint()`
`boolean`	`isValidateLayout()`
`void`	`moveToNextPage(boolean numbered)`
`void`	`popJsEventCallStack()`
`void`	`pushJsEventCallStack(JsContainer eventOwner, String activity, String script)`
`void`	`resetPageNumbers()`
`Positioner`	`resolvePositioner(String somExpressions)`
`void`	`setAppConfig(AppConfig appConfig)`
`void`	`setCacheOriginalContentArea(boolean cacheOriginalContentArea)`
`void`	`setConfigResolver(ConfigResolver configResolver)`
`void`	`setCurrentNode(Positioner currentNode)`
`void`	`setCurrentPageNumber(Integer currentPageNumber)`
`void`	`setCurrentSheetNumber(Integer currentSheetNumber)`
`void`	`setDocument(com.itextpdf.text.Document document)`
`void`	`setDomPositioner(SubFormPositioner domPositioner)`
`void`	`setExtraEventList(List<String> extraEventList)`
`void`	`setFormBuilder(FormBuilder formBuilder)`
`void`	`setHostConfig(HostConfig hostConfig)`
`void`	`setLegacyPlusPrint(boolean legacyPlusPrint)`
`void`	`setLocaleResolver(LocaleResolver localeResolver)`
`void`	`setPageCount(Integer pageCount)`
`void`	`setPageSet(PageSet pageSet)`
`void`	`setReader(com.itextpdf.text.pdf.PdfReader reader)`
`void`	`setSheetCount(Integer sheetCount)`
`void`	`setValidateLayout(boolean validateLayout)`
`void`	`setViewMode(XFAFlattener.ViewMode viewMode)`
`void`	`setXfaVersion(float xfaVersion)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentSheetNumber
```
protected Integer currentSheetNumber
```

currentPageNumber
```
protected Integer currentPageNumber
```

pageCount
```
protected Integer pageCount
```

sheetCount
```
protected Integer sheetCount
```

Constructor Detail

FlattenerContext

public FlattenerContext(com.itextpdf.text.FontProvider fontProvider,
                        com.itextpdf.text.Document document,
                        com.itextpdf.text.pdf.PdfArray xfaImagesArr)

Method Detail

getFormatResolver

public FormatResolver getFormatResolver()

getLastNumberedPage
```
public Integer getLastNumberedPage()
```

resetPageNumbers
```
public void resetPageNumbers()
```

getCurrentPageNumber
```
public Integer getCurrentPageNumber()
```

setCurrentPageNumber

public void setCurrentPageNumber(Integer currentPageNumber)

getCurrentSheetNumber

public Integer getCurrentSheetNumber()

setCurrentSheetNumber

public void setCurrentSheetNumber(Integer currentSheetNumber)

moveToNextPage

public void moveToNextPage(boolean numbered)

getPageCount
```
public Integer getPageCount()
```

setPageCount

public void setPageCount(Integer pageCount)

getSheetCount
```
public Integer getSheetCount()
```

setSheetCount

public void setSheetCount(Integer sheetCount)

getDomPositioner

public SubFormPositioner getDomPositioner()

setDomPositioner

public void setDomPositioner(SubFormPositioner domPositioner)

getLocaleResolver

public LocaleResolver getLocaleResolver()

setLocaleResolver

public void setLocaleResolver(LocaleResolver localeResolver)

getConfigResolver

public ConfigResolver getConfigResolver()

setConfigResolver

public void setConfigResolver(ConfigResolver configResolver)

getViewMode

public XFAFlattener.ViewMode getViewMode()

setViewMode

public void setViewMode(XFAFlattener.ViewMode viewMode)

getAppConfig
```
public AppConfig getAppConfig()
```

setAppConfig

public void setAppConfig(AppConfig appConfig)

getHostConfig
```
public HostConfig getHostConfig()
```

setHostConfig

public void setHostConfig(HostConfig hostConfig)

getDocument

public com.itextpdf.text.Document getDocument()

setDocument

public void setDocument(com.itextpdf.text.Document document)

getCurrentNode
```
public Positioner getCurrentNode()
```

setCurrentNode

public void setCurrentNode(Positioner currentNode)

getFormBuilder
```
public FormBuilder getFormBuilder()
```

setFormBuilder

public void setFormBuilder(FormBuilder formBuilder)

getExtraEventList

public List<String> getExtraEventList()

setExtraEventList

public void setExtraEventList(List<String> extraEventList)

getReader

public com.itextpdf.text.pdf.PdfReader getReader()

setReader

public void setReader(com.itextpdf.text.pdf.PdfReader reader)

isCacheOriginalContentArea

public boolean isCacheOriginalContentArea()

setCacheOriginalContentArea

public void setCacheOriginalContentArea(boolean cacheOriginalContentArea)

getPageSet
```
public PageSet getPageSet()
```

setPageSet

public void setPageSet(PageSet pageSet)

isValidateLayout
```
public boolean isValidateLayout()
```

setValidateLayout

public void setValidateLayout(boolean validateLayout)

getFontProvider

public com.itextpdf.text.FontProvider getFontProvider()

getVoidPdfWriter
```
public com.itextpdf.text.pdf.PdfWriter getVoidPdfWriter()
```
Gets a PdfWriter dummy instance that can be used to write content into it but the content eventually gets discarded

resolvePositioner

public Positioner resolvePositioner(String somExpressions)

getFont

public com.itextpdf.text.Font getFont(FormNode node,
                                      String encoding)

getFontNode

public FormNode getFontNode(FormNode node)

addUnresolvedTextDrawer

public void addUnresolvedTextDrawer(TextDrawer textDrawer)

drawUnresolvedTextDrawers

public void drawUnresolvedTextDrawers()
                               throws com.itextpdf.text.DocumentException,
                                      IOException

Throws:: com.itextpdf.text.DocumentException; IOException

getImage

public com.itextpdf.text.pdf.PdfObject getImage(String imgRef)

isLegacyPlusPrint
```
public boolean isLegacyPlusPrint()
```

setLegacyPlusPrint

public void setLegacyPlusPrint(boolean legacyPlusPrint)

getXfaVersion
```
public float getXfaVersion()
```

setXfaVersion

public void setXfaVersion(float xfaVersion)

getSignatureFields

public Map<String,com.itextpdf.text.pdf.PdfDictionary> getSignatureFields()

addScriptVariableToBeEvaluated

public void addScriptVariableToBeEvaluated(JsScript script)

evaluateScriptVariables
```
public void evaluateScriptVariables()
```

pushJsEventCallStack

public void pushJsEventCallStack(JsContainer eventOwner,
                                 String activity,
                                 String script)

popJsEventCallStack
```
public void popJsEventCallStack()
```

Class FlattenerContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currentSheetNumber

currentPageNumber

pageCount

sheetCount

Constructor Detail

FlattenerContext

Method Detail

getFormatResolver

getLastNumberedPage

resetPageNumbers

getCurrentPageNumber

setCurrentPageNumber

getCurrentSheetNumber

setCurrentSheetNumber

moveToNextPage

getPageCount

setPageCount

getSheetCount

setSheetCount

getDomPositioner

setDomPositioner

getLocaleResolver

setLocaleResolver

getConfigResolver

setConfigResolver

getViewMode

setViewMode

getAppConfig

setAppConfig

getHostConfig

setHostConfig

getDocument

setDocument

getCurrentNode

setCurrentNode

getFormBuilder

setFormBuilder

getExtraEventList

setExtraEventList

getReader

setReader

isCacheOriginalContentArea

setCacheOriginalContentArea

getPageSet

setPageSet

isValidateLayout

setValidateLayout

getFontProvider

getVoidPdfWriter

resolvePositioner

getFont

getFontNode

addUnresolvedTextDrawer

drawUnresolvedTextDrawers

getImage

isLegacyPlusPrint

setLegacyPlusPrint

getXfaVersion

setXfaVersion

getSignatureFields

addScriptVariableToBeEvaluated

evaluateScriptVariables

pushJsEventCallStack

popJsEventCallStack