AFPIncludeFormMapElement (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.AFPIncludeFormMapElement

All Implemented Interfaces:

java.lang.Cloneable
```
public class AFPIncludeFormMapElement
extends AbstractAFPExtensionObject
```
This class extends the org.apache.fop.fo.extensions.ExtensionObj class. It represents the "include-form-map" extension in the FO tree.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.fop.fo.FONode
  FONode.FONodeIterator, FONode.GatherContextInfoFunction

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

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

Constructors
Constructor	Description
`AFPIncludeFormMapElement(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.
`void`	`startOfNode()`	Called after processNode() is called.

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

Methods inherited from class org.apache.fop.fo.FONode
addCharacters, addChildNode, attachSiblings, bind, canHaveMarkers, characters, 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
  - AFPIncludeFormMapElement
```
public AFPIncludeFormMapElement(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
  - startOfNode
```
public void startOfNode()
                 throws FOPException
```
    Called after processNode() is called. Subclasses can do additional processing.
    
    Overrides:
    
    startOfNode in class FONode
    
    Throws:
    
    FOPException - if there's a problem during processing
  - 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 AbstractAFPExtensionObject
    
    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
    
    Specified by:
    
    instantiateExtensionAttachment in class AbstractAFPExtensionObject
    
    Returns:
    
    extension attachment

Class AFPIncludeFormMapElement

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.fo.FONode

Methods inherited from class java.lang.Object

Constructor Detail

AFPIncludeFormMapElement

Method Detail

startOfNode

processNode

instantiateExtensionAttachment