Package org.apache.fop.afp.modca
Class ActiveEnvironmentGroup
- java.lang.Object
-
- 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
ActiveEnvironmentGroup.DataObjectFontTriplet
static class
ActiveEnvironmentGroup.FontFullyQualifiedNameTriplet
-
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
-
Field Summary
Fields Modifier and Type Field Description private Factory
factory
the resource managerprivate MapCodedFont
mapCodedFont
private java.util.List<AbstractStructuredObject>
mapCodedFonts
The collection of MapCodedFont objectsprivate java.util.List
mapPageSegments
the collection of MapPageSegments objectsprivate MapDataResource
mdr
private ObjectAreaDescriptor
objectAreaDescriptor
the Object Area Descriptor for the active environment groupprivate ObjectAreaPosition
objectAreaPosition
the Object Area Position for the active environment groupprivate PageDescriptor
pageDescriptor
the PageDescriptor for the active environment groupprivate PresentationTextDescriptor
presentationTextDataDescriptor
the PresentationTextDescriptor for the active environment group-
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
Constructors Constructor Description 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 objectprivate MapPageSegment
getCurrentMapPageSegment()
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.private MapPageSegment
needMapPageSegment()
void
setObjectAreaPosition(int x, int y, int rotation)
Set the position of the object areastatic void
setupTruetypeMDR(AbstractTripletStructuredObject mdr, boolean res)
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, 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
-
-
-
-
Field Detail
-
mapCodedFonts
private final java.util.List<AbstractStructuredObject> mapCodedFonts
The collection of MapCodedFont objects
-
mapPageSegments
private java.util.List mapPageSegments
the collection of MapPageSegments objects
-
objectAreaDescriptor
private ObjectAreaDescriptor objectAreaDescriptor
the Object Area Descriptor for the active environment group
-
objectAreaPosition
private ObjectAreaPosition objectAreaPosition
the Object Area Position for the active environment group
-
presentationTextDataDescriptor
private PresentationTextDescriptor presentationTextDataDescriptor
the PresentationTextDescriptor for the active environment group
-
pageDescriptor
private PageDescriptor pageDescriptor
the PageDescriptor for the active environment group
-
factory
private final Factory factory
the resource manager
-
mdr
private MapDataResource mdr
-
mapCodedFont
private MapCodedFont mapCodedFont
-
-
Constructor Detail
-
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
-
-
Method Detail
-
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 classAbstractEnvironmentGroup
- 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 classAbstractStructuredObject
- 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 classAbstractStructuredObject
- 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)
-
setupTruetypeMDR
public static void setupTruetypeMDR(AbstractTripletStructuredObject mdr, boolean res)
-
addMapPageSegment
public void addMapPageSegment(java.lang.String name)
Add map page segment.- Parameters:
name
- of segment to add
-
getCurrentMapPageSegment
private MapPageSegment getCurrentMapPageSegment()
-
needMapPageSegment
private MapPageSegment needMapPageSegment()
-
-