org.axsl.area

Interface PageArea

public interface PageArea

Area for a page.

Method Summary

Modifier and Type	Method and Description
Marker	bestMarker(RetrieveMarker retrieveMarker) Provides the marker instance best fitting the requirements of a given retrieve-marker.
int	getNumber() Returns the raw page number for this page.
PageCollection	getPageCollection() Returns the parent PageCollection instance.
SimplePageMaster	getPageMaster() Returns page master from which this page was generated.
RegionRefArea	getRegionAfter() Returns the region-after area.
RegionRefArea	getRegionBefore() Returns the region-before area.
java.util.Collection<? extends RegionBodyRefArea>	getRegionBodies() Returns the region-body areas as a Collection.
RegionBodyRefArea	getRegionBody(java.lang.String regionName) Returns a region-body for this page by name.
RegionRefArea	getRegionEnd() Returns the region-end area.
RegionRefArea	getRegionStart() Returns the region-start area.
void	layoutComplete() Allows a layout system to notify the page that it is done adding content to it.
void	registerMarker(Marker marker) Places a Marker instance on this page.

Method Detail

getPageCollection

PageCollection getPageCollection()

Returns the parent PageCollection instance.

Returns:

The parent PageCollection.

getPageMaster

SimplePageMaster getPageMaster()

Returns page master from which this page was generated.

Returns:

The page master from which this page was generated.

getRegionAfter

RegionRefArea getRegionAfter()

Returns the region-after area.

Returns:

The region-after area.

getRegionBefore

RegionRefArea getRegionBefore()

Returns the region-before area.

Returns:

The region-before area.

getRegionStart

RegionRefArea getRegionStart()

Returns the region-start area.

Returns:

The region-start area.

getRegionEnd

RegionRefArea getRegionEnd()

Returns the region-end area.

Returns:

The region-end area.

getRegionBodies

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

Returns the region-body areas as a Collection.

Returns:

The region-body areas as a Collection.

getRegionBody

RegionBodyRefArea getRegionBody(java.lang.String regionName)

Returns a region-body for this page by name.

Parameters:

regionName - The name of the region-body instance to return.

Returns:

The names region-body area, or null if it does not exist.

getNumber

int getNumber()

Returns the raw page number for this page.

Returns:

The raw page number.

layoutComplete

void layoutComplete()
             throws AreaTreeException

Allows a layout system to notify the page that it is done adding content to it.

Throws:

AreaTreeException - For layout errors that cannot be resolved by the AreaTree.

registerMarker

void registerMarker(Marker marker)

Places a Marker instance on this page.

Parameters:

marker - The marker to be associated with this page.

bestMarker

Marker bestMarker(RetrieveMarker retrieveMarker)

Provides the marker instance best fitting the requirements of a given retrieve-marker.

Parameters:

retrieveMarker - The retrieve-marker that is looking for marker content by which it can be replaced.

Returns:

The marker instance best fitting the requirements of retrieveMarker