org.apache.fop.render.afp.modca
Class ActiveEnvironmentGroup

java.lang.Object
  org.apache.fop.render.afp.modca.AFPObject
      org.apache.fop.render.afp.modca.ActiveEnvironmentGroup

public final class ActiveEnvironmentGroup

extends AFPObject

An Active Environment Group (AEG) is associated with each page, and is contained in the page's begin-end envelope in the data stream. The active environment group contains layout and formatting information that defines the measurement units and size of the page, and may contain resource information. Any objects that are required for page presentation and that are to be treated as resource objects must be mapped with a map structured field in the AEG. The scope of an active environment group is the scope of its containing page or overlay.

Field Summary

Fields inherited from class org.apache.fop.render.afp.modca.AFPObject

LOGGER

Constructor Summary

ActiveEnvironmentGroup(int width, int height)
Default constructor for the ActiveEnvironmentGroup.

ActiveEnvironmentGroup(java.lang.String name, int width, int height)
Constructor for the ActiveEnvironmentGroup, this takes a name parameter which must be 8 characters long.

Method Summary

void	createFont(byte fontReference, java.lang.String fontFamily, java.lang.String weight, java.lang.String style, int size, int orientation) Method to create a map coded font object
void	createOverlay(java.lang.String name) Actually creates the MPO object.
byte[]	getDataStream() Accessor method to obtain the byte array AFP datastream for the active environment group.
PageDescriptor	getPageDescriptor() Accessor method to obtain the PageDescriptor object of the active environment group.
PresentationTextDescriptor	getPresentationTextDataDescriptor() Accessor method to obtain the PresentationTextDataDescriptor object of the active environment group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActiveEnvironmentGroup

public ActiveEnvironmentGroup(int width,
                              int height)

Default constructor for the ActiveEnvironmentGroup.

Parameters:

width - the page width

height - the page height

ActiveEnvironmentGroup

public ActiveEnvironmentGroup(java.lang.String name,
                              int width,
                              int height)

Constructor for the ActiveEnvironmentGroup, this takes a name parameter which must be 8 characters long.

Parameters:

name - the active environment group name

width - the page width

height - the page height

Method Detail

getPageDescriptor

public PageDescriptor getPageDescriptor()

Accessor method to obtain the PageDescriptor object of the active environment group.

Returns:

the page descriptor object

getPresentationTextDataDescriptor

public PresentationTextDescriptor getPresentationTextDataDescriptor()

Accessor method to obtain the PresentationTextDataDescriptor object of the active environment group.

Returns:

the presentation text descriptor

getDataStream

public byte[] getDataStream()
                     throws java.io.IOException

Accessor method to obtain the byte array AFP datastream for the active environment group.

Specified by:

getDataStream in class AFPObject

Returns:

byte[] data stream

Throws:

java.io.IOException

createFont

public void createFont(byte fontReference,
                       java.lang.String fontFamily,
                       java.lang.String weight,
                       java.lang.String style,
                       int size,
                       int orientation)

Method to create a map coded font object

Parameters:

fontReference - the font number used as the resource identifier

fontFamily - the font family identifies the font name

weight - the font weight (e.g. normal, bold)

style - the font style (e.g. normal, italics)

size - the point size of the font

orientation - the orientation of the font (e.g. 0, 90, 180, 270)

createOverlay

public void createOverlay(java.lang.String name)

Actually creates the MPO object. Also creates the supporting object (an IPO)

Parameters:

name - the name of the overlay to be used