package org.apache.fop.area;
import java.io.Serializable;
-
-import java.util.Collections;
-import java.util.Iterator;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.fop.traits.BorderProps;
-import org.apache.fop.util.QName;
// If the area appears more than once in the output
// or if the area has external data it is cached
/**
* Base object for all areas.
*/
-public class Area implements Serializable {
+public class Area extends AreaTreeObject implements Serializable {
// stacking directions
/**
* Stacking left to right
*/
protected Map props = null;
- /** Foreign attributes */
- protected Map foreignAttributes = null;
-
/**
* logging instance
*/
}
}
- /**
- * 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.keySet().iterator();
- while (iter.hasNext()) {
- QName qName = (QName)iter.next();
- String value = (String)atts.get(qName);
- //The casting is only to ensure type safety (too bad we can't use generics, yet)
- setForeignAttribute(qName, 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;
- }
- }
-
/** @see java.lang.Object#toString() */
public String toString() {
StringBuffer sb = new StringBuffer(super.toString());
--- /dev/null
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed 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.Map;
+
+import org.apache.fop.util.QName;
+
+/**
+ * Abstract base class for all area tree objects.
+ */
+public abstract class AreaTreeObject {
+
+ /** Foreign attributes */
+ protected Map foreignAttributes = 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.keySet().iterator();
+ while (iter.hasNext()) {
+ QName qName = (QName)iter.next();
+ String value = (String)atts.get(qName);
+ //The casting is only to ensure type safety (too bad we can't use generics, yet)
+ setForeignAttribute(qName, 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;
+ }
+ }
+
+
+}
import org.apache.fop.util.ContentHandlerFactory;
import org.apache.fop.util.ContentHandlerFactoryRegistry;
import org.apache.fop.util.DefaultErrorListener;
+import org.apache.fop.util.QName;
import org.w3c.dom.DOMImplementation;
import org.w3c.dom.Document;
import org.xml.sax.Attributes;
public void startElement(Attributes attributes) {
LineArea line = new LineArea();
+ transferForeignObjects(attributes, line);
areaStack.push(line);
}
currentPageViewport = new PageViewport(viewArea,
pageNumber, pageNumberString,
pageMaster, blank);
+ transferForeignObjects(attributes, currentPageViewport);
currentPageViewport.setKey(key);
}
}
Rectangle2D viewArea = parseRect(attributes.getValue("rect"));
rv = new RegionViewport(viewArea);
+ transferForeignObjects(attributes, rv);
rv.setClip(getAttributeAsBoolean(attributes, "clipped", false));
setAreaAttributes(attributes, rv);
setTraits(attributes, rv, SUBSET_COMMON);
RegionViewport rv = getCurrentRegionViewport();
body = new BodyRegion(Constants.FO_REGION_BODY,
regionName, rv, columnCount, columnGap);
+ transferForeignObjects(attributes, body);
body.setCTM(getAttributeAsCTM(attributes, "ctm"));
setAreaAttributes(attributes, body);
rv.setRegionReference(body);
firstFlow = false;
}
NormalFlow flow = body.getMainReference().getCurrentSpan().getCurrentFlow();
+ transferForeignObjects(attributes, flow);
setAreaAttributes(attributes, flow);
areaStack.push(flow);
}
public void startElement(Attributes attributes) {
//mainReference is created by the BodyRegion
- setAreaAttributes(attributes, getCurrentBodyRegion().getMainReference());
+ MainReference mr = getCurrentBodyRegion().getMainReference();
+ transferForeignObjects(attributes, mr);
+ setAreaAttributes(attributes, mr);
}
}
BodyRegion body = getCurrentBodyRegion();
Span span = new Span(columnCount,
body.getColumnGap(), ipd);
+ transferForeignObjects(attributes, span);
setAreaAttributes(attributes, span);
body.getMainReference().getSpans().add(span);
firstFlow = true;
private class FootnoteMaker extends AbstractMaker {
public void startElement(Attributes attributes) {
- areaStack.push(getCurrentBodyRegion().getFootnote());
+ Footnote fn = getCurrentBodyRegion().getFootnote();
+ transferForeignObjects(attributes, fn);
+ areaStack.push(fn);
}
public void endElement() {
private class BeforeFloatMaker extends AbstractMaker {
public void startElement(Attributes attributes) {
- areaStack.push(getCurrentBodyRegion().getBeforeFloat());
+ BeforeFloat bf = getCurrentBodyRegion().getBeforeFloat();
+ transferForeignObjects(attributes, bf);
+ areaStack.push(bf);
}
public void endElement() {
if (attributes.getValue("top-offset") != null) {
block.setYOffset(getAttributeAsInteger(attributes, "top-offset", 0));
}
+ transferForeignObjects(attributes, block);
setAreaAttributes(attributes, block);
setTraits(attributes, block, SUBSET_COMMON);
setTraits(attributes, block, SUBSET_BOX);
public void startElement(Attributes attributes) {
InlineParent ip = new InlineParent();
+ transferForeignObjects(attributes, ip);
ip.setOffset(getAttributeAsInteger(attributes, "offset", 0));
setAreaAttributes(attributes, ip);
setTraits(attributes, ip, SUBSET_COMMON);
public void startElement(Attributes attributes) {
InlineBlockParent ibp = new InlineBlockParent();
+ transferForeignObjects(attributes, ibp);
ibp.setOffset(getAttributeAsInteger(attributes, "offset", 0));
setAreaAttributes(attributes, ibp);
setTraits(attributes, ibp, SUBSET_COMMON);
public void endElement() {
String txt = content.toString();
Character ch = new Character(txt.charAt(0));
+ transferForeignObjects(lastAttributes, ch);
setAreaAttributes(lastAttributes, ch);
setTraits(lastAttributes, ch, SUBSET_COMMON);
setTraits(lastAttributes, ch, SUBSET_BOX);
public void startElement(Attributes attributes) {
Leader leader = new Leader();
+ transferForeignObjects(attributes, leader);
setAreaAttributes(attributes, leader);
setTraits(attributes, leader, SUBSET_COMMON);
setTraits(attributes, leader, SUBSET_BOX);
public void startElement(Attributes attributes) {
Viewport viewport = new Viewport(null);
+ transferForeignObjects(attributes, viewport);
setAreaAttributes(attributes, viewport);
setTraits(attributes, viewport, SUBSET_COMMON);
setTraits(attributes, viewport, SUBSET_BOX);
public void startElement(Attributes attributes) {
String url = attributes.getValue("url");
Image image = new Image(url);
+ transferForeignObjects(attributes, image);
setAreaAttributes(attributes, image);
setTraits(attributes, image, SUBSET_COMMON);
getCurrentViewport().setContent(image);
+ " identified to handle namespace: " + ns);
}
ForeignObject foreign = new ForeignObject(ns);
+ transferForeignObjects(attributes, foreign);
setAreaAttributes(attributes, foreign);
setTraits(attributes, foreign, SUBSET_COMMON);
getCurrentViewport().setContent(foreign);
}
}
- /*
- private class ?Maker extends AbstractMaker {
-
- public void startElement(Attributes attributes) {
- }
-
- public void endElement() {
- }
- }
- */
-
// ====================================================================
RegionViewport rv = getCurrentRegionViewport();
RegionReference reg = new RegionReference(side,
regionName, rv);
+ transferForeignObjects(attributes, reg);
reg.setCTM(getAttributeAsCTM(attributes, "ctm"));
setAreaAttributes(attributes, reg);
rv.setRegionReference(reg);
return new Rectangle2D.Double(values[0], values[1], values[2], values[3]);
}
+ private void transferForeignObjects(Attributes atts, AreaTreeObject ato) {
+ for (int i = 0, c = atts.getLength(); i < c; i++) {
+ String ns = atts.getURI(i);
+ if (ns.length() > 0) {
+ if ("http://www.w3.org/2000/xmlns/".equals(ns)) {
+ continue;
+ }
+ QName qname = new QName(ns, atts.getQName(i));
+ ato.setForeignAttribute(qname, atts.getValue(i));
+ }
+ }
+ }
+
/** @see org.xml.sax.ContentHandler#characters(char[], int, int) */
public void characters(char[] ch, int start, int length) throws SAXException {
if (delegate != null) {
* The page is cloneable so the page master can make copies of
* the top level page and regions.
*/
-public class Page implements Serializable, Cloneable {
+public class Page extends AreaTreeObject implements Serializable, Cloneable {
// contains before, start, body, end and after regions
private RegionViewport regionBefore = null;
private RegionViewport regionStart = null;
* This is the level that creates the page.
* The page (reference area) is then rendered inside the page object
*/
-public class PageViewport implements Resolvable, Cloneable {
+public class PageViewport extends AreaTreeObject implements Resolvable, Cloneable {
private Page page;
private Rectangle2D viewArea;
Page page = new Page(spm, index, pageNumberString, isBlank);
//Set unique key obtained from the AreaTreeHandler
page.getPageViewport().setKey(areaTreeHandler.generatePageViewportKey());
+ page.getPageViewport().setForeignAttributes(spm.getForeignAttributes());
cachedPages.add(page);
return page;
} catch (FOPException e) {
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.MimeConstants;
import org.apache.fop.area.Area;
+import org.apache.fop.area.AreaTreeObject;
import org.apache.fop.area.BeforeFloat;
import org.apache.fop.area.Block;
import org.apache.fop.area.BlockViewport;
}
}
- //Transfer foreign attributes
- Iterator iter = area.getForeignAttributes().entrySet().iterator();
+ transferForeignObjects(area);
+ }
+
+ private void transferForeignObjects(AreaTreeObject ato) {
+ Map prefixes = new java.util.HashMap();
+ Iterator iter = ato.getForeignAttributes().entrySet().iterator();
+ while (iter.hasNext()) {
+ Map.Entry entry = (Map.Entry)iter.next();
+ QName qname = (QName)entry.getKey();
+ prefixes.put(qname.getPrefix(), qname.getNamespaceURI());
+ addAttribute(qname, (String)entry.getValue());
+ }
+ //Namespace declarations
+ iter = prefixes.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = (Map.Entry)iter.next();
- addAttribute((QName)entry.getKey(), (String)entry.getValue());
+ String qn = "xmlns:" + (String)entry.getKey();
+ atts.addAttribute("", (String)entry.getKey(), qn,
+ CDATA, (String)entry.getValue());
}
}
if (page.isBlank()) {
addAttribute("blank", "true");
}
+ transferForeignObjects(page);
startElement("pageViewport", atts);
startElement("page");
this.hashCode = toHashString().hashCode();
}
+ /**
+ * Main constructor.
+ * @param namespaceURI the namespace URI
+ * @param qName the qualified name
+ */
+ public QName(String namespaceURI, String qName) {
+ if (qName == null) {
+ throw new NullPointerException("Parameter localName must not be null");
+ }
+ if (qName.length() == 0) {
+ throw new IllegalArgumentException("Parameter localName must not be empty");
+ }
+ this.namespaceURI = namespaceURI;
+ int p = qName.indexOf(':');
+ if (p > 0) {
+ this.prefix = qName.substring(0, p);
+ this.localName = qName.substring(p + 1);
+ } else {
+ this.prefix = null;
+ this.localName = qName;
+ }
+ this.hashCode = toHashString().hashCode();
+ }
+
/** @return the namespace URI */
public String getNamespaceURI() {
return this.namespaceURI;
-org.apache.fop.render.afp.extensions.AFPElementMapping
\ No newline at end of file
+org.apache.fop.render.afp.extensions.AFPElementMapping\r
+org.apache.fop.render.pcl.extensions.PCLElementMapping
\ No newline at end of file
writeCommand("&l" + selector + "A");
}
+ /**
+ * Selects the paper source. The parameter is usually printer-specific. Usually, "1" is the
+ * default tray, "2" is the manual paper feed, "3" is the manual envelope feed, "4" is the
+ * "lower" tray and "7" is "auto-select". Consult the technical reference for your printer
+ * for all available values.
+ * @param selector the integer representing the paper source/tray
+ * @throws IOException In case of an I/O error
+ */
+ public void selectPaperSource(int selector) throws IOException {
+ writeCommand("&l" + selector + "H");
+ }
+
/**
* Clears the horizontal margins.
* @throws IOException In case of an I/O error
import org.apache.fop.render.java2d.FontMetricsMapper;
import org.apache.fop.render.java2d.FontSetup;
import org.apache.fop.render.java2d.Java2DRenderer;
+import org.apache.fop.render.pcl.extensions.PCLElementMapping;
import org.apache.fop.traits.BorderProps;
import org.apache.fop.util.QName;
import org.apache.fop.util.UnitConv;
*/
public void renderPage(PageViewport page) throws IOException, FOPException {
saveGraphicsState();
+
+ //Paper source
+ String paperSource = page.getForeignAttributeValue(
+ new QName(PCLElementMapping.NAMESPACE, null, "paper-source"));
+ if (paperSource != null) {
+ gen.selectPaperSource(Integer.parseInt(paperSource));
+ }
+
+ //Page size
final long pagewidth = Math.round(page.getViewArea().getWidth());
final long pageheight = Math.round(page.getViewArea().getHeight());
selectPageFormat(pagewidth, pageheight);
super.renderPage(page);
+
+ //Eject page
gen.formFeed();
restoreGraphicsState();
}
import javax.xml.transform.TransformerException;
+import org.apache.xml.utils.PrefixResolver;
+import org.apache.xml.utils.PrefixResolverDefault;
import org.apache.xpath.XPathAPI;
import org.apache.xpath.objects.XObject;
import org.w3c.dom.Node;
private String expected;
private String xpath;
+ private PrefixResolver prefixResolver;
/**
* Creates a new instance
public EvalCheck(Node node) {
this.expected = node.getAttributes().getNamedItem("expected").getNodeValue();
this.xpath = node.getAttributes().getNamedItem("xpath").getNodeValue();
+ this.prefixResolver = new PrefixResolverDefault(node);
}
/** @see org.apache.fop.layoutengine.LayoutEngineCheck */
public void check(LayoutResult result) {
XObject res;
try {
- res = XPathAPI.eval(result.getAreaTree(), xpath);
+ res = XPathAPI.eval(result.getAreaTree(), xpath, prefixResolver);
} catch (TransformerException e) {
throw new RuntimeException("XPath evaluation failed: " + e.getMessage());
}
public String toString() {
return "XPath: " + xpath;
}
+
+ private class MyPrefixResolver extends PrefixResolverDefault {
+
+ public MyPrefixResolver(Node xpathExpressionContext) {
+ super(xpathExpressionContext);
+ }
+
+ }
}
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2006 The Apache Software Foundation
+
+ Licensed 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$ -->
+<testcase>
+ <info>
+ <p>
+ This test tests foreign attributes on various elements.
+ </p>
+ </info>
+ <fo>
+ <fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">
+ <fo:layout-master-set>
+ <fo:simple-page-master master-name="normal" page-width="5in" page-height="5in" fox:foo="bar">
+ <fo:region-body/>
+ </fo:simple-page-master>
+ </fo:layout-master-set>
+ <fo:page-sequence master-reference="normal">
+ <fo:flow flow-name="xsl-region-body">
+ <fo:block id="eg">
+ <fo:external-graphic src="../../resources/images/bgimg300dpi.jpg" fox:alt="description"/>
+ </fo:block>
+ <fo:block id="bl">
+ <fo:basic-link external-destination="url(http://xmlgraphics.apache.org/fop/)" fox:blah="fop">FOP</fo:basic-link>
+ </fo:block>
+ </fo:flow>
+ </fo:page-sequence>
+ </fo:root>
+ </fo>
+ <checks xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">
+ <eval expected="bar" xpath="//pageViewport[1]/@fox:foo"/>
+ <eval expected="description" xpath="//block[@prod-id='eg']//image/@fox:alt"/>
+ <!--eval expected="fop" xpath="//block[@prod-id='bl']/inlineparent/@fox:blah"/> NYI -->
+ </checks>
+</testcase>
projects / xmlgraphics-fop.git / commitdiff