Document (com.pd4ml 4.0.15 API Documentation)

java.lang.Object
- com.pd4ml.html.doc.Document

```
public class Document
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

boolean backgroundAsPatterns

int debugCounter

HashSet pageBreaks

Fields
Modifier and Type	Field and Description
`boolean`	`backgroundAsPatterns`
`int`	`debugCounter`
`HashSet`	`pageBreaks`

Constructor Summary

Constructors
Constructor and Description

Document(com.pd4ml.fonts.FontCache fontCache)

Constructors
Constructor and Description
`Document(com.pd4ml.fonts.FontCache fontCache)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMeta(String key, String value)`
`boolean`	`arePageBreaksBelow(int offset)`
`int`	`countBlocks()`
`boolean`	`disableArabicConversion()`
`double`	`getActualScaleToProtectPhysicalDimensions()`
`URL`	`getBase()`
`String`	`getBaseFontFace()`
`int`	`getBaseFontSize()`
`BlockElement`	`getBody()`
`Context`	`getContext()`
`com.pd4ml.cache.FileCache`	`getDataCache()`
`String`	`getEncoding()`
`com.pd4ml.fonts.FontCache`	`getFontCache()`
`String`	`getFormFont()`
`String`	`getFormFontCharRange()`
`int`	`getInitialUserSpaceWidth()`
`com.pd4ml.util.GOST.Auth`	`getLicense()`
`String`	`getMeta(String key)`
`com.pd4ml.util.ProgressMeter`	`getProgressMeter()`
`float`	`getRemBase()`
`BlockElement`	`getRoot()`
`String`	`getRuntimeProperty(String key)`
`Style`	`getStyleInstance(Style s)`
`String`	`getTitle()`
`String`	`getTocNumPlaceholder()`
`int`	`getTocPageNumberCorrection()`
`TableElement`	`getTocTable()`
`int`	`getUserSpaceHeight()`
`boolean`	`hasBookmarkStructure()`
`boolean`	`hasMimeBody()`
`boolean`	`hasRTL()`
`void`	`incrementDebugCounter()`
`boolean`	`inQuirksMode()`
`short`	`isDebugOn()`
`boolean`	`isDisableHyperlinks()`
`boolean`	`isEnableTableBreaks()`
`boolean`	`isFootnoteGeneration()`
`boolean`	`isForceRTL()`
`boolean`	`isGenerateBookmarksFromAnchors()`
`boolean`	`isGenerateBookmarksFromHeadings()`
`boolean`	`isGenerateForms()`
`boolean`	`isGenerateTooltips()`
`boolean`	`isHeaderfooterGeneration()`
`boolean`	`isLegacyAbsoluteAddressSpace()`
`boolean`	`isTagged()`
`boolean`	`isTocDefined()`
`void`	`keepPhysicalUnitDimensions(boolean keepPhysicalUnitDimensions)`
`void`	`resetDebugCounter()`
`void`	`setActualScaleToProtectPhysicalDimensions(double actualScaleToProtectPhysicalDimensions)`
`void`	`setBase(URL base)`
`void`	`setBody(BlockElement body)`
`void`	`setContext(Context context)`
`void`	`setDebugOn(short on)`
`void`	`setDisableArabicConversion(boolean disableArabicConversion)`
`void`	`setDisableHyperlinks(boolean disableHyperlinks)`
`void`	`setEnableTableBreaks(boolean enableTableBreaks)`
`void`	`setEncoding(String encoding)`
`void`	`setFootnoteGeneration(boolean footnoteGeneration)`
`void`	`setForceRTL(boolean forceRTL)`
`void`	`setFormFont(String formFont, String formFontCharRange)`
`void`	`setGenerateBookmarksFromAnchors(boolean generateBookmarksFromAnchors)`
`void`	`setGenerateBookmarksFromHeadings(boolean generateBookmarksFromHeadings)`
`void`	`setGenerateForms(boolean generateForms)`
`void`	`setHasBookmarkStructure(boolean b)`
`void`	`setHasMimeBody(boolean mimeBody)`
`void`	`setHasRTL(boolean hasRTL)`
`void`	`setHeaderFooterGeneration(boolean headerfooterGeneration)`
`void`	`setInitialUserSpaceWidth(int userSpaceWidth)`
`void`	`setLegacyAbsoluteAddressSpace(boolean legacyAbsoluteAddressSpace)`
`void`	`setLicense(com.pd4ml.util.GOST.Auth license)`
`void`	`setProgressMeter(com.pd4ml.util.ProgressMeter progressMeter)`
`void`	`setRoot(BlockElement root)`
`void`	`setRuntimeProperties(Properties runtimeProperties)`
`void`	`setTagged(boolean tagged)`
`void`	`setTitle(String title)`
`void`	`setTocNumPlaceholder(String numPlaceholder)`
`void`	`setTocPageNumberCorrection(int tocPageNumberCorrection)`
`void`	`setTocTable(TableElement tocTable)`
`void`	`setUseNativeImageObjects(boolean useNativeImageObjects)`
`void`	`setUserSpaceHeight(int userSpaceHeight)`
`void`	`substitutePlaceholders(Map data, int generation)`
`boolean`	`useIdsAsDestinations()`
`boolean`	`useNativeImageObjects()`

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

Field Detail

pageBreaks
```
public HashSet pageBreaks
```

debugCounter
```
public int debugCounter
```

backgroundAsPatterns
```
public boolean backgroundAsPatterns
```

Constructor Detail

Document

public Document(com.pd4ml.fonts.FontCache fontCache)

Method Detail

getStyleInstance

public Style getStyleInstance(Style s)

isForceRTL
```
public boolean isForceRTL()
```

setForceRTL

public void setForceRTL(boolean forceRTL)

addMeta

public void addMeta(String key,
                    String value)

getMeta
```
public String getMeta(String key)
```

getBase
```
public URL getBase()
```

setBase
```
public void setBase(URL base)
```

getEncoding
```
public String getEncoding()
```

setEncoding

public void setEncoding(String encoding)

setTitle
```
public void setTitle(String title)
```

getRoot
```
public BlockElement getRoot()
```

setBody

public void setBody(BlockElement body)

getBody
```
public BlockElement getBody()
```

setRoot

public void setRoot(BlockElement root)

getRemBase
```
public float getRemBase()
```

getTitle
```
public String getTitle()
```

countBlocks
```
public int countBlocks()
```

substitutePlaceholders

public void substitutePlaceholders(Map data,
                                   int generation)

setDebugOn
```
public void setDebugOn(short on)
```

isDebugOn
```
public short isDebugOn()
```

getDataCache

public com.pd4ml.cache.FileCache getDataCache()

getFontCache

public com.pd4ml.fonts.FontCache getFontCache()

isDisableHyperlinks
```
public boolean isDisableHyperlinks()
```

setDisableHyperlinks

public void setDisableHyperlinks(boolean disableHyperlinks)

isGenerateBookmarksFromAnchors

public boolean isGenerateBookmarksFromAnchors()

setGenerateBookmarksFromAnchors

public void setGenerateBookmarksFromAnchors(boolean generateBookmarksFromAnchors)

isGenerateBookmarksFromHeadings

public boolean isGenerateBookmarksFromHeadings()

setGenerateBookmarksFromHeadings

public void setGenerateBookmarksFromHeadings(boolean generateBookmarksFromHeadings)

isHeaderfooterGeneration

public boolean isHeaderfooterGeneration()

setHeaderFooterGeneration

public void setHeaderFooterGeneration(boolean headerfooterGeneration)

isTocDefined
```
public boolean isTocDefined()
```

getTocTable
```
public TableElement getTocTable()
```

setTocTable

public void setTocTable(TableElement tocTable)

setLicense

public void setLicense(com.pd4ml.util.GOST.Auth license)

getLicense

public com.pd4ml.util.GOST.Auth getLicense()

getTocPageNumberCorrection

public int getTocPageNumberCorrection()

setTocPageNumberCorrection

public void setTocPageNumberCorrection(int tocPageNumberCorrection)

getInitialUserSpaceWidth
```
public int getInitialUserSpaceWidth()
```

setInitialUserSpaceWidth

public void setInitialUserSpaceWidth(int userSpaceWidth)

getUserSpaceHeight
```
public int getUserSpaceHeight()
```

setUserSpaceHeight

public void setUserSpaceHeight(int userSpaceHeight)

getActualScaleToProtectPhysicalDimensions

public double getActualScaleToProtectPhysicalDimensions()

setActualScaleToProtectPhysicalDimensions

public void setActualScaleToProtectPhysicalDimensions(double actualScaleToProtectPhysicalDimensions)

isEnableTableBreaks
```
public boolean isEnableTableBreaks()
```

setEnableTableBreaks

public void setEnableTableBreaks(boolean enableTableBreaks)

getBaseFontSize
```
public int getBaseFontSize()
```

getBaseFontFace
```
public String getBaseFontFace()
```

getFormFont
```
public String getFormFont()
```

getFormFontCharRange
```
public String getFormFontCharRange()
```

setFormFont

public void setFormFont(String formFont,
                        String formFontCharRange)

isGenerateForms
```
public boolean isGenerateForms()
```

setGenerateForms

public void setGenerateForms(boolean generateForms)

arePageBreaksBelow

public boolean arePageBreaksBelow(int offset)

isFootnoteGeneration
```
public boolean isFootnoteGeneration()
```

setFootnoteGeneration

public void setFootnoteGeneration(boolean footnoteGeneration)

getRuntimeProperty

public String getRuntimeProperty(String key)

keepPhysicalUnitDimensions

public void keepPhysicalUnitDimensions(boolean keepPhysicalUnitDimensions)

setRuntimeProperties

public void setRuntimeProperties(Properties runtimeProperties)

resetDebugCounter
```
public void resetDebugCounter()
```

incrementDebugCounter
```
public void incrementDebugCounter()
```

useIdsAsDestinations
```
public boolean useIdsAsDestinations()
```

isGenerateTooltips
```
public boolean isGenerateTooltips()
```

isLegacyAbsoluteAddressSpace

public boolean isLegacyAbsoluteAddressSpace()

setLegacyAbsoluteAddressSpace

public void setLegacyAbsoluteAddressSpace(boolean legacyAbsoluteAddressSpace)

useNativeImageObjects

public boolean useNativeImageObjects()

setUseNativeImageObjects

public void setUseNativeImageObjects(boolean useNativeImageObjects)

setProgressMeter

public void setProgressMeter(com.pd4ml.util.ProgressMeter progressMeter)

getProgressMeter

public com.pd4ml.util.ProgressMeter getProgressMeter()

disableArabicConversion

public boolean disableArabicConversion()

setDisableArabicConversion

public void setDisableArabicConversion(boolean disableArabicConversion)

hasMimeBody
```
public boolean hasMimeBody()
```

setHasMimeBody

public void setHasMimeBody(boolean mimeBody)

setTocNumPlaceholder

public void setTocNumPlaceholder(String numPlaceholder)

getTocNumPlaceholder
```
public String getTocNumPlaceholder()
```

setHasBookmarkStructure

public void setHasBookmarkStructure(boolean b)

hasBookmarkStructure
```
public boolean hasBookmarkStructure()
```

inQuirksMode
```
public boolean inQuirksMode()
```

setTagged

public void setTagged(boolean tagged)

isTagged
```
public boolean isTagged()
```

setHasRTL

public void setHasRTL(boolean hasRTL)

hasRTL
```
public boolean hasRTL()
```

getContext
```
public Context getContext()
```

setContext

public void setContext(Context context)

Class Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pageBreaks

debugCounter

backgroundAsPatterns

Constructor Detail

Document

Method Detail

getStyleInstance

isForceRTL

setForceRTL

addMeta

getMeta

getBase

setBase

getEncoding

setEncoding

setTitle

getRoot

setBody

getBody

setRoot

getRemBase

getTitle

countBlocks

substitutePlaceholders

setDebugOn

isDebugOn

getDataCache

getFontCache

isDisableHyperlinks

setDisableHyperlinks

isGenerateBookmarksFromAnchors

setGenerateBookmarksFromAnchors

isGenerateBookmarksFromHeadings

setGenerateBookmarksFromHeadings

isHeaderfooterGeneration

setHeaderFooterGeneration

isTocDefined

getTocTable

setTocTable

setLicense

getLicense

getTocPageNumberCorrection

setTocPageNumberCorrection

getInitialUserSpaceWidth

setInitialUserSpaceWidth

getUserSpaceHeight

setUserSpaceHeight

getActualScaleToProtectPhysicalDimensions

setActualScaleToProtectPhysicalDimensions

isEnableTableBreaks

setEnableTableBreaks

getBaseFontSize

getBaseFontFace

getFormFont

getFormFontCharRange

setFormFont

isGenerateForms

setGenerateForms

arePageBreaksBelow

isFootnoteGeneration

setFootnoteGeneration

getRuntimeProperty

keepPhysicalUnitDimensions

setRuntimeProperties

resetDebugCounter

incrementDebugCounter

useIdsAsDestinations

isGenerateTooltips

isLegacyAbsoluteAddressSpace

setLegacyAbsoluteAddressSpace

useNativeImageObjects

setUseNativeImageObjects

setProgressMeter

getProgressMeter