org.axsl.areaW
Interface PageArea

public interface PageArea

Area for a page.

Method Summary

Marker	bestMarker(RetrieveMarker retrieveMarker) Provides the marker instance betst fitting the requirements of a given retrieve-marker.
int	getNumber() Returns the raw page number for this page.
SimplePageMaster	getPageMaster() Returns page master from which this page was generated.
PageCollection	getWritablePageCollection() Returns the parent PageCollection instance.
RegionArea	getWritableRegionAfter() Returns the region-after area.
RegionArea	getWritableRegionBefore() Returns the region-before area.
RegionRABody	getWritableRegionBody() Returns the region-body area.
RegionArea	getWritableRegionEnd() Returns the region-end area.
RegionArea	getWritableRegionStart() 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

getWritablePageCollection

public PageCollection getWritablePageCollection()

Returns the parent PageCollection instance.

Returns:

The parent PageCollection.

getPageMaster

public SimplePageMaster getPageMaster()

Returns page master from which this page was generated.

Returns:

The page master from which this page was generated.

getWritableRegionAfter

public RegionArea getWritableRegionAfter()

Returns the region-after area.

Returns:

The region-after area.

getWritableRegionBefore

public RegionArea getWritableRegionBefore()

Returns the region-before area.

Returns:

The region-before area.

getWritableRegionStart

public RegionArea getWritableRegionStart()

Returns the region-start area.

Returns:

The region-start area.

getWritableRegionEnd

public RegionArea getWritableRegionEnd()

Returns the region-end area.

Returns:

The region-end area.

getWritableRegionBody

public RegionRABody getWritableRegionBody()

Returns the region-body area.

Returns:

The region-body area.

getNumber

public int getNumber()

Returns the raw page number for this page.

Returns:

The raw page number.

layoutComplete

public void layoutComplete()
                    throws AreaWException

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

Throws:

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

registerMarker

public void registerMarker(Marker marker)

Places a Marker instance on this page.

Parameters:

marker - The marker to be associated with this page.

bestMarker

public Marker bestMarker(RetrieveMarker retrieveMarker)

Provides the marker instance betst 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