org.apache.fop.afp.modca
Class ActiveEnvironmentGroup
java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
org.apache.fop.afp.modca.AbstractNamedAFPObject
org.apache.fop.afp.modca.AbstractEnvironmentGroup
org.apache.fop.afp.modca.ActiveEnvironmentGroup
- All Implemented Interfaces:
- Streamable
public final class ActiveEnvironmentGroup
- extends AbstractEnvironmentGroup
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.
Constructor Summary |
ActiveEnvironmentGroup(Factory factory,
java.lang.String name,
int width,
int height,
int widthRes,
int heightRes)
Constructor for the ActiveEnvironmentGroup, this takes a
name parameter which must be 8 characters long. |
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject |
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setObjectClassification, writeTriplets |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ActiveEnvironmentGroup
public ActiveEnvironmentGroup(Factory factory,
java.lang.String name,
int width,
int height,
int widthRes,
int heightRes)
- Constructor for the ActiveEnvironmentGroup, this takes a
name parameter which must be 8 characters long.
- Parameters:
factory
- the object factoryname
- the active environment group namewidth
- the page widthheight
- the page heightwidthRes
- the page width resolutionheightRes
- the page height resolution
setObjectAreaPosition
public void setObjectAreaPosition(int x,
int y,
int rotation)
- Set the position of the object area
- Parameters:
x
- the x offsety
- the y offsetrotation
- the rotation
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
writeContent
public void writeContent(java.io.OutputStream os)
throws java.io.IOException
- Helper method to write the contents of the Object.
- Overrides:
writeContent
in class AbstractEnvironmentGroup
- Parameters:
os
- The stream to write to
- Throws:
java.io.IOException
- throws an I/O exception if one occurred
writeStart
protected void writeStart(java.io.OutputStream os)
throws java.io.IOException
- Helper method to write the start of the Object.
- Overrides:
writeStart
in class AbstractStructuredObject
- Parameters:
os
- The stream to write to
- Throws:
java.io.IOException
- throws an I/O exception if one occurred
writeEnd
protected void writeEnd(java.io.OutputStream os)
throws java.io.IOException
- Helper method to write the end of the Object.
- Overrides:
writeEnd
in class AbstractStructuredObject
- Parameters:
os
- The stream to write to
- Throws:
java.io.IOException
- an I/O exception if one occurred
createFont
public void createFont(int fontRef,
AFPFont font,
int size,
int orientation)
- Method to create a map coded font object
- Parameters:
fontRef
- the font number used as the resource identifierfont
- the fontsize
- the point size of the fontorientation
- the orientation of the font (e.g. 0, 90, 180, 270)
addMapPageSegment
public void addMapPageSegment(java.lang.String name)
Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.