org.axsl.foR
Interface FONode

All Superinterfaces:

OrderedTreeNode, javax.swing.tree.TreeNode

All Known Subinterfaces:

AbstractFlow, AbstractTableBody, BasicLink, BidiOverride, Block, BlockContainer, Bookmark, BookmarkTitle, BookmarkTree, Character, ColorProfile, ContinuedLabel, Declarations, ExternalGraphic, Float, Flow, FObj, FObjMixed, FObjScaled, Footnote, FootnoteBody, ForeignXML, FOText, FOTextContent, InitialPropertySet, Inline, InlineContainer, InstreamForeignObject, Leader, ListBlock, ListItem, ListItemBody, ListItemLabel, Marker, MultiCase, MultiProperties, MultiPropertySet, MultiSwitch, MultiToggle, PageNumber, PageNumberCitation, PageSequence, Region, RegionAfter, RegionBefore, RegionBody, RegionEnd, RegionStart, RetrieveMarker, Root, SimplePageMaster, StaticContent, SVGElement, Table, TableAndCaption, TableBody, TableCaption, TableCell, TableColumn, TableFooter, TableHeader, TableRow, Title, Wrapper

public interface FONode

extends OrderedTreeNode

Interface for nodes in the formatting object tree.

Method Summary

Marker	ancestorMarker() The nearest ancestor Marker instance.
java.util.List	childrenFO() Returns the children of this node.
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.
FONode	getFONodeChildAt(int childIndex) Returns a specific child, cast as an FONode.
int	getLine() Returns the line number of the location of this node in the original document, if known.
FONodeProxy	getProxy() Returns the FONodeProxy instance, if any, associated with this object.
FONodeResult	getResult() Returns the FONodeResult instance, if any, associated with this object.
java.lang.String	getSystemId() Returns any system-id information that is available about which document this node was parsed from.
FONodeProxy	makeProxy(ProxyFactory factory) Used the Gang of Four "Visitor" pattern to create a suitable proxy instance for this node.
FObj	parentFO() Returns the parent of this node.
void	reset() Resets this node and all child nodes so that they can be reused.
void	setProxy(FONodeProxy proxy) Sets a proxy for this FONode.
void	setResult(FONodeResult result) Sets a result set for this FONode.

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

Method Detail

parentFO

public FObj parentFO()

Returns the parent of this node.

Returns:

This node's parent.

getFONodeChildAt

public FONode getFONodeChildAt(int childIndex)

Returns a specific child, cast as an FONode.

Parameters:

childIndex - The index of the child item to be returned.

Returns:

The child at childIndex, cast as an FONode, or null if there is no child at that index.

childrenFO

public java.util.List childrenFO()

Returns the children of this node.

Returns:

The children of this node, nor null if none exist.

setProxy

public void setProxy(FONodeProxy proxy)

Sets a proxy for this FONode.

Parameters:

proxy - The FONodeProxy to be set for this node.

getProxy

public FONodeProxy getProxy()

Returns the FONodeProxy instance, if any, associated with this object.

Returns:

The proxy for this FONode instance.

setResult

public void setResult(FONodeResult result)

Sets a result set for this FONode.

Parameters:

result - The FONodeResult to be set for this node.

getResult

public FONodeResult getResult()

Returns the FONodeResult instance, if any, associated with this object.

Returns:

The current result for this FONode instance.

reset

public void reset()

Resets this node and all child nodes so that they can be reused. Specifically, all references to FONodeProxy and FONodeResult instances should be dereferenced by implementations. Running reset on the FORoot instance should reset the entire FOTree for reuse.

getSystemId

public java.lang.String getSystemId()

Returns any system-id information that is available about which document this node was parsed from. This information is usually derived from a SAX 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.

Returns:

The system-id of this node if it is known, or null if it is not.

getLine

public int getLine()

Returns the line number of the location of this node in the original document, if known. This information is usually derived from a SAX 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.

Returns:

The line number of this node if it is known, or zero if it is not.

getColumn

public int getColumn()

Returns the column number of the location of this node in the original document, if known. This information is usually derived from a SAX 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.

Returns:

The column number of this node if it is known, or zero if it is not.

getContextMessage

public 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.

Returns:

Formatted information about the location of this node.

makeProxy

public FONodeProxy makeProxy(ProxyFactory factory)

Used the Gang of Four "Visitor" pattern to create a suitable proxy instance for this node.

Parameters:

factory - The proxy factory that should be used to actually create the instance.

Returns:

The newly-created proxy.

ancestorMarker

public Marker ancestorMarker()

The nearest ancestor Marker instance.

Returns:

The nearest ancestor Marker instance to this, or null if this has no ancestor Marker. A Marker instance should not return itself.