blob: bab27f4111fb3705bbd9e252c99b41e191a9d4fa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.area;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.xmlgraphics.util.QName;
import org.apache.fop.fo.extensions.ExtensionAttachment;
/**
* Abstract base class for all area tree objects.
*/
public abstract class AreaTreeObject {
/** Foreign attributes */
protected Map foreignAttributes = null;
/** Extension attachments */
protected List/*<ExtensionAttachment>*/ extensionAttachments = null;
/**
* Sets a foreign attribute.
* @param name the qualified name of the attribute
* @param value the attribute value
*/
public void setForeignAttribute(QName name, String value) {
if (this.foreignAttributes == null) {
this.foreignAttributes = new java.util.HashMap();
}
this.foreignAttributes.put(name, value);
}
/**
* Set foreign attributes from a Map.
* @param atts a Map with attributes (keys: QName, values: String)
*/
public void setForeignAttributes(Map atts) {
if (atts.size() == 0) {
return;
}
Iterator iter = atts.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
String value = (String)entry.getValue();
//The casting is only to ensure type safety (too bad we can't use generics, yet)
setForeignAttribute((QName)entry.getKey(), value);
}
}
/**
* Returns the value of a foreign attribute on the area.
* @param name the qualified name of the attribute
* @return the attribute value or null if it isn't set
*/
public String getForeignAttributeValue(QName name) {
if (this.foreignAttributes != null) {
return (String)this.foreignAttributes.get(name);
} else {
return null;
}
}
/** @return the foreign attributes associated with this area */
public Map getForeignAttributes() {
if (this.foreignAttributes != null) {
return Collections.unmodifiableMap(this.foreignAttributes);
} else {
return Collections.EMPTY_MAP;
}
}
private void prepareExtensionAttachmentContainer() {
if (this.extensionAttachments == null) {
this.extensionAttachments = new java.util.ArrayList/*<ExtensionAttachment>*/();
}
}
/**
* Adds a new ExtensionAttachment instance to this page.
* @param attachment the ExtensionAttachment
*/
public void addExtensionAttachment(ExtensionAttachment attachment) {
prepareExtensionAttachmentContainer();
extensionAttachments.add(attachment);
}
/**
* Set extension attachments from a List
* @param extensionAttachments a List with extension attachments
*/
public void setExtensionAttachments(List extensionAttachments) {
prepareExtensionAttachmentContainer();
this.extensionAttachments.addAll(extensionAttachments);
}
/** @return the extension attachments associated with this area */
public List getExtensionAttachments() {
if (this.extensionAttachments != null) {
return Collections.unmodifiableList(this.extensionAttachments);
} else {
return Collections.EMPTY_LIST;
}
}
/**
* Indicates whether this area tree object has any extension attachments.
* @return true if there are extension attachments
*/
public boolean hasExtensionAttachments() {
return this.extensionAttachments != null && !this.extensionAttachments.isEmpty();
}
}
|
