rename PAP structure fields according to specification

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1142864 13f79535-47bb-0310-9956-ffa450edef68

src/scratchpad/src/org/apache/poi/hwpf/sprm/ParagraphSprmCompressor.java

@@ -17,13 +17,12 @@
 
 package org.apache.poi.hwpf.sprm;
 
-import java.util.List;
 import java.util.ArrayList;
 import java.util.Arrays;
-
+import java.util.List;
-import org.apache.poi.util.LittleEndian;
 
 import org.apache.poi.hwpf.usermodel.ParagraphProperties;
+import org.apache.poi.util.LittleEndian;
 
 public final class ParagraphSprmCompressor
 {
@@ -363,10 +362,10 @@ public final class ParagraphSprmCompressor
       // sprmPNumRM
       size += SprmUtils.addSprm((short)0xC645, 0, newPAP.getNumrm(), sprmList);
     }
-    if (newPAP.getEmbeddedCellMark() != oldPAP.getEmbeddedCellMark())
+    if (newPAP.getFInnerTableCell() != oldPAP.getFInnerTableCell())
     {
       // sprmPFInnerTableCell
-      size += SprmUtils.addSprm((short)0x244b, newPAP.getEmbeddedCellMark(), null, sprmList);
+      size += SprmUtils.addSprm((short)0x244b, newPAP.getFInnerTableCell(), null, sprmList);
     }
     if (newPAP.getFTtpEmbedded() != oldPAP.getFTtpEmbedded())
     {
@@ -375,10 +374,10 @@ public final class ParagraphSprmCompressor
     }
 
     // Page 55 of public specification begins
-    if (newPAP.getTableLevel() != oldPAP.getTableLevel())
+    if (newPAP.getItap() != oldPAP.getItap())
     {
       // sprmPItap
-      size += SprmUtils.addSprm((short)0x6649, newPAP.getTableLevel(), null, sprmList);
+      size += SprmUtils.addSprm((short)0x6649, newPAP.getItap(), null, sprmList);
     }
 
     return SprmUtils.getGrpprl(sprmList, size);

src/scratchpad/src/org/apache/poi/hwpf/sprm/ParagraphSprmUncompressor.java

@@ -17,21 +17,21 @@
 
 package org.apache.poi.hwpf.sprm;
 
-import org.apache.poi.hwpf.usermodel.ParagraphProperties;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+
 import org.apache.poi.hwpf.usermodel.BorderCode;
 import org.apache.poi.hwpf.usermodel.DateAndTime;
-import org.apache.poi.hwpf.usermodel.LineSpacingDescriptor;
-import org.apache.poi.hwpf.usermodel.ShadingDescriptor;
 import org.apache.poi.hwpf.usermodel.DropCapSpecifier;
+import org.apache.poi.hwpf.usermodel.LineSpacingDescriptor;
+import org.apache.poi.hwpf.usermodel.ParagraphProperties;
+import org.apache.poi.hwpf.usermodel.ShadingDescriptor;
 import org.apache.poi.util.LittleEndian;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
 
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.Collections;
-import java.util.ArrayList;
-
 public final class ParagraphSprmUncompressor
   extends SprmUncompressor
 {
@@ -192,9 +192,10 @@ public final class ParagraphSprmUncompressor
         // fast saved only
         //applySprmPChgTabs (newPAP, varParam, opSize);
         break;
-      case 0x16:
+        case 0x16:
-        newPAP.setFInTable ((byte) sprm.getOperand());
+            // sprmPFInTable -- 0x2416
-        break;
+            newPAP.setFInTable( (byte) sprm.getOperand() );
+            break;
       case 0x17:
         newPAP.setFTtp ((byte) sprm.getOperand());
         break;
@@ -392,15 +393,22 @@ public final class ParagraphSprmUncompressor
       case 0x48:
         newPAP.setFAdjustRight ((byte) sprm.getOperand());
         break;
-      case 0x49:
+        case 0x49:
-        newPAP.setTableLevel((byte)sprm.getOperand());
+            // sprmPItap -- 0x6649
-        break;
+            newPAP.setItap( sprm.getOperand() );
-      case 0x4b:
+            break;
-        newPAP.setEmbeddedCellMark((byte)sprm.getOperand());
+        case 0x4a:
-        break;
+            // sprmPDtap -- 0x664a
-      case 0x4c:
+            newPAP.setItap( (byte) ( newPAP.getItap() + sprm.getOperand() ) );
-        newPAP.setFTtpEmbedded((byte)sprm.getOperand());
+            break;
-        break;
+        case 0x4b:
+            // sprmPFInnerTableCell -- 0x244b
+            newPAP.setFInnerTableCell( (byte) sprm.getOperand() );
+            break;
+        case 0x4c:
+            // sprmPFInnerTtp -- 0x244c
+            newPAP.setFTtpEmbedded( (byte) sprm.getOperand() );
+            break;
       case 0x61:
         // sprmPJc 
         newPAP.setJustificationLogical((byte) sprm.getOperand());

src/scratchpad/src/org/apache/poi/hwpf/usermodel/Paragraph.java

@@ -131,12 +131,12 @@ public class Paragraph extends Range implements Cloneable {
 
   public int getTableLevel()
   {
-    return _props.getTableLevel();
+    return _props.getItap();
   }
 
   public boolean isEmbeddedCellMark()
   {
-    return _props.getEmbeddedCellMark() != 0;
+    return _props.getFInnerTableCell() != 0;
   }
 
   public int getJustification()

src/scratchpad/src/org/apache/poi/hwpf/usermodel/Range.java

@@ -649,7 +649,7 @@ public class Range { // TODO -instantiable superclass
 	public Table insertBefore(TableProperties props, int rows) {
 		ParagraphProperties parProps = new ParagraphProperties();
 		parProps.setFInTable((byte) 1);
-		parProps.setTableLevel((byte) 1);
+		parProps.setItap( 1 );
 
 		int columns = props.getItcMac();
 		for (int x = 0; x < rows; x++) {

src/types/definitions/pap_type.xml

@@ -96,9 +96,11 @@
         <field type="byte" size="1" name="fUsePgsuSettings"/>
         <field type="byte" size="1" name="fAdjustRight"/>
 
-        <!-- itap? -->
+        <field type="int" size="4" name="itap" description="Table nesting level"/>
-        <!-- fInnerTableCell? -->
+        <field type="byte" size="1" name="fInnerTableCell" description="When 1, the end of paragraph mark is really an end of cell mark for a nested table cell"/>
-        <!-- fOpenTch? -->
+        <field type="byte" size="1" name="fOpenTch" description="Ensure the Table Cell char doesn't show up as zero height"/>
+        <!-- not part of properties structure, but used anyway. See sprmPFInnerTtp doc. -->
+        <field type="byte" size="1" name="fTtpEmbedded" description="Word 97 compatibility indicates this end of paragraph mark is really an end of row marker for a nested table."/>
         
         <field type="short" size="2" name="dxcRight" description="Right indent in character units"/>
         <field type="short" size="2" name="dxcLeft" description="Left indent in character units"/>
@@ -134,10 +136,5 @@
         <field type="byte[]" size="128" name="rgtbd"/>
         <field type="byte[]" size="128" name="numrm"/>
         <field type="byte[]" size="4" name="ptap"/>
-
-        <!-- Unknown old fields -->
-        <field type="byte" size="1" name="tableLevel"/>
-        <field type="byte" size="1" name="fTtpEmbedded"/>
-        <field type="byte" size="1" name="embeddedCellMark"/>
     </fields>
 </record>