From bug #44254 - avoid some unread bytes warnings, and process the contents of DVALRecord

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

src/documentation/content/xdocs/changes.xml

@@ -36,6 +36,7 @@
 
 		<!-- Don't forget to update status.xml too! -->
         <release version="3.0.2-FINAL" date="2008-??-??">
+            <action dev="POI-DEVELOPERS" type="fix">44254 - Avoid some unread byte warnings, and properly understand DVALRecord</action>
             <action dev="POI-DEVELOPERS" type="add">Add another formula evaluation method, evaluateFormulaCell(cell), which will re-calculate the value for a formula, without affecting the formula itself.</action>
             <action dev="POI-DEVELOPERS" type="fix">41726 - Fix how we handle signed cell offsets in relative areas and references</action>
             <action dev="POI-DEVELOPERS" type="add">44233 - Support for getting and setting a flag on the sheet, which tells excel to re-calculate all formulas on it at next reload</action>

src/documentation/content/xdocs/status.xml

@@ -33,6 +33,7 @@
 	<!-- Don't forget to update changes.xml too! -->
     <changes>
         <release version="3.0.2-FINAL" date="2008-??-??">
+            <action dev="POI-DEVELOPERS" type="fix">44254 - Avoid some unread byte warnings, and properly understand DVALRecord</action>
             <action dev="POI-DEVELOPERS" type="add">Add another formula evaluation method, evaluateFormulaCell(cell), which will re-calculate the value for a formula, without affecting the formula itself.</action>
             <action dev="POI-DEVELOPERS" type="fix">41726 - Fix how we handle signed cell offsets in relative areas and references</action>
             <action dev="POI-DEVELOPERS" type="add">44233 - Support for getting and setting a flag on the sheet, which tells excel to re-calculate all formulas on it at next reload</action>

src/java/org/apache/poi/hssf/record/DVALRecord.java

@@ -29,19 +29,22 @@ import org.apache.poi.util.LittleEndian;
 
 public class DVALRecord extends Record
 {
-    public final static short sid = 0x01B2;
+	public final static short sid = 0x01B2;
 
-    //unknown field ; it's size should be 10
+	/** Options of the DVAL */
-    private short field_unknown     = 0x0000;
+	private short field_1_options;
+	/** Horizontal position of the dialog */
+	private int field_2_horiz_pos;
+	/** Vertical position of the dialog */
+	private int field_3_vert_pos;
 
-    //Object ID of the drop down arrow object for list boxes ;
+	/** Object ID of the drop down arrow object for list boxes ;
-    //in our case this will be always FFFF , until
+	 * in our case this will be always FFFF , until
-    //MSODrawingGroup and MSODrawing records are implemented
+	 * MSODrawingGroup and MSODrawing records are implemented */
-    private int  field_cbo_id      = 0xFFFFFFFF;
+	private int  field_cbo_id      = 0xFFFFFFFF;
 
-    //Number of following DV records
+	/** Number of following DV Records */
-    //Default value is 1
+	private int  field_5_dv_no     = 0x00000000;
-    private int  field_3_dv_no     = 0x00000000;
 
     public DVALRecord()
     {
@@ -66,17 +69,38 @@ public class DVALRecord extends Record
         }
     }
 
-    protected void fillFields(RecordInputStream in)
+	protected void fillFields(RecordInputStream in)
-    {
+	{
-        for ( int i=0; i<5; i++)
+		this.field_1_options = in.readShort();
-        {
+		this.field_2_horiz_pos = in.readInt();
-        	this.field_unknown = in.readShort();
+		this.field_3_vert_pos = in.readInt();
-        }
         this.field_cbo_id    = in.readInt(); 
-        this.field_3_dv_no   = in.readInt();
+        this.field_5_dv_no   = in.readInt();
-    }
+	}
+
 
     /**
+	 * @param field_1_options the options of the dialog
+	 */
+	public void setOptions(short field_1_options) {
+		this.field_1_options = field_1_options;
+	}
+
+	/**
+	 * @param field_2_horiz_pos the Horizontal position of the dialog
+	 */
+	public void setHorizontalPos(int field_2_horiz_pos) {
+		this.field_2_horiz_pos = field_2_horiz_pos;
+	}
+
+	/**
+	 * @param field_3_vert_pos the Vertical position of the dialog
+	 */
+	public void setVerticalPos(int field_3_vert_pos) {
+		this.field_3_vert_pos = field_3_vert_pos;
+	}
+
+	/**
      * set the object ID of the drop down arrow object for list boxes
      * @param cboID - Object ID
      */
@@ -91,10 +115,33 @@ public class DVALRecord extends Record
      */
     public void setDVRecNo(int dvNo)
     {
-        this.field_3_dv_no = dvNo;
+        this.field_5_dv_no = dvNo;
     }
 
+    
+    
     /**
+	 * @return the field_1_options
+	 */
+	public short getOptions() {
+		return field_1_options;
+	}
+
+	/**
+	 * @return the Horizontal position of the dialog
+	 */
+	public int getHorizontalPos() {
+		return field_2_horiz_pos;
+	}
+
+	/**
+	 * @return the the Vertical position of the dialog
+	 */
+	public int getVerticalPos() {
+		return field_3_vert_pos;
+	}
+
+	/**
      * get Object ID of the drop down arrow object for list boxes
      */
     public int getObjectID( )
@@ -107,29 +154,32 @@ public class DVALRecord extends Record
      */
     public int getDVRecNo( )
     {
-        return this.field_3_dv_no;
+        return this.field_5_dv_no;
     }
 
 
-    public String toString()
+	public String toString()
-    {
+	{
-        StringBuffer buffer = new StringBuffer();
+		StringBuffer buffer = new StringBuffer();
 
-        buffer.append("[DVAL]\n");
+		buffer.append("[DVAL]\n");
-        buffer.append("    .comboObjectID   = ").append(Integer.toHexString(this.getObjectID())).append("\n");
+		buffer.append("    .options      = ").append(this.getOptions()).append('\n');
-        buffer.append("    .DVRecordsNumber = ").append(Integer.toHexString(this.getDVRecNo())).append("\n");
+		buffer.append("    .horizPos     = ").append(this.getHorizontalPos()).append('\n');
-        buffer.append("[/DVAL]\n");
+		buffer.append("    .vertPos      = ").append(this.getVerticalPos()).append('\n');
-        return buffer.toString();
+		buffer.append("    .comboObjectID   = ").append(Integer.toHexString(this.getObjectID())).append("\n");
-    }
+		buffer.append("    .DVRecordsNumber = ").append(Integer.toHexString(this.getDVRecNo())).append("\n");
+		buffer.append("[/DVAL]\n");
+		return buffer.toString();
+	}
 
     public int serialize(int offset, byte [] data)
     {
         LittleEndian.putShort(data, 0 + offset, this.sid);
         LittleEndian.putShort(data, 2 + offset, ( short)(this.getRecordSize()-4));
-        for ( int i=0; i<5; i++)
+		
-        {
+		LittleEndian.putShort(data, 4 + offset, this.getOptions());
-          LittleEndian.putShort(data, 4 + i*2 + offset, (short)this.field_unknown);
+		LittleEndian.putInt(data, 6 + offset, this.getHorizontalPos());
-        }
+		LittleEndian.putInt(data, 10 + offset, this.getVerticalPos());
         LittleEndian.putInt(data, 14 + offset, this.getObjectID());
         LittleEndian.putInt(data, 18 + offset, this.getDVRecNo());
         return getRecordSize();
@@ -149,9 +199,11 @@ public class DVALRecord extends Record
     public Object clone()
     {
       DVALRecord rec = new DVALRecord();
-      rec.field_unknown = this.field_unknown;
+      rec.field_1_options = field_1_options;
+      rec.field_2_horiz_pos = field_2_horiz_pos;
+      rec.field_3_vert_pos = field_3_vert_pos;
       rec.field_cbo_id = this.field_cbo_id;
-      rec.field_3_dv_no = this.field_3_dv_no;
+      rec.field_5_dv_no = this.field_5_dv_no;
       return rec;
     }
 }

src/java/org/apache/poi/hssf/record/UncalcedRecord.java

@@ -55,6 +55,7 @@ public class UncalcedRecord extends Record
 	}
 
 	protected void fillFields(RecordInputStream in) {
+		short unused = in.readShort();
 	}
 
 	public String toString() {

src/java/org/apache/poi/hssf/record/formula/ErrPtg.java

@@ -29,7 +29,7 @@ import org.apache.poi.hssf.usermodel.HSSFErrorConstants;
 public class ErrPtg extends Ptg
 {
     public static final short sid  = 0x1c;
-    private static final int  SIZE = 7;
+    private static final int  SIZE = 2;
     private byte              field_1_error_code;
 
     /** Creates new ErrPtg */