org.apache.fop.afp.modca (Apache FOP 2.7 API)
Date: 2022-01-12

# Package org.apache.fop.afp.modca

Contains a collection of AFP Mixed Object Document Content Architecture (MO:DCA) structured objects.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  AbstractAFPObject.Category | structured field category codes
  AbstractAFPObject.Type | structured field type codes

- Class Summary
  Class | Description
  --- | ---
  AbstractAFPObject | This is the base class for all data stream objects.
  AbstractDataObject | Abstract base class used by the ImageObject and GraphicsObject which both have define an ObjectEnvironmentGroup
  AbstractDescriptor | Base class for AFP descriptor objects
  AbstractEnvironmentGroup | A base class that encapsulates common features of ActiveEnvironmentGroup and ResourceEnvironmentGroup
  AbstractNamedAFPObject | This is the base class for all named data stream objects.
  AbstractPageObject | Pages contain the data objects that comprise a presentation document.
  AbstractResourceEnvironmentGroupContainer | An abstract class which encapsulates the common features of Document and PageGroup resource containers
  AbstractResourceGroupContainer | An abstract container of resource objects
  AbstractStructuredObject | An abstract class encapsulating an MODCA structured object
  AbstractTripletStructuredObject | A MODCA structured object base class providing support for Triplets
  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.
  ActiveEnvironmentGroup.FontFullyQualifiedNameTriplet |
  ContainerDataDescriptor | Container data descriptor (to maintain compatibility with pre-year 2000 applications)
  Document | The document is the highest level of the MO:DCA data-stream document component hierarchy.
  GraphicsDataDescriptor | GOCA Graphics Data Descriptor
  GraphicsObject | Top-level GOCA graphics object.
  ImageDataDescriptor | ImageDataDescriptor
  ImageObject | An IOCA Image Data Object
  IMImageObject | An IM image data object specifies the contents of a raster image and its placement on a page, overlay, or page segment.
  IncludedResourceObject | Encapsulates an included resource object that is loaded from an external file.
  IncludeObject | An Include Object structured field references an object on a page or overlay.
  IncludePageOverlay | The Include Page Overlay structured field references an overlay resource definition that is to be positioned on the page.
  IncludePageSegment | The Include Page Segment structured field references a page segment resource object that is to be presented on the page or overlay presentation space.
  InterchangeSet | MO:DCA Interchange Set
  InvokeMediumMap | The Invoke Medium Map structured field identifies the Medium Map that is to become active for the document.
  MapCodedFont | The Map Coded Font structured field maps a unique coded font resource local ID, which may be embedded one or more times within an object's data and descriptor, to the identifier of a coded font resource object.
  MapContainerData | The Map Container Data structured field specifies how a presentation data object that is carried in an Object Container is mapped into its object area.
  MapDataResource | The Map Data Resource structured field specifies resources that are required for presentation.
  MapImageObject | The Map Image Object (MIO) structured field specifies how an image data object is mapped into its object area.
  MapPageOverlay | The Map Page Overlay structured field maps a Resource Local ID to the name of a Begin Overlay structured field.
  MapPageSegment | The Map Page Segment structured field identifies page segments that are required to present a page on a physical medium.
  NoOperation | The No Operation structured field may be used to carry comments or any other type of unarchitected data.
  ObjectAreaDescriptor | The Object Area Descriptor structured field specifies the size and attributes of an object area presentation space.
  ObjectAreaPosition | The Object Area Position structured field specifies the origin and orientation of the object area, and the origin and orientation of the object content within the object area.
  ObjectContainer | Object containers are MO:DCA objects that envelop and carry object data.
  ObjectEnvironmentGroup | An Object Environment Group (OEG) may be associated with an object and is contained within the object's begin-end envelope.
  Overlay | An overlay is a MO:DCA-P resource object.
  PageDescriptor | The Page Descriptor structured field specifies the size and attributes of a page or overlay presentation space.
  PageGroup | A page group is used in the data stream to define a named, logical grouping of sequential pages.
  PageObject | Pages contain the data objects that comprise a presentation document.
  PageSegment | A page segment is a MO:DCA-P resource object.
  PreprocessPresentationObject | The Preprocess Presentation Object structured field specifies presentation parameters for a data object that has been mapped as a resource.
  PresentationEnvironmentControl | The Presentation Environment Control structured field specifies parameters that affect the rendering of presentation data and the appearance that is to be assumed by the presentation device.
  PresentationTextData | Presentation text data contains the graphic characters and the control sequences necessary to position the characters within the object space.
  PresentationTextDescriptor | The Presentation Text Descriptor specifies the units of measure for the Presentation Text object space, the size of the Presentation Text object space, and the initial values for modal parameters, called initial text conditions.
  PresentationTextObject | The Presentation Text object is the data object used in document processing environments for representing text which has been prepared for presentation.
  Registry | MOD:CA Registry of object types
  ResourceEnvironmentGroup | A Resource Environment Group contains a set of resources for a document or for a group of pages in a document.
  ResourceGroup | A Resource Group contains a set of overlays.
  ResourceObject | This resource structured field begins an envelope that is used to carry resource objects in print-file-level (external) resource groups.
  StreamedResourceGroup | A print-file resource group
  TagLogicalElement | A Tag Logical Element structured field assigns an attribute name and an attribute value to a page or page group.
  TagLogicalElement.State | Holds the attribute state of a TLE

- Enum Summary
  Enum | Description
  --- | ---
  AxisOrientation | Represents the 4 bytes that specify the axis-area rotation reference coordinate system
  Rotation | Represents a rotation value

- Exception Summary
  Exception | Description
  --- | ---
  MaximumSizeExceededException | An exception to handle maximum sizes being exceeded.

## Package org.apache.fop.afp.modca Description

Contains a collection of AFP Mixed Object Document Content Architecture (MO:DCA) structured objects.

Copyright 1999-2022 The Apache Software Foundation. All Rights Reserved.