org.writersforge.catalan.templates
Interface RegionMap

All Known Implementing Classes:

GenericRegionMap

public interface RegionMap

Base interface for defining flow regions in a Section. These regions are areas of the document to place content, such as static headers and data content.

Author:

jsheets

Method Summary

java.awt.Rectangle	getRegionExtents(java.lang.String regionName) Returns the geometrical extents of the named region.
java.lang.String[]	getRegionNames() Returns an array of all valid region names in this map.

Method Detail

getRegionNames

public java.lang.String[] getRegionNames()

Returns an array of all valid region names in this map.

Returns:

an array of region names

getRegionExtents

public java.awt.Rectangle getRegionExtents(java.lang.String regionName)

Returns the geometrical extents of the named region.

Parameters:

regionName - the text name of the region

Returns:

a Rectangle that defines the region's extents, or null if region does not exist