org.axsl.fo

Interface FoContext

All Known Subinterfaces:

AbstractTablePartContainer, AncestralNormalInlineArea, Area, AreaNode, AreaTree, BeforeFloatRefArea, BlockContainerRefArea, BlockContentFactory, FootnoteRefArea, GlyphAreaSequence, InlineContainerArea, LineArea, ListBlockArea, ListItemArea, ListItemBodyContainer, ListItemLabelContainer, MainRefArea, NormalBlockArea, NormalFlowRefArea, NormalInlineArea, PageCollection, PageCollectionWrapper, RegionBodyRefArea, RegionRefArea, SpanRefArea, TableArea, TableBodyContainer, TableCellArea, TableFooterContainer, TableHeaderContainer, TableRowContainer

public interface FoContext

Provides the FO Tree with contextual information for cases where its contents may be used differently in one context than in another. FoContext allows client applications to look up and provide the context information only if it is actually needed by the FoTree.

Method Summary

Modifier and Type	Method and Description
int	bpdAncestorBlockOrRa() Returns the block-progression-dimension of either 1) the nearest area ancestor that was generated by a block-level formatting object, or 2) if there is no such area ancestor, the nearest area ancestor that is a reference area.
GraftingPoint	getGraftingPoint() Tells the FO Tree which RetrieveMarker or RetrieveTableMarker instance should be the grafting point if a Marker instance is found in the FO Tree.
int	heightContainingBlock() Returns the height of the containing block.
int	ipdAncestorBlockArea() Returns the inline-progression-dimension of the content-rectangle of the nearest ancestor block area that is not a line area.
int	ipdAncestorBlockOrRa() Returns the inline-progression-dimension of either 1) the nearest area ancestor that was generated by a block-level formatting object, or 2) if there is no such area ancestor, the nearest area ancestor that is a reference area.
int	ipdContainingRefArea() Returns the inline-progression-dimension of the containing reference area, in millipoints.
int	ipdParentArea() Returns the inline-progression-dimension of the content rectangle of the parent Area, in millipoints.
boolean	isFirst() Indicates whether the context is the first Area within its parent reference-area.
boolean	isLast() Indicates whether the context is the last Area within its parent reference-area.
int	tableWidth() Returns the width of the table for this context.
int	widthContainingBlock() Returns the width of the containing block.

Method Detail

getGraftingPoint

GraftingPoint getGraftingPoint()

Tells the FO Tree which RetrieveMarker or RetrieveTableMarker instance should be the grafting point if a Marker instance is found in the FO Tree.

Returns:

The point to which marker contents found should be grafted.

ipdAncestorBlockOrRa

int ipdAncestorBlockOrRa()

Returns the inline-progression-dimension of either 1) the nearest area ancestor that was generated by a block-level formatting object, or 2) if there is no such area ancestor, the nearest area ancestor that is a reference area. The canonical use of this value is as the base for percentage calculations for the inline-progression-dimension property.

Returns:

The IPD, in millipoints, of the nearest area generated by a block-level FO, or reference area.

bpdAncestorBlockOrRa

int bpdAncestorBlockOrRa()

Returns the block-progression-dimension of either 1) the nearest area ancestor that was generated by a block-level formatting object, or 2) if there is no such area ancestor, the nearest area ancestor that is a reference area. The canonical use of this value is as the base for percentage calculations for the block-progression-dimension property.

Returns:

The BPD, in millipoints, of the nearest area generated by a block-level FO, or reference area.

tableWidth

int tableWidth()

Returns the width of the table for this context. Calling this method outside the context of a table will result in RuntimeException.

Returns:

The width of the nearest Table.

ipdAncestorBlockArea

int ipdAncestorBlockArea()

Returns the inline-progression-dimension of the content-rectangle of the nearest ancestor block area that is not a line area.

Returns:

The IPD of the nearest normal block area.

widthContainingBlock

int widthContainingBlock()

Returns the width of the containing block.

Returns:

The width of the containing block.

heightContainingBlock

int heightContainingBlock()

Returns the height of the containing block.

Returns:

The height of the containing block.

isFirst

boolean isFirst()

Indicates whether the context is the first Area within its parent reference-area.

Returns:

True iff the context is the first Area within its parent reference-area.

isLast

boolean isLast()

Indicates whether the context is the last Area within its parent reference-area.

Returns:

True iff the context is the last Area within its parent reference-area.

ipdContainingRefArea

int ipdContainingRefArea()

Returns the inline-progression-dimension of the containing reference area, in millipoints.

Returns:

The IPD of the containing reference area.

ipdParentArea

int ipdParentArea()

Returns the inline-progression-dimension of the content rectangle of the parent Area, in millipoints.

Returns:

The IPD of the parent Area's content rectangle.