org.axsl.galley

Interface AreaNode

All Superinterfaces:

java.lang.Iterable<AreaNode>, javax.swing.tree.TreeNode

All Known Subinterfaces:

Area, BackgroundArea, BeforeFloatArea, BlockContainerArea, BorderPaddingArea, ExternalGraphicArea, FootnoteArea, ForeignObjectArea, Galley, GeneralInlineArea, GraphicArea, InlineArea, LeaderArea, LineArea, ListBlockArea, MainReferenceArea, NormalBlockArea, Page, PageCollection, RegionArea, TableArea, TableCellArea, TextArea

public interface AreaNode
extends javax.swing.tree.TreeNode, java.lang.Iterable<AreaNode>

Super-interface for all nodes in the Area Tree. Implements the Iterable interface to provide an iterator over the child nodes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAreaName() Provides a name suitable for display purposes, but specifically intended to be match the axsl-area-tree DTD.
AreaNode	getChildAt(int childIndex)
Galley	getGalley() Returns the ancestor Galley instance.
void	render(RenderVisitor visitor) Uses the Visitor pattern to allow a Renderer to render this node with proper casting.

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getChildAt

AreaNode getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

getAreaName

java.lang.String getAreaName()

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

Returns:

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

render

void render(RenderVisitor visitor)
     throws GalleyVisitorException

Uses the Visitor pattern to allow a Renderer to render this node with proper casting.

Parameters:

visitor - The RenderVisitor that is rendering this node.

Throws:

GalleyVisitorException - For errors during rendering.

getGalley

Galley getGalley()

Returns the ancestor Galley instance.

Returns:

The ancestor Galley instance.