Package org.apache.fop.afp.modca
Class TagLogicalElement
- java.lang.Object
-
- org.apache.fop.afp.modca.AbstractAFPObject
-
- org.apache.fop.afp.modca.AbstractStructuredObject
-
- org.apache.fop.afp.modca.AbstractTripletStructuredObject
-
- org.apache.fop.afp.modca.TagLogicalElement
-
- All Implemented Interfaces:
Streamable
public class TagLogicalElement extends AbstractTripletStructuredObject
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 Modifier and Type Class Description static class
TagLogicalElement.State
Holds the attribute state of a TLE-
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
-
Field Summary
Fields Modifier and Type Field Description private TagLogicalElement.State
state
the params of the TLE-
Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
triplets
-
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
-
Constructor Summary
Constructors Constructor Description TagLogicalElement(TagLogicalElement.State state)
Construct a tag logical element with the name and value specified.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
setAttributeQualifier(int seqNumber, int levNumber)
Sets the attribute qualifier of this structured fieldprivate void
setAttributeValue(java.lang.String value)
private void
setEncoding(int encoding)
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.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets
-
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeContent, writeEnd, writeStart
-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, copySF, truncate, writeChunksToStream, writeObjects
-
-
-
-
Field Detail
-
state
private TagLogicalElement.State state
the params of the TLE
-
-
Constructor Detail
-
TagLogicalElement
public TagLogicalElement(TagLogicalElement.State state)
Construct a tag logical element with the name and value specified.- Parameters:
state
- the state of the tag logical element
-
-
Method Detail
-
setAttributeValue
private void setAttributeValue(java.lang.String value)
-
setEncoding
private void setEncoding(int encoding)
-
setAttributeQualifier
public void setAttributeQualifier(int seqNumber, int levNumber)
Sets the attribute qualifier of this structured field- Parameters:
seqNumber
- the attribute sequence numberlevNumber
- the attribute level number
-
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- Specified by:
writeToStream
in interfaceStreamable
- Overrides:
writeToStream
in classAbstractStructuredObject
- Parameters:
os
- the outputsteam stream- Throws:
java.io.IOException
- an I/O exception of some sort has occurred.
-
-