Uses of Interface org.apache.fop.afp.Streamable (Apache FOP Core 2.11 API)
Date: 2025-04-24

## Uses of Interface
org.apache.fop.afp.Streamable

- Packages that use Streamable
  Package | Description
  --- | ---
  org.apache.fop.afp | Contains an AFP library.
  org.apache.fop.afp.goca | Contains a collection of AFP font related classes.
  org.apache.fop.afp.ioca | Contains a collection of AFP Image Object Content Architecture (IOCA) structured objects.
  org.apache.fop.afp.modca | Contains a collection of AFP Mixed Object Document Content Architecture (MO:DCA) structured objects.
  org.apache.fop.afp.modca.triplets | Contains a collection of AFP Mixed Object Document Content Architecture (MO:DCA) triplet classes.

- - ### Uses of Streamable in org.apache.fop.afp

    Classes in org.apache.fop.afp that implement Streamable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AFPStreamer` Manages the streaming of the AFP output

  - ### Uses of Streamable in org.apache.fop.afp.goca

    Classes in org.apache.fop.afp.goca that implement Streamable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractGraphicsCoord` A base class encapsulating the structure of coordinate based GOCA objects
    `class` | `AbstractGraphicsDrawingOrder` A base GOCA drawing order
    `class` | `AbstractGraphicsDrawingOrderContainer` A base container of prepared structured AFP objects
    `class` | `GraphicsAreaBegin` The beginning of a filled region (graphics area).
    `class` | `GraphicsAreaEnd` The end of a filled region (graphics area).
    `class` | `GraphicsBox` A GOCA graphics rectangular box
    `class` | `GraphicsChainedSegment` A GOCA graphics segment
    `class` | `GraphicsCharacterString` A GOCA graphics string
    `class` | `GraphicsData` A GOCA graphics data
    `class` | `GraphicsEndProlog` The end of a prolog.
    `class` | `GraphicsFillet` A GOCA graphics curved tangential line to a specified set of straight lines drawn from the given position or current position
    `class` | `GraphicsFullArc` A GOCA graphics arc (circle/ellipse)
    `class` | `GraphicsImage` A GOCA Image
    `class` | `GraphicsLine` A GOCA graphics straight line drawn from the given absolute position
    `class` | `GraphicsSetArcParameters` Sets the arc parameters for a GOCA graphics arc (circle/ellipse)
    `class` | `GraphicsSetCharacterSet` Sets the current character set (font) to be used for following graphics strings
    `class` | `GraphicsSetCurrentPosition` Sets the current painting position of the graphics object
    `class` | `GraphicsSetFractionalLineWidth` Sets the line width to use when stroking GOCA shapes (structured fields)
    `class` | `GraphicsSetLineType` Sets the value of the current line type attribute when stroking GOCA shapes (structured fields)
    `class` | `GraphicsSetLineWidth` Sets the line width to use when stroking GOCA shapes (structured fields)
    `class` | `GraphicsSetMix` Sets the foreground mix mode.
    `class` | `GraphicsSetPatternSymbol` Sets the pattern symbol to use when filling following GOCA structured fields
    `class` | `GraphicsSetProcessColor` Sets the current processing color for the following GOCA structured fields

  - ### Uses of Streamable in org.apache.fop.afp.ioca

    Classes in org.apache.fop.afp.ioca that implement Streamable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BandImage`
    `class` | `IDEStructureParameter` This class represents the IOCA IDE Structure parameter (X'9B').
    `class` | `ImageCellPosition` The IM Image Cell Position structured field specifies the placement, size, and replication of IM image cells.
    `class` | `ImageContent` An IOCA Image Content
    `class` | `ImageInputDescriptor` The IM Image Input Descriptor structured field contains the descriptor data for an IM image data object.
    `class` | `ImageOutputControl` The IM Image Output Control structured field specifies the position and orientation of the IM image object area and the mapping of the image points to presentation device pels.
    `class` | `ImageRasterData` Contains the image points that define the IM image raster pattern.
    `class` | `ImageSegment` An Image Segment is represented by a set of self-defining fields, fields that describe their own contents.
    `class` | `ImageSizeParameter` Describes the measurement characteristics of the image when it is created.
    `class` | `Tile`
    `class` | `TilePosition`
    `class` | `TileSize`
    `class` | `TileTOC`
    `class` | `TransparencyMask`

  - ### Uses of Streamable in org.apache.fop.afp.modca

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

    Methods in org.apache.fop.afp.modca with type parameters of type Streamable
    Modifier and Type | Method and Description
    --- | ---
    `protected <S extends Streamable> void` | AbstractAFPObject.`writeObjects(Collection<S> objects, OutputStream os)` Writes a collection of Streamable to the AFP Datastream.

  - ### Uses of Streamable in org.apache.fop.afp.modca.triplets

    Subinterfaces of Streamable in org.apache.fop.afp.modca.triplets
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Triplet` Triplet interface.

    Classes in org.apache.fop.afp.modca.triplets that implement Streamable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractTriplet` A simple implementation of a MOD:CA triplet
    `class` | `AttributeQualifierTriplet` The attribute qualifier triplet is used to specify a qualifier for a document attribute.
    `class` | `AttributeValueTriplet` The attribute value triplet is used to specify a value for a document attribute.
    `class` | `CommentTriplet` An inline comment triplet.
    `class` | `DescriptorPositionTriplet` Associates an ObjectAreaPosition with and ObjectAreaDescriptor structured field
    `class` | `EncodingTriplet` Represents a CCSID encoding triplet.
    `class` | `ExtendedResourceLocalIdentifierTriplet` The Extended Resource Local Identifier triplet specifies a resource type and a four byte local identifier or LID.
    `class` | `FullyQualifiedNameTriplet` A Fully Qualified Name triplet enable the identification and referencing of objects using Gloabl Identifiers (GIDs).
    `class` | `MappingOptionTriplet` Specifies the mapping of data object presentation space to object area
    `class` | `MeasurementUnitsTriplet` The Measurement Units triplet is used to specify the units of measure for a presentation space
    `class` | `ObjectAreaSizeTriplet` The Object Area Size triplet is used to specify the extent of an object area in the X and Y directions
    `class` | `ObjectByteExtentTriplet` The Object Byte Extent triplet is used to specify the number of bytes contained in an object
    `class` | `ObjectClassificationTriplet` The Object Classification is used to classify and identify object data.
    `class` | `PresentationSpaceMixingRulesTriplet` This triplet is used to specify the resulting appearance when data in a new presentation space is merged with data in an existing presentation space.
    `class` | `PresentationSpaceResetMixingTriplet` This triplet is used to specify the resulting appearance when data in a new presentation space is merged with data in an existing presentation space.
    `class` | `ResourceObjectTypeTriplet` A Resource Object Type Triplet

Copyright © 2025 Apache Software Foundation. All rights reserved.