org.apache.fop.afp.modca
Class TagLogicalElement

java.lang.Object
  org.apache.fop.afp.modca.AbstractAFPObject
      org.apache.fop.afp.modca.TagLogicalElement

All Implemented Interfaces:

Streamable

public class TagLogicalElement
extends AbstractAFPObject

A Tag Logical Element structured field assigns an attribute name and an attribute value to a page or page group. The Tag Logical Element structured field may be embedded directly in the page or page group, or it may reference the page or page group from a document index. When a Tag Logical Element structured field references a page or is embedded in a page following the active environment group, it is associated with the page. When a Tag Logical Element structured field references a page group or is embedded in a page group following the Begin Named Page Group structured field, it is associated with the page group. When a Tag Logical Element structured field is associated with a page group, the parameters of the Tag Logical Element structured field are inherited by all pages in the page group and by all other page groups that are nested in the page group. The scope of a Tag Logical Element is determined by its position with respect to other TLEs that reference, or are embedded in, the same page or page group. The Tag Logical Element structured field does not provide any presentation specifications and therefore has no effect on the appearance of a document when it is presented.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject

AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary

Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject

log, SF_CLASS

Constructor Summary

TagLogicalElement(java.lang.String name, java.lang.String value, int tleID)
Construct a tag logical element with the name and value specified.

Method Summary

void	writeToStream(java.io.OutputStream os) DataStream objects must implement the writeToStream() method to write its data to the given OutputStream

Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject

copyChunks, copySF, copySF, writeChunksToStream, writeObjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagLogicalElement

public TagLogicalElement(java.lang.String name,
                         java.lang.String value,
                         int tleID)

Construct a tag logical element with the name and value specified.

Parameters:

name - the name of the tag logical element

value - the value of the tag logical element

tleID - unique identifier for TLE within AFP stream

Method Detail

writeToStream

public void writeToStream(java.io.OutputStream os)
                   throws java.io.IOException

DataStream objects must implement the writeToStream() method to write its data to the given OutputStream

Parameters:

os - the outputsteam stream

Throws:

java.io.IOException - an I/O exception of some sort has occurred.