|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AreaNode
Super-interface for all AreaTree content.
Method Summary | |
---|---|
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 |
---|
Area ancestorArea()
int siblingIndex()
PageArea getPage()
Fo traitGeneratedBy()
boolean isFirstChildOfGeneratedBy()
NormalBlockArea ancestorNormalBlockArea()
TableArea ancestorTableArea()
BlockContentFactory ancestorBlockContentFactory()
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.
void removeChild(AreaNode areaNode)
areaNode
- The node to be removed.Area nearestGeneratedByBlockLevelFo()
AreaTree getAreaTree()
java.lang.String getAreaName()
Area nearestArea()
Area
, or, if not,
the nearest ancestor node that is an instance of Area
.
|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.