Changeset 1647 for trunk/docx4j/src/main/java

Timestamp:

08/30/11 15:53:03 (9 months ago)

Author:

jharrop

Message:

 http:// to hyperlink conversion is only done if you expressly set it.
Methods to process MDP and headers/footers.

Location:

trunk/docx4j/src/main/java/org/docx4j/model/datastorage

Files:

• BindingHandler.java (modified) (5 diffs)
• OpenDoPEHandler.java (modified) (1 diff)
• RemovalHandler.java (modified) (2 diffs)

trunk/docx4j/src/main/java/org/docx4j/model/datastorage/BindingHandler.java

@@ -9 +9 @@
 import javax.xml.bind.JAXBException;
 import javax.xml.bind.Unmarshaller;
-import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.transform.Source;
 import javax.xml.transform.Templates;
@@ -23 +22 @@
 import org.docx4j.dml.wordprocessingDrawing.Inline;
 import org.docx4j.jaxb.Context;
-import org.docx4j.jaxb.NamespacePrefixMappings;
 import org.docx4j.openpackaging.exceptions.Docx4JException;
 import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
 import org.docx4j.openpackaging.parts.CustomXmlDataStoragePart;
-import org.docx4j.openpackaging.parts.DefaultXmlPart;
 import org.docx4j.openpackaging.parts.JaxbXmlPart;
-import org.docx4j.openpackaging.parts.XmlPart;
 import org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage;
+import org.docx4j.openpackaging.parts.WordprocessingML.FooterPart;
+import org.docx4j.openpackaging.parts.WordprocessingML.HeaderPart;
 import org.docx4j.openpackaging.parts.relationships.Namespaces;
-import org.docx4j.wml.CTSimpleField;
+import org.docx4j.openpackaging.parts.relationships.RelationshipsPart;
+import org.docx4j.relationships.Relationship;
+import org.docx4j.wml.P.Hyperlink;
 import org.docx4j.wml.RPr;
-import org.docx4j.wml.P.Hyperlink;
 import org.w3c.dom.Document;
 import org.w3c.dom.DocumentFragment;
@@ -62 +61 @@
                 xPath = xPathFactory.newXPath();                
         }
+
+
+        /**
+         * Configure, how the handler handles links found in Custom XML.
+         * 
+         * If set to <code>null</code>, strings containing 'http://'
+         * are not converted to w:hyperlink. This is the default behavior.
+         * 
+         * If set to <code>true</code>, strings containing 'http://'
+         * are converted to w:hyperlink.  If you do this, you will
+         * need to post-process with RemovalHandler, since a
+         * content control with SdtPr w:dataBinding and w:text
+         * which contains a w:hyperlink will prevent Word 2007 from
+         * opening the docx.
+         * 
+         * Due to the architecture of this class, this is a static flag changing the
+         * behavior of all following calls to {@link #applyBindings}.
+         * 
+         * @param hyperlinkStyle
+         *            The style to use for hyperlinks (eg Hyperlink)
+         */
+        public static void setHyperlinkStyle (
+                        String hyperlinkStyleID) {
+                hyperlinkStyleId = hyperlinkStyleID;
+        }
+        private static String hyperlinkStyleId = null;
         
         
@@ -84 +109 @@
          */
                 
+                public static void applyBindings(WordprocessingMLPackage wordMLPackage) throws Docx4JException {
+
+                        // A component can apply in both the main document part,
+                        // and in headers/footers. See further
+                        // http://forums.opendope.org/Support-components-in-headers-footers-tp2964174p2964174.html
+                        
+                        if (hyperlinkStyleId !=null 
+                                        && wordMLPackage.getMainDocumentPart().getPropertyResolver().activateStyle(hyperlinkStyleId)) {
+                        }                       
+
+                        applyBindings(wordMLPackage.getMainDocumentPart());
+        
+                        // Add headers/footers
+                        RelationshipsPart rp = wordMLPackage.getMainDocumentPart()
+                                        .getRelationshipsPart();
+                        for (Relationship r : rp.getRelationships().getRelationship()) {
+        
+                                if (r.getType().equals(Namespaces.HEADER)) {
+                                        applyBindings((HeaderPart) rp.getPart(r));
+                                } else if (r.getType().equals(Namespaces.FOOTER)) {
+                                        applyBindings((FooterPart) rp.getPart(r));
+                                }
+                        }
+                }
+        
                 public static void applyBindings(JaxbXmlPart part) throws Docx4JException {
                         
@@ -341 +391 @@
             "<w:r>" +
             "<w:rPr>" +
-            "<w:rStyle w:val=\"Hyperlink\" />" +  // TODO: enable this style in the document!
+            "<w:rStyle w:val=\"" + hyperlinkStyleId + "\" />" +  // TODO: enable this style in the document!
             "</w:rPr>" +
             "<w:t>" + url + "</w:t>" +

trunk/docx4j/src/main/java/org/docx4j/model/datastorage/OpenDoPEHandler.java

@@ -219 +219 @@
         }
 
-        private Set<ContentAccessor> getParts(WordprocessingMLPackage srcPackage) {
+        protected static Set<ContentAccessor> getParts(WordprocessingMLPackage srcPackage) {
 
                 Set<ContentAccessor> partList = new HashSet<ContentAccessor>();

trunk/docx4j/src/main/java/org/docx4j/model/datastorage/RemovalHandler.java

@@ -37 +37 @@
 import org.docx4j.jaxb.Context;
 import org.docx4j.openpackaging.exceptions.Docx4JException;
+import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
 import org.docx4j.openpackaging.parts.JaxbXmlPart;
+import org.docx4j.openpackaging.parts.WordprocessingML.FooterPart;
+import org.docx4j.openpackaging.parts.WordprocessingML.HeaderPart;
+import org.docx4j.openpackaging.parts.relationships.Namespaces;
+import org.docx4j.openpackaging.parts.relationships.RelationshipsPart;
+import org.docx4j.relationships.Relationship;
 import org.w3c.dom.Document;
 
@@ -91 +97 @@
         }
 
+        public void removeSDTs(WordprocessingMLPackage wordMLPackage,
+                        final Quantifier quantifier, final String... keys) throws Docx4JException {
+
+                // A component can apply in both the main document part,
+                // and in headers/footers. See further
+                // http://forums.opendope.org/Support-components-in-headers-footers-tp2964174p2964174.html
+                
+
+                removeSDTs(wordMLPackage.getMainDocumentPart(), quantifier, keys);
+
+                // Add headers/footers
+                RelationshipsPart rp = wordMLPackage.getMainDocumentPart()
+                                .getRelationshipsPart();
+                for (Relationship r : rp.getRelationships().getRelationship()) {
+
+                        if (r.getType().equals(Namespaces.HEADER)) {
+                                removeSDTs((HeaderPart) rp.getPart(r), quantifier, keys);
+                        } else if (r.getType().equals(Namespaces.FOOTER)) {
+                                removeSDTs((FooterPart) rp.getPart(r), quantifier, keys);
+                        }
+                }
+        }
+        
         /**
          * Removes Structured Document Tags from a document part, preserving their