|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PageArea
Area for a page.
Method Summary | |
---|---|
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 |
---|
PageCollection getPageCollection()
SimplePageMaster getPageMaster()
RegionRefArea getRegionAfter()
RegionRefArea getRegionBefore()
RegionRefArea getRegionStart()
RegionRefArea getRegionEnd()
java.util.Collection<? extends RegionBodyRefArea> getRegionBodies()
RegionBodyRefArea getRegionBody(java.lang.String regionName)
regionName
- The name of the region-body instance to return.
int getNumber()
void layoutComplete() throws AreaTreeException
AreaTreeException
- For layout errors that cannot be resolved
by the AreaTree.void registerMarker(Marker marker)
Marker
instance on this page.
marker
- The marker to be associated with this page.Marker bestMarker(RetrieveMarker retrieveMarker)
retrieveMarker
- The retrieve-marker that is looking for marker
content by which it can be replaced.
retrieveMarker
|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.