org.axsl.galley

Interface Page

All Superinterfaces:

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

public interface Page
extends Area

An Area containing a page.

Method Summary

Modifier and Type	Method and Description
AreaNode	firstUnresolvedRefId() Determines whether there are any unresolved "ref-id" items on this page.
java.lang.CharSequence	getFormattedNumber() Returns the formatted page number of this page.
int	getHeight() Returns the height of this page.
int	getNumber() Returns the raw page number of this page.
PageCollection	getParent() Returns the PageCollection parent of this Page.
RegionArea	getRegionAfter() Returns the region-after for this page.
RegionArea	getRegionBefore() Returns the region-before for this page.
java.util.Collection<? extends RegionArea>	getRegionBodies() Returns the region-body for this page.
RegionArea	getRegionEnd() Returns the region-end for this page.
RegionArea	getRegionStart() Returns the region-start for this page.
int	getWidth() Returns the width of this page.

Methods inherited from interface org.axsl.galley.Area

brBpd, brIpd, brOriginX, brOriginY, crBpd, crIpd, crOriginX, crOriginY, destinationName, generatedByExists, generatedByName, isLinkRoot, linkDestination, linkType, traitId

Methods inherited from interface org.axsl.galley.AreaNode

getAreaName, getChildAt, getGalley, render

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, isLeaf

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getRegionAfter

RegionArea getRegionAfter()

Returns the region-after for this page.

Returns:

The region-after for this page.

getRegionBefore

RegionArea getRegionBefore()

Returns the region-before for this page.

Returns:

The region-before for this page.

getRegionStart

RegionArea getRegionStart()

Returns the region-start for this page.

Returns:

The region-start for this page.

getRegionEnd

RegionArea getRegionEnd()

Returns the region-end for this page.

Returns:

The region-end for this page.

getRegionBodies

java.util.Collection<? extends RegionArea> getRegionBodies()

Returns the region-body for this page.

Returns:

The region-body for this page.

firstUnresolvedRefId

AreaNode firstUnresolvedRefId()

Determines whether there are any unresolved "ref-id" items on this page. If so, the page is not yet ready to be rendered.

Returns:

The first node on this page that has an unresolved "ref-id", or null if there are no such nodes.

getHeight

int getHeight()

Returns the height of this page.

Returns:

The height, in millipoints, of this page.

getWidth

int getWidth()

Returns the width of this page.

Returns:

The width, in millipoints, of this page.

getNumber

int getNumber()

Returns the raw page number of this page.

Returns:

The page number of this page.

getFormattedNumber

java.lang.CharSequence getFormattedNumber()

Returns the formatted page number of this page.

Returns:

The formatted page number of this page.

getParent

PageCollection getParent()

Returns the PageCollection parent of this Page.

Specified by:

getParent in interface javax.swing.tree.TreeNode

Returns:

The PageCollection parent of this Page.