Context (com.pd4ml 4.0.15 API Documentation)

java.lang.Object
- com.pd4ml.html.doc.render.to.Context

Direct Known Subclasses:

TargetRenderContext
```
public class Context
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Context.PageBreakRef

static class Context.StructTag

static class Context.TableBreakRef

Nested Classes
Modifier and Type	Class and Description
`static class`	`Context.PageBreakRef`
`static class`	`Context.StructTag`
`static class`	`Context.TableBreakRef`

Field Summary

Fields
Modifier and Type	Field and Description
`HashMap<BoxRenderer,AbsolutePositionedRenderer>`	`absWrappers`
`boolean`	`cannotStretch`
`Comparator<Context.PageBreakRef>`	`comparator`
`Stack<LayoutPoint>`	`containerPositions`
`Stack<Float>`	`containerWidths`
`int`	`continueFrom`
`Context.PageBreakRef`	`currentPageBreak`
`int`	`currentPageNum`
`boolean`	`done`
`boolean`	`hasTocTable`
`float`	`initialScale`
`float`	`pageBreakPosition`
`ArrayList<Context.PageBreakRef>`	`pageBreaks`
`ArrayList<RowRenderer>`	`pageNumberRendererRows`
`float`	`pageTopY`
`PD4ML`	`pd4ml`
`com.pd4ml.util.ProgressMeter`	`progressMeter`
`boolean`	`reset`
`boolean`	`rotated`
`float`	`scale`
`HashMap<String,BlockRenderer>`	`tocDestinations`

Constructor Summary

Constructors
Constructor and Description
`Context(PD4ML pd4ml, TargetRenderer targetRenderer, float containerWidth, float containerHeight)`
`Context(PD4ML pd4ml, TargetRenderer targetRenderer, float containerWidth, float containerHeight, boolean useAwt)`
`Context(PD4ML pd4ml, TargetRenderer targetRenderer, float containerWidth, float containerHeight, int pageNum)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAbsWrapper(BoxRenderer renderer, AbsolutePositionedRenderer wrapper)`
`void`	`addPageBreak(BoxRenderer originator, boolean attachedToTop, boolean cleanTop)`
`void`	`addPageBreak(Context.PageBreakRef pbreak)`
`void`	`addPageNumberRendererRow(RowRenderer rowRenderer)`
`boolean`	`alreadyHasPagebreak(Context.PageBreakRef pb)`
`void`	`buildDestinationPageMap(Map<String,String> map)`
`int`	`callDepth()`
`void`	`clean()`
`void`	`cleanAndResetOffset()`
`static boolean`	`countryCodeValid(String code)`
`LayoutPoint`	`currentContainer()`
`void`	`decreasePageHeight(float delta)`
`void`	`enterContainer(LayoutPoint pos)`
`void`	`exitContainer()`
`void`	`forcePageOffsetRecalc()`
`boolean`	`generateForms()`
`AbsolutePositionedRenderer`	`getAbsWrapper(BoxRenderer renderer)`
`float`	`getContainerWidth()`
`float`	`getFullPageHeight()`
`int`	`getLastPageBreakOffset()`
`int`	`getMaxPageNum()`
`int`	`getNewID()`
`LayoutPoint`	`getOffsetOnPage()`
`float`	`getPageHeight()`
`float`	`getPageWidth()`
`float`	`getRemainingSpaceInRow()`
`float`	`getYOffsetOnPage()`
`boolean`	`hasTocTable()`
`boolean`	`inArtifact()`
`boolean`	`isByPageMarkup()`
`boolean`	`isFlag()`
`boolean`	`isRtf()`
`boolean`	`needsAnchosrLookup()`
`void`	`normalizePageBreaks()`
`int`	`pageBreaksCount()`
`void`	`registerTocDestination(BlockRenderer renderer, String anchor)`
`void`	`removePagebreaksBelow(int pos)`
`void`	`reset()`
`void`	`resetIdCounter()`
`void`	`resetNewContainerWidth()`
`void`	`resetWidth()`
`void`	`rotate()`
`void`	`setFlag(boolean flag)`
`void`	`setHasTocTable(boolean hasTocTable)`
`void`	`setHorizontalExtent(float extent)`
`void`	`setLang(String lang)`
`void`	`setNeedsAnchosrLookup(boolean needs)`
`void`	`setNewContainerWidth(float containerWidth)`
`void`	`setNewHtmlWidth(float htmlWidth)`
`void`	`setNewWidth(int newWidth)`
`void`	`setPageHeight(float height)`
`void`	`setPageWidth(float width)`
`void`	`setRemainingSpaceInRow(float remainingSpaceInRow)`
`void`	`sortPageBreaks(boolean cleanTop)`
`void`	`testTermination()`
`String`	`toString()`
`boolean`	`usesAwt()`

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

Field Detail

pd4ml
```
public PD4ML pd4ml
```

rotated
```
public boolean rotated
```

reset
```
public boolean reset
```

currentPageNum
```
public int currentPageNum
```

containerWidths
```
public Stack<Float> containerWidths
```

containerPositions

public Stack<LayoutPoint> containerPositions

pageBreakPosition
```
public float pageBreakPosition
```

pageTopY
```
public float pageTopY
```

scale
```
public float scale
```

initialScale
```
public float initialScale
```

cannotStretch
```
public boolean cannotStretch
```

continueFrom
```
public int continueFrom
```

done
```
public boolean done
```

hasTocTable
```
public boolean hasTocTable
```

tocDestinations

public HashMap<String,BlockRenderer> tocDestinations

pageBreaks

public ArrayList<Context.PageBreakRef> pageBreaks

currentPageBreak

public Context.PageBreakRef currentPageBreak

pageNumberRendererRows

public ArrayList<RowRenderer> pageNumberRendererRows

progressMeter

public com.pd4ml.util.ProgressMeter progressMeter

absWrappers

public HashMap<BoxRenderer,AbsolutePositionedRenderer> absWrappers

comparator

public Comparator<Context.PageBreakRef> comparator

Constructor Detail

Context

public Context(PD4ML pd4ml,
               TargetRenderer targetRenderer,
               float containerWidth,
               float containerHeight,
               boolean useAwt)

Context

public Context(PD4ML pd4ml,
               TargetRenderer targetRenderer,
               float containerWidth,
               float containerHeight)

Context

public Context(PD4ML pd4ml,
               TargetRenderer targetRenderer,
               float containerWidth,
               float containerHeight,
               int pageNum)

Method Detail

testTermination

public void testTermination()
                     throws IOException

Throws:: IOException

getAbsWrapper

public AbsolutePositionedRenderer getAbsWrapper(BoxRenderer renderer)

addAbsWrapper

public void addAbsWrapper(BoxRenderer renderer,
                          AbsolutePositionedRenderer wrapper)

setPageHeight

public void setPageHeight(float height)

setHorizontalExtent

public void setHorizontalExtent(float extent)

setNewHtmlWidth

public void setNewHtmlWidth(float htmlWidth)

removePagebreaksBelow

public void removePagebreaksBelow(int pos)

addPageBreak

public void addPageBreak(Context.PageBreakRef pbreak)

alreadyHasPagebreak

public boolean alreadyHasPagebreak(Context.PageBreakRef pb)

addPageBreak

public void addPageBreak(BoxRenderer originator,
                         boolean attachedToTop,
                         boolean cleanTop)

sortPageBreaks

public void sortPageBreaks(boolean cleanTop)

normalizePageBreaks
```
public void normalizePageBreaks()
```

getLastPageBreakOffset
```
public int getLastPageBreakOffset()
```

pageBreaksCount
```
public int pageBreaksCount()
```

getMaxPageNum
```
public int getMaxPageNum()
```

clean
```
public void clean()
```

cleanAndResetOffset
```
public void cleanAndResetOffset()
```

setNewContainerWidth

public void setNewContainerWidth(float containerWidth)

resetNewContainerWidth
```
public void resetNewContainerWidth()
```

getContainerWidth
```
public float getContainerWidth()
```

getPageWidth
```
public float getPageWidth()
```

setPageWidth

public void setPageWidth(float width)

getPageHeight
```
public float getPageHeight()
```

decreasePageHeight

public void decreasePageHeight(float delta)

enterContainer

public void enterContainer(LayoutPoint pos)

callDepth
```
public int callDepth()
```

exitContainer
```
public void exitContainer()
```

forcePageOffsetRecalc
```
public void forcePageOffsetRecalc()
```

currentContainer
```
public LayoutPoint currentContainer()
```

getOffsetOnPage
```
public LayoutPoint getOffsetOnPage()
```

getYOffsetOnPage
```
public float getYOffsetOnPage()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

usesAwt
```
public boolean usesAwt()
```

generateForms
```
public boolean generateForms()
```

isRtf
```
public boolean isRtf()
```

hasTocTable
```
public boolean hasTocTable()
```

setHasTocTable

public void setHasTocTable(boolean hasTocTable)

registerTocDestination

public void registerTocDestination(BlockRenderer renderer,
                                   String anchor)

buildDestinationPageMap

public void buildDestinationPageMap(Map<String,String> map)

needsAnchosrLookup
```
public boolean needsAnchosrLookup()
```

setNeedsAnchosrLookup

public void setNeedsAnchosrLookup(boolean needs)

addPageNumberRendererRow

public void addPageNumberRendererRow(RowRenderer rowRenderer)

isByPageMarkup
```
public boolean isByPageMarkup()
```

setLang
```
public void setLang(String lang)
```

getFullPageHeight
```
public float getFullPageHeight()
```

countryCodeValid

public static boolean countryCodeValid(String code)

inArtifact
```
public boolean inArtifact()
```

getNewID
```
public int getNewID()
```

resetIdCounter
```
public void resetIdCounter()
```

getRemainingSpaceInRow
```
public float getRemainingSpaceInRow()
```

setRemainingSpaceInRow

public void setRemainingSpaceInRow(float remainingSpaceInRow)

isFlag
```
public boolean isFlag()
```

setFlag
```
public void setFlag(boolean flag)
```

rotate

public void rotate()
            throws IOException

Throws:: IOException

reset
```
public void reset()
```

setNewWidth

public void setNewWidth(int newWidth)
                 throws IOException

Throws:: IOException

resetWidth
```
public void resetWidth()
```

Class Context

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pd4ml

rotated

reset

currentPageNum

containerWidths

containerPositions

pageBreakPosition

pageTopY

scale

initialScale

cannotStretch

continueFrom

done

hasTocTable

tocDestinations

pageBreaks

currentPageBreak

pageNumberRendererRows

progressMeter

absWrappers

comparator

Constructor Detail

Context

Context

Context

Method Detail

testTermination

getAbsWrapper

addAbsWrapper

setPageHeight

setHorizontalExtent

setNewHtmlWidth

removePagebreaksBelow

addPageBreak

alreadyHasPagebreak

addPageBreak

sortPageBreaks

normalizePageBreaks

getLastPageBreakOffset

pageBreaksCount

getMaxPageNum

clean

cleanAndResetOffset

setNewContainerWidth

resetNewContainerWidth

getContainerWidth

getPageWidth

setPageWidth

getPageHeight

decreasePageHeight

enterContainer

callDepth

exitContainer

forcePageOffsetRecalc

currentContainer

getOffsetOnPage

getYOffsetOnPage

toString

usesAwt

generateForms

isRtf

hasTocTable

setHasTocTable

registerTocDestination

buildDestinationPageMap

needsAnchosrLookup

setNeedsAnchosrLookup

addPageNumberRendererRow

isByPageMarkup

setLang

getFullPageHeight

countryCodeValid

inArtifact