Changeset 1754 for trunk

Timestamp:

01/24/12 01:35:16 (4 months ago)

Author:

jharrop

Message:

Improvements to indentation (direct indent values are given priority over values in numbering, which in turn is given priority over values in styles), plus associated unit tests.

Location:

trunk/docx4j/src

Files:

• main/java/org/docx4j/convert/out/html/AbstractHtmlExporter.java (modified) (3 diffs)
• main/java/org/docx4j/model/ImmutablePropertyResolver.java (modified) (1 diff)
• main/java/org/docx4j/model/PropertyResolver.java (modified) (6 diffs)
• main/java/org/docx4j/model/properties/PropertyFactory.java (modified) (2 diffs)
• main/java/org/docx4j/openpackaging/parts/WordprocessingML/NumberingDefinitionsPart.java (modified) (2 diffs)
• test/java/org/docx4j/model/listnumbering/IndentationTest.java (added)
• test/java/org/docx4j/model/listnumbering/NumberingIndents-OUT.docx (added)
• test/java/org/docx4j/model/listnumbering/NumberingIndents.docx (added)

trunk/docx4j/src/main/java/org/docx4j/convert/out/html/AbstractHtmlExporter.java

@@ -12 +12 @@
 import org.apache.log4j.Logger;
 import org.docx4j.UnitsOfMeasurement;
+import org.docx4j.XmlUtils;
 import org.docx4j.convert.out.AbstractConversionSettings;
 import org.docx4j.convert.out.Output;
@@ -157 +158 @@
          */
     public static DocumentFragment getNumberXmlNode(WordprocessingMLPackage wmlPackage,
+                NodeIterator pPrNodeIt,
                 String pStyleVal, String numId, String levelId) {
         
@@ -199 +201 @@
 //              }
                         
-                        NumberingDefinitionsPart ndp = wmlPackage.getMainDocumentPart().getNumberingDefinitionsPart();
-                        Ind ind = ndp.getInd(numId, levelId);
-                        if (ind!=null && ind.getHanging()!=null) {
-                                String hanging = UnitsOfMeasurement.twipToBest(ind.getHanging().intValue());
-                                styleVal="position: absolute; left:-" + hanging + "; max-width: " + hanging +";";                                                       
+                PPr pPr = null;
+                if (pPrNodeIt!=null) {
+                        Node n = pPrNodeIt.nextNode();
+                        if (n!=null) {
+                                        log.debug( XmlUtils.w3CDomNodeToString(n) );
+                                Unmarshaller u = Context.jc.createUnmarshaller();                       
+                                u.setEventHandler(new org.docx4j.jaxb.JaxbValidationEventHandler());
+                                pPr = (PPr)u.unmarshal(n);
+                        }
+                }   
+                        if (pPr.getInd()==null) {
+                        
+                                NumberingDefinitionsPart ndp = wmlPackage.getMainDocumentPart().getNumberingDefinitionsPart();
+                                Ind ind = ndp.getInd(numId, levelId);
+                                if (ind!=null && ind.getHanging()!=null) {
+                                        String hanging = UnitsOfMeasurement.twipToBest(ind.getHanging().intValue());
+                                        styleVal="position: absolute; left:-" + hanging + "; max-width: " + hanging +";";                                                       
+                                }
+                                // TODO: position bullets correctly where there is no hanging
+                                // TODO: The suff element tells us what separates the number from
+                                // the text (tab, space or nothing).  If its a tab,
+                                // we'll need to know the tab values here. Currently, we're 
+                                // assuming hanging overrides all that.
+                        } else {
+                                
+                                Ind ind = pPr.getInd();
+                                if (ind!=null && ind.getHanging()!=null) {
+                                        String hanging = UnitsOfMeasurement.twipToBest(ind.getHanging().intValue());
+                                        styleVal="position: absolute; left:-" + hanging + "; max-width: " + hanging +";";                                                       
+                                }
+                                
                         }
-                        // TODO: position bullets correctly where there is no hanging
-                        // TODO: The suff element tells us what separates the number from
-                        // the text (tab, space or nothing).  If its a tab,
-                        // we'll need to know the tab values here. Currently, we're 
-                        // assuming hanging overrides all that.
                         
                 // Set the font

trunk/docx4j/src/main/java/org/docx4j/model/ImmutablePropertyResolver.java

@@ -24 +24 @@
         }
 
-        public ImmutablePropertyResolver(StyleDefinitionsPart styleDefinitionsPart,
-                        ThemePart themePart,
-                        NumberingDefinitionsPart numberingDefinitionsPart)
-                        throws Docx4JException {
-                super(styleDefinitionsPart, themePart, numberingDefinitionsPart);
-        }
+//      public ImmutablePropertyResolver(StyleDefinitionsPart styleDefinitionsPart,
+//                      ThemePart themePart,
+//                      NumberingDefinitionsPart numberingDefinitionsPart)
+//                      throws Docx4JException {
+//              super(styleDefinitionsPart, themePart, numberingDefinitionsPart);
+//      }
 
         protected void applyPPr(PPr src, PPr dest) {

trunk/docx4j/src/main/java/org/docx4j/model/PropertyResolver.java

@@ -17 +17 @@
 import org.docx4j.model.properties.PropertyFactory;
 import org.docx4j.model.properties.paragraph.AbstractParagraphProperty;
+import org.docx4j.model.properties.paragraph.Indent;
 import org.docx4j.model.properties.run.AbstractRunProperty;
 import org.docx4j.openpackaging.exceptions.Docx4JException;
@@ -107 +108 @@
         private StyleDefinitionsPart styleDefinitionsPart;
         
+        private WordprocessingMLPackage wordMLPackage;
         
         /**
@@ -133 +135 @@
         public PropertyResolver(WordprocessingMLPackage wordMLPackage) throws Docx4JException {
                 
+                this.wordMLPackage = wordMLPackage;
+                
                 MainDocumentPart mdp = wordMLPackage.getMainDocumentPart();
                 
@@ -141 +145 @@
         }
         
-        public PropertyResolver(StyleDefinitionsPart styleDefinitionsPart,
-                                                        ThemePart themePart,
-                                                        NumberingDefinitionsPart numberingDefinitionsPart) throws Docx4JException {
-                
-                this.styleDefinitionsPart= styleDefinitionsPart;
-                this.themePart = themePart;
-                this.numberingDefinitionsPart = numberingDefinitionsPart;
-                init();
-        }
+//      public PropertyResolver(StyleDefinitionsPart styleDefinitionsPart,
+//                                                      ThemePart themePart,
+//                                                      NumberingDefinitionsPart numberingDefinitionsPart) throws Docx4JException {
+//              
+//              this.styleDefinitionsPart= styleDefinitionsPart;
+//              this.themePart = themePart;
+//              this.numberingDefinitionsPart = numberingDefinitionsPart;
+//              init();
+//      }
         
         String defaultParagraphStyleId;  // "Normal" in English, but ...
@@ -918 +922 @@
         protected void applyPPr(PPr pPrToApply, PPr effectivePPr) {
                 
+                log.debug( "apply " + XmlUtils.marshaltoString(pPrToApply,  true, true)
+                + "\n\r to " + XmlUtils.marshaltoString(effectivePPr,  true, true) );
+                
                 if (pPrToApply==null) {
                         return;
                 }
                 
-        List<Property> properties = PropertyFactory.createProperties(null, pPrToApply); // wmlPackage null
-        
+        List<Property> properties = PropertyFactory.createProperties(wordMLPackage, pPrToApply); 
         for( Property p :  properties ) {
                         if (p!=null) {
@@ -931 +937 @@
         }
 
-
+                log.debug( "result " + XmlUtils.marshaltoString(effectivePPr,  true, true) );
+        
         }
         

trunk/docx4j/src/main/java/org/docx4j/model/properties/PropertyFactory.java

@@ -25 +25 @@
 
 import org.apache.log4j.Logger;
+import org.docx4j.XmlUtils;
 import org.docx4j.model.properties.paragraph.Indent;
 import org.docx4j.model.properties.paragraph.Justification;
@@ -396 +397 @@
 //              if (pPr.getMirrorIndents() != null)
 //                      dest.setMirrorIndents(pPr.getMirrorIndents());
-                Ind ind = null;
-                if (pPr.getNumPr() != null) {
+                
+                /*
+                 * Where a p has indentation specified by both w:numPr and direct w:ind, eg:
+                 *  
+                    <w:p>
+                      <w:pPr>
+                        <w:numPr>
+                          <w:ilvl w:val="0"/>
+                          <w:numId w:val="2"/>
+                        </w:numPr>
+                        <w:ind w:left="0" w:firstLine="0"/>
+                      </w:pPr>
+
+                        we want to ensure that the direct values are given effect.
+                        
+                        ie indent on direct pPr trumps indent in pPr in numbering, which trumps indent
+                        specified in a style.  
+
+                 */
+                Indent indent = null; 
+                boolean numberingIndent = false;
+                if (pPr.getNumPr() == null) {
+                        log.debug("No numPr.. ") ;                                                                      
+                } else {
                         // Numbering is mostly handled directly in the HTML & PDF stylesheets                   
                         properties.add(new NumberingProperty(pPr.getNumPr()));
-                        // but we do want to override w:ind above
-                        if (pPr.getNumPr()!=null) {
-                                if (wmlPackage instanceof WordprocessingMLPackage) {
-                                        NumberingDefinitionsPart ndp = ((WordprocessingMLPackage)wmlPackage).getMainDocumentPart().getNumberingDefinitionsPart();
-                    if (ndp != null) {
-                                        ind = ndp.getInd(pPr.getNumPr());
-                                        if (ind!=null) {
-                                                properties.add(new Indent(ind));                        
+                        // but we do want to get w:ind (in case not set elsewhere)
+                        if (wmlPackage instanceof WordprocessingMLPackage) {
+                                NumberingDefinitionsPart ndp 
+                                        = ((WordprocessingMLPackage)wmlPackage).getMainDocumentPart().getNumberingDefinitionsPart();
+                if (ndp == null) {
+                                        log.debug("No NDP?.. ") ;                                                                       
+                } else {
+                                        Ind ind = ndp.getInd(pPr.getNumPr());
+                                        if (ind==null) {
+                                                log.debug("No Indent in numbering.. ") ;                                                
+                                        } else {
+                                                log.debug("Indent from numbering: " + XmlUtils.marshaltoString(ind,  true, true)) ; 
+                                                indent = new Indent(ind);
+                                                properties.add(indent);                 
                                                 log.debug("Using w:ind from list level");
+                                                numberingIndent = true;
                                         }
-                    }
+                }
+                        } else {
+                                log.info(wmlPackage + " " + wmlPackage.getClass().getName() ) ;
+                        }
+                }
+                
+                // Give effect to the prioritisation
+                        if (pPr.getInd() != null) {
+                                log.debug("Indent from ppr: " + XmlUtils.marshaltoString(pPr.getInd(),  true, true)) ; 
+                                if (indent!=null) {
+                                        properties.remove(indent);
                                 }
+                                properties.add(new Indent(pPr.getInd()));                       
                         }
-                }
-                if (ind==null) {
-                        if (pPr.getInd() != null)
-                                properties.add(new Indent(pPr.getInd()));                       
-                }
+                
 //              if (pPr.getOutlineLvl() != null)
 //                      dest.setOutlineLvl(pPr.getOutlineLvl());

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/WordprocessingML/NumberingDefinitionsPart.java

@@ -142 +142 @@
 
         // instantiate the list number definitions
-        //foreach (XmlNode numNode in numberNodes)
         for( Numbering.Num numNode : numbering.getNum() )
         {
@@ -235 +234 @@
                 // Operating on the docx4j.listnumbering plane,
                 // not the JAXB plane..
-                ListNumberingDefinition lnd = instanceListDefinitions.get(numId );
+                ListNumberingDefinition lnd = getInstanceListDefinitions().get(numId );
                 if (lnd==null) {
                         log.debug("couldn't find list for numId: " + numId);