Package org.apache.fop.area
Class AreaTreeObject
java.lang.Object
org.apache.fop.area.AreaTreeObject
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
Area,Page,PageSequence,PageViewport
Abstract base class for all area tree objects.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<ExtensionAttachment> Extension attachmentsForeign attributes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddExtensionAttachment(ExtensionAttachment attachment) Adds a new ExtensionAttachment instance to this page.clone()getForeignAttributeValue(org.apache.xmlgraphics.util.QName name) Returns the value of a foreign attribute on the area.booleanIndicates whether this area tree object has any extension attachments.voidsetExtensionAttachments(List<ExtensionAttachment> extensionAttachments) Set extension attachments from a ListvoidsetForeignAttribute(org.apache.xmlgraphics.util.QName name, String value) Sets a foreign attribute.voidsetForeignAttributes(Map<org.apache.xmlgraphics.util.QName, String> atts) Add foreign attributes from a Map.
-
Field Details
-
foreignAttributes
Foreign attributes -
extensionAttachments
Extension attachments
-
-
Constructor Details
-
AreaTreeObject
public AreaTreeObject()
-
-
Method Details
-
clone
- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
setForeignAttribute
Sets a foreign attribute.- Parameters:
name- the qualified name of the attributevalue- the attribute value
-
setForeignAttributes
Add foreign attributes from a Map.- Parameters:
atts- a Map with attributes (keys: QName, values: String)
-
getForeignAttributeValue
Returns the value of a foreign attribute on the area.- Parameters:
name- the qualified name of the attribute- Returns:
- the attribute value or null if it isn't set
-
getForeignAttributes
- Returns:
- the foreign attributes associated with this area
-
addExtensionAttachment
Adds a new ExtensionAttachment instance to this page.- Parameters:
attachment- the ExtensionAttachment
-
setExtensionAttachments
Set extension attachments from a List- Parameters:
extensionAttachments- a List with extension attachments
-
getExtensionAttachments
- Returns:
- the extension attachments associated with this area
-
hasExtensionAttachments
public boolean hasExtensionAttachments()Indicates whether this area tree object has any extension attachments.- Returns:
- true if there are extension attachments
-