blob: 681b996e452607c6474314d9f5c89032e6265416 (
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* 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.render.intermediate;
import java.util.Collections;
import java.util.Locale;
import java.util.Map;
import org.apache.xmlgraphics.util.QName;
import org.apache.fop.accessibility.StructureTreeElement;
import org.apache.fop.apps.FOUserAgent;
/**
* This class provides a context object that is valid for a single processing run to create
* an output file using the intermediate format. It allows access to the user agent and other
* context information, such as foreign attributes for certain elements in the intermediate
* format.
* <p>
* Foreign attributes are usually specific to a particular output format implementation. Most
* implementations will just ignore all foreign attributes for most elements. That's why the
* main IF interfaces are not burdened with this.
*/
public class IFContext {
private FOUserAgent userAgent;
/** foreign attributes: Map<QName, Object> */
private Map foreignAttributes = Collections.EMPTY_MAP;
private Locale language;
private StructureTreeElement structureTreeElement;
private String id = "";
/**
* Main constructor.
* @param ua the user agent
*/
public IFContext(FOUserAgent ua) {
setUserAgent(ua);
}
/**
* Set the user agent.
* @param ua the user agent
*/
public void setUserAgent(FOUserAgent ua) {
if (this.userAgent != null) {
throw new IllegalStateException("The user agent was already set");
}
this.userAgent = ua;
}
/**
* Returns the associated user agent.
* @return the user agent
*/
public FOUserAgent getUserAgent() {
return this.userAgent;
}
/**
* Returns the currently applicable foreign attributes.
* @return a Map<QName, Object>
*/
public Map getForeignAttributes() {
return this.foreignAttributes;
}
/**
* Returns a foreign attribute.
* @param qName the qualified name of the foreign attribute
* @return the value of the foreign attribute or null if the attribute isn't specified
*/
public Object getForeignAttribute(QName qName) {
return this.foreignAttributes.get(qName);
}
/**
* Sets the currently applicable foreign attributes.
* @param foreignAttributes a Map<QName, Object> or null to reset
*/
public void setForeignAttributes(Map foreignAttributes) {
if (foreignAttributes != null) {
this.foreignAttributes = foreignAttributes;
} else {
//Make sure there is always at least an empty map so we don't have to check
//in the implementation code
this.foreignAttributes = Collections.EMPTY_MAP;
}
}
/**
* Resets the foreign attributes to "no foreign attributes".
*/
public void resetForeignAttributes() {
setForeignAttributes(null);
}
/**
* Sets the currently applicable language.
* @param lang the language
*/
public void setLanguage(Locale lang) {
this.language = lang;
}
/**
* Returns the currently applicable language.
* @return the language (or null if the language is undefined)
*/
public Locale getLanguage() {
return this.language;
}
/**
* Sets the structure tree element to which the subsequently painted marks
* will correspond. This method is used when accessibility features are
* enabled.
*
* @param structureTreeElement the structure tree element
*/
public void setStructureTreeElement(StructureTreeElement structureTreeElement) {
this.structureTreeElement = structureTreeElement;
}
/**
* Resets the current structure tree element.
* @see #setStructureTreeElement(StructureTreeElement)
*/
public void resetStructureTreeElement() {
setStructureTreeElement(null);
}
/**
* Returns the current structure tree element.
* @return the structure tree element (or null if no element is active)
* @see #setStructureTreeElement(StructureTreeElement)
*/
public StructureTreeElement getStructureTreeElement() {
return this.structureTreeElement;
}
/**
* Sets the ID of the object enclosing the content that will follow.
*
* @param id the ID of the nearest ancestor object for which the id property was set
*/
void setID(String id) {
assert id != null;
this.id = id;
}
/**
* Returns the ID of the object enclosing the current content.
*
* @return the ID of the nearest ancestor object for which the id property was set
*/
String getID() {
return id;
}
}
|
