org.axsl.area

Interface AreaNode

All Superinterfaces:

FoContext, javax.swing.tree.TreeNode

All Known Subinterfaces:

AbstractTablePartContainer, AncestralNormalInlineArea, Area, 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 AreaNode
extends javax.swing.tree.TreeNode, FoContext

Super-interface for all AreaTree content.

Method Summary

Modifier and Type	Method and Description
Area	ancestorArea() Returns this node's nearest ancestor Area.
BlockContentFactory	ancestorBlockContentFactory() Returns this node's nearest ancestor BlockContentFactory.
NormalBlockArea	ancestorNormalBlockArea() Returns this node's ancestor NormalBlockArea.
TableArea	ancestorTableArea() Returns this node's ancestor TableArea.
java.lang.String	getAreaName() Provides a name suitable for display purposes, but specifically intended to match the axsl-area-tree DTD.
AreaTree	getAreaTree() Returns the area tree.
PageArea	getPage() Returns this node's ancestor PageArea.
boolean	isFirstChildOfGeneratedBy() Indicates whether this node is the first child of its "generated-by".
Area	nearestArea() Returns this node if if it is an instance of Area, or, if not, the nearest ancestor node that is an instance of Area.
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.
int	siblingIndex() Returns this node's position within the siblings.
Fo	traitGeneratedBy() Returns the FObj instance that generated this node.

Methods inherited from interface javax.swing.tree.TreeNode

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

Methods inherited from interface org.axsl.fo.FoContext

bpdAncestorBlockOrRa, getGraftingPoint, heightContainingBlock, ipdAncestorBlockArea, ipdAncestorBlockOrRa, ipdContainingRefArea, ipdParentArea, isFirst, isLast, tableWidth, widthContainingBlock

Method Detail

ancestorArea

Area ancestorArea()

Returns this node's nearest ancestor Area.

Returns:

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

siblingIndex

int siblingIndex()

Returns this node's position within the siblings.

Returns:

The 0-based index to "this" in the parent's children.

getPage

PageArea getPage()

Returns this node's ancestor PageArea.

Returns:

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

traitGeneratedBy

Fo traitGeneratedBy()

Returns the FObj instance that generated this node.

Returns:

The FObj that generated this node.

isFirstChildOfGeneratedBy

boolean isFirstChildOfGeneratedBy()

Indicates whether this node is the first child of its "generated-by".

Returns:

True iff this node is the first child of its "generated-by".

ancestorNormalBlockArea

NormalBlockArea ancestorNormalBlockArea()

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

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.

ancestorBlockContentFactory

BlockContentFactory ancestorBlockContentFactory()

Returns this node's nearest ancestor BlockContentFactory. This method is needed for FOs like inline and basic-link that contain block% content, but whose corresponding Areas in the AreaTree cannot contain the Areas that are generated by block% content. In these cases, the block% content must be laid out in some ancestor Area that can hold such areas.

Returns:

This node's ancestor BlockContentFactory, or null if no such ancestor exists. A BlockContentFactory should not return itself.

removeChild

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

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.

getAreaTree

AreaTree getAreaTree()

Returns the area tree.

Returns:

The area tree.

getAreaName

java.lang.String getAreaName()

Provides a name suitable for display purposes, but specifically intended to match the axsl-area-tree DTD.

Returns:

The name of this node, as it is provided in the axsl-area-tree DTD.

nearestArea

Area nearestArea()

Returns this node if if it is an instance of Area, or, if not, the nearest ancestor node that is an instance of Area.

Returns:

The nearest Area, which can be this.