org.axsl.areaW
Interface AreaNode

All Superinterfaces:

FOContext, OrderedTreeNode, javax.swing.tree.TreeNode

All Known Subinterfaces:

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

public interface AreaNode

extends OrderedTreeNode, FOContext

Super-interface for all AreaTree content.

Method Summary

TableArea	ancestorTableArea() Returns this node's ancestor TableArea.
NormalBlockArea	ancestorWritableNormalBlockArea() Returns this node's ancestor NormalBlockArea.
int	crBPDNearestGeneratedByBlockLevelFO() Convenience method to return the BPD of the content rectangle of the Area returned by nearestGeneratedByBlockLevelFO().
int	crIPDNearestGeneratedByBlockLevelFO() Convenience method to return the IPD of the content rectangle of the Area returned by nearestGeneratedByBlockLevelFO().
FontConsumer	getFontConsumer() Returns the FontConsumer instance used by this AreaTree.
TextServer	getTextServer() Returns the TextServer instance used by this AreaTree.
PageArea	getWritablePage() Returns this node's ancestor PageArea.
AreaNode	getWritableParent() Returns this node's parent node.
Area	getWritableParentArea() Returns this node's parent node.
Area	nearestGeneratedByBlockLevelFO() Finds either "this" or the nearest ancestor area that was generated by a block-level formatting object.
void	removeChild(AreaNode areaNode) Remove a node from this node's children.
FObj	traitGeneratedBy() Returns the FObj instance that generated this node.

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

getWritableParent

public AreaNode getWritableParent()

Returns this node's parent node.

Returns:

This node's parent, cast as an AreaNode, or null if this node has no parent.

getWritableParentArea

public Area getWritableParentArea()

Returns this node's parent node.

Returns:

This node's nearest ancestor Area, or null if this node has no parent, or if there is no Area in its ancestry.

getWritablePage

public PageArea getWritablePage()

Returns this node's ancestor PageArea.

Returns:

This node's ancestor PageArea, or null if this node is not on a page.

traitGeneratedBy

public FObj traitGeneratedBy()

Returns the FObj instance that generated this node.

Returns:

The FObj that generated this node.

ancestorWritableNormalBlockArea

public NormalBlockArea ancestorWritableNormalBlockArea()

Returns this node's ancestor NormalBlockArea.

Returns:

This node's ancestor NormalBlockArea, or null if this node is not in a NormalBlockArea. A NormalBlockArea should not return itself.

ancestorTableArea

public TableArea ancestorTableArea()

Returns this node's ancestor TableArea.

Returns:

This node's ancestor TableArea, or null if this node is not contained in a TableArea. A TableArea should not return itself, but should return its own ancestor TableArea, if any.

removeChild

public void removeChild(AreaNode areaNode)

Remove a node from this node's children. This will have no effect unless the node to be removed is a child of this node.

Parameters:

areaNode - The node to be removed.

nearestGeneratedByBlockLevelFO

public Area nearestGeneratedByBlockLevelFO()

Finds either "this" or the nearest ancestor area that was generated by a block-level formatting object.

Returns:

The Area generated by a block-level FO.

crBPDNearestGeneratedByBlockLevelFO

public int crBPDNearestGeneratedByBlockLevelFO()

Convenience method to return the BPD of the content rectangle of the Area returned by nearestGeneratedByBlockLevelFO().

Returns:

The BPD of the content rectangle of the nearest Area that was generated by a block-level FO, or Constants.DIMENSION_AUTO if there is none.

crIPDNearestGeneratedByBlockLevelFO

public int crIPDNearestGeneratedByBlockLevelFO()

Convenience method to return the IPD of the content rectangle of the Area returned by nearestGeneratedByBlockLevelFO().

Returns:

The IPD of the content rectangle of the nearest Area that was generated by a block-level FO, or Constants.DIMENSION_AUTO if there is none.

getTextServer

public TextServer getTextServer()

Returns the TextServer instance used by this AreaTree.

Returns:

The TextServer.

getFontConsumer

public FontConsumer getFontConsumer()

Returns the FontConsumer instance used by this AreaTree.

Returns:

The FontConsumer.