|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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
public final class ActiveEnvironmentGroup
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.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject |
|---|
AbstractAFPObject.Category, AbstractAFPObject.Type |
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.afp.modca.AbstractEnvironmentGroup |
|---|
mapDataResources, mapPageOverlays |
| Fields inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject |
|---|
name |
| Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject |
|---|
triplets |
| Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject |
|---|
LOG, SF_CLASS, SF_HEADER_LENGTH |
| 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. |
|
| Method Summary | |
|---|---|
void |
addMapPageSegment(java.lang.String name)
Add map page segment. |
void |
createFont(int fontRef,
AFPFont font,
int size,
int orientation)
Method to create a map coded font object |
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. |
void |
setObjectAreaPosition(int x,
int y,
int rotation)
Set the position of the object area |
void |
writeContent(java.io.OutputStream os)
Helper method to write the contents of the Object. |
protected void |
writeEnd(java.io.OutputStream os)
Helper method to write the end of the Object. |
protected void |
writeStart(java.io.OutputStream os)
Helper method to write the start of the Object. |
| Methods inherited from class org.apache.fop.afp.modca.AbstractEnvironmentGroup |
|---|
createOverlay, getLastElement |
| Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject |
|---|
copySF, getName, getNameBytes, getNameLength, setName, toString |
| 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 org.apache.fop.afp.modca.AbstractStructuredObject |
|---|
writeToStream |
| Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject |
|---|
copySF, truncate, writeChunksToStream, writeObjects |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ActiveEnvironmentGroup(Factory factory,
java.lang.String name,
int width,
int height,
int widthRes,
int heightRes)
factory - the object factoryname - the active environment group namewidth - the page widthheight - the page heightwidthRes - the page width resolutionheightRes - the page height resolution| Method Detail |
|---|
public void setObjectAreaPosition(int x,
int y,
int rotation)
x - the x offsety - the y offsetrotation - the rotationpublic PageDescriptor getPageDescriptor()
public PresentationTextDescriptor getPresentationTextDataDescriptor()
public void writeContent(java.io.OutputStream os)
throws java.io.IOException
writeContent in class AbstractEnvironmentGroupos - The stream to write to
java.io.IOException - throws an I/O exception if one occurred
protected void writeStart(java.io.OutputStream os)
throws java.io.IOException
writeStart in class AbstractStructuredObjectos - The stream to write to
java.io.IOException - throws an I/O exception if one occurred
protected void writeEnd(java.io.OutputStream os)
throws java.io.IOException
writeEnd in class AbstractStructuredObjectos - The stream to write to
java.io.IOException - an I/O exception if one occurred
public void createFont(int fontRef,
AFPFont font,
int size,
int orientation)
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)public void addMapPageSegment(java.lang.String name)
name - of segment to add
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||