|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Fo
Base interface for formatting objects.
Implements the Iterable
interface to provide an iterator over the
child nodes.
Field Summary | |
---|---|
static int |
DIMENSION_AUTO
Constant used to designate the "auto" value for the block-progression-dimension and inline-progression-dimension properties. |
Method Summary | |
---|---|
java.lang.Object |
acceptProxyFactory(ProxyFactory factory)
Creates an appropriate proxy for this node. |
BasicLink |
ancestorBasicLink(FoContext context)
Returns the nearest ancestor BasicLink. |
Fo |
ancestorListRelatedObject(FoContext context)
Returns the nearest ancestor list-related object. |
Marker |
ancestorMarker()
The nearest ancestor Marker instance. |
Table |
ancestorTable(FoContext context)
Returns the nearest ancestor Table. |
Fo |
getChildAt(int childIndex)
|
int |
getColumn()
Returns the column number of the location of this node in the original document, if known. |
java.lang.String |
getContextMessage()
Provides formatted information about the location (system-id, line, and column number from the parsed document) of this node, suitable for user messages. |
int |
getLine()
Returns the line number of the location of this node in the original document, if known. |
java.lang.String |
getName()
Returns the name of this formatting object. |
Fo |
getParent()
|
int |
getSequentialIndex()
Returns the unique sequential index assigned to this node. |
java.lang.String |
getSystemId()
Returns any system-id information that is available about which document this node was parsed from. |
boolean |
isBlockLevelFo()
Indicates whether this FO is a block-level FO. |
int |
qtyMarkerChildren()
Returns the number of children of the FO that are Marker s. |
boolean |
traitIsReferenceArea()
Returns the value of the is-reference-area trait. |
Methods inherited from interface javax.swing.tree.TreeNode |
---|
children, getAllowsChildren, getChildCount, getIndex, isLeaf |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Field Detail |
---|
static final int DIMENSION_AUTO
Method Detail |
---|
Fo getParent()
getParent
in interface javax.swing.tree.TreeNode
Fo getChildAt(int childIndex)
getChildAt
in interface javax.swing.tree.TreeNode
int getSequentialIndex()
Returns the unique sequential index assigned to this node. Each node in the FOTree is required to have an index that is unique within the FOTree, and which is assigned sequentially starting at zero.
This index provides a way for systems external to the FOTree, like the Area Tree or a layout system, to add virtual fields to nodes in the FOTree without needing to modify or extend it, and without adding a significant amount of processing overhead. For example, for systems that use the FOTree to create an Area Tree, an object is usually needed to keep track of which Areas in the Area Tree were generated by which FONodes in the FOTree. Although a reference to this object could be embedded within the FOTree itself, this would add a concern to the FOTree that it should not have. Further, this would cause problems if, for example, two Area Tree implementation tried to access the same FOTree at the same time.
By using the sequential index, the external application can create an array-like data structure to store the references. So, for example, if the Area Tree wants to store a list of Areas generated by each FONode, it can create a List[] or ArrayList<List> (or any other data structure with efficient direct access by index), containing such Lists. Then, instead of getting the List directly from the FONode, the index is obtained instead, then the List is obtained from the data structure.
Note that the sequence of the indexes is not important, only their range. For example, if a given FOTree had 3 nodes, those nodes should always be numbered 0 thru 2. One implementation might number a fixed list of them 0, 1, 2, while another might number them 2, 0, 1. The requirement to number them from zero and sequentially is intened to minimize the amount of memory that is needed to store the array-like structures that these indexes will be used to access.
java.lang.String getSystemId()
Locator
during
parsing.
However, this information will not be available for documents that were
not parsed, for documents parsed with parsers that do not provide this
information, or for documents that are downstream in a SAX chain.
int getLine()
Locator
during
parsing.
However, this information will not be available for documents that were
not parsed, for documents parsed with parsers that do not provide this
information, or for documents that are downstream in a SAX chain.
int getColumn()
Locator
during
parsing.
However, this information will not be available for documents that were
not parsed, for documents parsed with parsers that do not provide this
information, or for documents that are downstream in a SAX chain.
java.lang.String getContextMessage()
java.lang.Object acceptProxyFactory(ProxyFactory factory)
factory
.
For example, a subclass handling ExternalGraphic
would be expected to return
ProxyFactory.makeProxy(org.axsl.fo.fo.ExternalGraphic)
.
factory
- The proxy factory that should be used to actually create
the instance.
Marker ancestorMarker()
boolean isBlockLevelFo()
boolean traitIsReferenceArea()
Table ancestorTable(FoContext context)
context
- An object that knows how to resolve FO Tree context
issues.
BasicLink ancestorBasicLink(FoContext context)
context
- An object that knows how to resolve FO Tree context
issues.
Fo ancestorListRelatedObject(FoContext context)
context
- An object that knows how to resolve FO Tree context
issues.
java.lang.String getName()
int qtyMarkerChildren()
Marker
s.
|
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.