AFPPageSegmentElement (Apache FOP 2.1 API)

java.lang.Object
- org.apache.fop.fo.FONode
- - org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject
  - - org.apache.fop.render.afp.extensions.AFPPageSetupElement
    - - org.apache.fop.render.afp.extensions.AFPPageSegmentElement

All Implemented Interfaces:

java.lang.Cloneable
```
public class AFPPageSegmentElement
extends AFPPageSetupElement
```
This class extends the org.apache.fop.extensions.ExtensionObj class. The object faciliates extraction of elements from formatted objects based on the static list as defined in the AFPElementMapping implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AFPPageSegmentElement.AFPPageSegmentSetup
This is the pass-through value object for the AFP extension.
- Nested classes/interfaces inherited from class org.apache.fop.fo.FONode
  FONode.FONodeIterator, FONode.GatherContextInfoFunction

Nested Classes
Modifier and Type	Class	Description
`static class`	`AFPPageSegmentElement.AFPPageSegmentSetup`	This is the pass-through value object for the AFP extension.

Field Summary
- Fields inherited from class org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject
  extensionAttachment, name
- Fields inherited from class org.apache.fop.fo.FONode
  FO_URI, FOX_URI, locator, log, parent, siblings

Constructor Summary

Constructors
Constructor Description

AFPPageSegmentElement(FONode parent, java.lang.String name)
Constructs an AFP object (called by Maker).

Constructors
Constructor	Description
`AFPPageSegmentElement(FONode parent, java.lang.String name)`	Constructs an AFP object (called by Maker).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected ExtensionAttachment`	`instantiateExtensionAttachment()`	Instantiates extension attachment object
`void`	`processNode(java.lang.String elementName, org.xml.sax.Locator locator, org.xml.sax.Attributes attlist, PropertyList propertyList)`	Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element.

Methods inherited from class org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject
endOfNode, getExtensionAttachment, getLocalName, getNamespaceURI, getNormalNamespacePrefix, validateChildNode

Methods inherited from class org.apache.fop.render.afp.extensions.AFPPageSetupElement
characters, startOfNode

Methods inherited from class org.apache.fop.fo.FONode
addCharacters, addChildNode, attachSiblings, bind, canHaveMarkers, charIterator, clone, clone, collectDelimitedTextRanges, collectDelimitedTextRanges, createPropertyList, decorateWithContextInfo, errorText, finalizeNode, gatherContextInfo, getBuilderContext, getChildNodes, getChildNodes, getContentHandlerFactory, getContextInfo, getContextInfoAlt, getFOEventHandler, getFOValidationEventProducer, getLocator, getLocatorString, getLogger, getName, getName, getNameId, getNodePrefix, getNodeString, getParent, getRoot, getStructureTreeElement, getUserAgent, inMarker, invalidChildError, invalidChildError, invalidPropertyValueError, isBidiRangeBlockItem, isDelimitedTextRangeBoundary, missingChildElementError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, nodesOutOfOrderError, notSupportedChildError, removeChild, setLocator, setStructureTreeElement, tooManyNodesError, tooManyNodesError, tooManyNodesError, validateChildNode, warningText

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AFPPageSegmentElement
```
public AFPPageSegmentElement(FONode parent,
                             java.lang.String name)
```
    Constructs an AFP object (called by Maker).
    
    Parameters:
    
    parent - the parent formatting object
    
    name - the name of the afp element
- Method Detail
  - processNode
```
public void processNode(java.lang.String elementName,
                        org.xml.sax.Locator locator,
                        org.xml.sax.Attributes attlist,
                        PropertyList propertyList)
                 throws FOPException
```
    Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element.
    
    Overrides:
    
    processNode in class AFPPageSetupElement
    
    Parameters:
    
    elementName - element name (e.g., "fo:block")
    
    locator - Locator object (ignored by default)
    
    attlist - Collection of attributes passed to us from the parser.
    
    propertyList - the property list of the parent node
    
    Throws:
    
    FOPException - for errors or inconsistencies in the attributes
  - instantiateExtensionAttachment
```
protected ExtensionAttachment instantiateExtensionAttachment()
```
    Instantiates extension attachment object
    
    Overrides:
    
    instantiateExtensionAttachment in class AFPPageSetupElement
    
    Returns:
    
    extension attachment

Class AFPPageSegmentElement

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.fo.FONode

Field Summary

Fields inherited from class org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject

Fields inherited from class org.apache.fop.fo.FONode

Constructor Summary

Method Summary

Methods inherited from class org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject

Methods inherited from class org.apache.fop.render.afp.extensions.AFPPageSetupElement

Methods inherited from class org.apache.fop.fo.FONode

Methods inherited from class java.lang.Object

Constructor Detail

AFPPageSegmentElement

Method Detail

processNode

instantiateExtensionAttachment