org.axsl.areaW
Interface Area

All Superinterfaces:

AreaNode, FOContext, OrderedTreeNode, javax.swing.tree.TreeNode

All Known Subinterfaces:

AbstractNormalBlockArea, AbstractTableContainer, BasicLinkArea, BeforeFloatRA, BlockArea, BlockContainerRA, ContainerRA, ExternalGraphicArea, FootnoteRA, ForeignObjectArea, GenericContainer, InlineArea, LeaderArea, LineArea, ListBlockArea, ListItemArea, MainRA, MarkerContentArea, NormalBlockArea, NormalFlowRA, PageNumberArea, PageNumberCitationArea, RegionArea, RegionRABody, SpanRA, TableArea, TableBodyContainer, TableCellArea, TableFooterContainer, TableHeaderContainer, TableRowContainer, TextArea

public interface Area

extends AreaNode

Super-interface for all AreaNode instances that actually occupy area on a page.

Method Summary

int	crBPD() Returns the content-rectangle block-progression-dimension for this Area.
int	crIPD() Returns the content-rectangle inline-progression-dimension for this Area.
void	incrementProgressionDimension(int incrementAmount) Change the progression-dimension used by this Area.
BlockContainerRA	makeBlockContainerArea(BlockContainer blockContainer, RetrieveMarker retrieveMarker) Create a new BlockContainerRA as a child of this Area.
ListBlockArea	makeListBlockArea(ListBlock listBlock, RetrieveMarker retrieveMarker) Create a new ListBlockArea as a child of this Area.
MarkerContentArea	makeMarkerContentArea(RetrieveMarker retrieveMarker, Marker marker) Create a new MarkerContentArea as a child of this Area.
NormalBlockArea	makeNormalBlockArea(Block block, RetrieveMarker retrieveMarker) Create a new NormalBlockArea as a child of this Area.
TableArea	makeTableArea(Table table, RetrieveMarker retrieveMarker) Create a new TableArea as a child of this Area.
int	progressionDimensionAvailable() Returns the amount of progression-dimension in this Area which can still be used by child Areas.
void	setProgressionDimension(int newAmount) Sets the progression-dimension used by this Area.
short	traitAbsolutePosition() Returns the "absolute-position" trait for this Area.

Methods inherited from interface org.axsl.areaW.AreaNode

ancestorTableArea, ancestorWritableNormalBlockArea, crBPDNearestGeneratedByBlockLevelFO, crIPDNearestGeneratedByBlockLevelFO, getFontConsumer, getTextServer, getWritablePage, getWritableParent, getWritableParentArea, nearestGeneratedByBlockLevelFO, removeChild, traitGeneratedBy

Methods inherited from interface org.axsl.common.OrderedTreeNode

getChildren, getFirstChild, getFirstLeaf, getLastChild, getLastLeaf, getNextLeaf, getNextSibling, getPreviousLeaf, getPreviousSibling, getSiblings, hasChildren, nextPreOrderNode, siblingIndex

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface org.axsl.foR.FOContext

getRetrieveMarker

Method Detail

crBPD

public int crBPD()

Returns the content-rectangle block-progression-dimension for this Area.

Returns:

The block-progression-dimension of the content-rectangle for this Area.

crIPD

public int crIPD()

Returns the content-rectangle inline-progression-dimension for this Area.

Returns:

The inline-progression-dimension of the content-rectangle for this Area.

incrementProgressionDimension

public void incrementProgressionDimension(int incrementAmount)

Change the progression-dimension used by this Area.

Parameters:

incrementAmount - The amount by which the progression-dimension should be changed for this area. Positive values increase the progression-dimension, negative values decrease it.

setProgressionDimension

public void setProgressionDimension(int newAmount)

Sets the progression-dimension used by this Area.

Parameters:

newAmount - The new progression-dimension value for this Area.

traitAbsolutePosition

public short traitAbsolutePosition()

Returns the "absolute-position" trait for this Area.

Returns:

The "absolute-position" trait, one of Constants.FOVAL_AUTO, Constants.FOVAL_ABSOLUTE, or Constants.FOVAL_FIXED.

makeTableArea

public TableArea makeTableArea(Table table,
                               RetrieveMarker retrieveMarker)

Create a new TableArea as a child of this Area.

Parameters:

table - The generating Table instance.

retrieveMarker - The RetrieveMarker, if any, controlling this Area.

Returns:

The new TableArea instance.

makeNormalBlockArea

public NormalBlockArea makeNormalBlockArea(Block block,
                                           RetrieveMarker retrieveMarker)

Create a new NormalBlockArea as a child of this Area.

Parameters:

block - The generating Block instance.

retrieveMarker - The RetrieveMarker, if any, controlling this Area.

Returns:

The new NormalBlockArea instance.

makeBlockContainerArea

public BlockContainerRA makeBlockContainerArea(BlockContainer blockContainer,
                                               RetrieveMarker retrieveMarker)

Create a new BlockContainerRA as a child of this Area.

Parameters:

blockContainer - The generating BlockContainer instance.

retrieveMarker - The RetrieveMarker, if any, controlling this Area.

Returns:

The new BlockContainerRA instance.

makeListBlockArea

public ListBlockArea makeListBlockArea(ListBlock listBlock,
                                       RetrieveMarker retrieveMarker)

Create a new ListBlockArea as a child of this Area.

Parameters:

listBlock - The generating ListBlock instance.

retrieveMarker - The RetrieveMarker, if any, controlling this Area.

Returns:

The new ListBlockArea instance.

makeMarkerContentArea

public MarkerContentArea makeMarkerContentArea(RetrieveMarker retrieveMarker,
                                               Marker marker)

Create a new MarkerContentArea as a child of this Area.

Parameters:

retrieveMarker - The RetrieveMarker which is being replaced by Marker content.

marker - The Marker whose content is replacing the RetrieveMarker.

Returns:

The new MarkerContentArea instance.

progressionDimensionAvailable

public int progressionDimensionAvailable()

Returns the amount of progression-dimension in this Area which can still be used by child Areas.

Returns:

The amount of space, in millipoints, available in this Area for expansion in the progression direction.