improved javadoc on Picture.resize()

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

diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml
index 2a1ce7d6585181a423fb4ebec50ae1816337bfd4..76c0e85563c478a5b5836d285c07832b727534fc 100644 (file)
--- a/src/documentation/content/xdocs/status.xml
+++ b/src/documentation/content/xdocs/status.xml
@@ -34,6 +34,7 @@
 
     <changes>
         <release version="3.7-SNAPSHOT" date="2010-??-??">
+          <action dev="POI-DEVELOPERS" type="fix">48415 - improved javadoc on HSSPicture.resize() </action>
            <action dev="POI-DEVELOPERS" type="add">added Ant target to install artifacts in local repository </action>
            <action dev="POI-DEVELOPERS" type="fix">48026 - fixed PageSettingsBlock to allow multiple HeaderFooterRecord records </action>
            <action dev="POI-DEVELOPERS" type="fix">48202 - fixed CellRangeUtil.mergeCellRanges to work for adjacent cell regions </action>

diff --git a/src/java/org/apache/poi/hssf/dev/BiffViewer.java b/src/java/org/apache/poi/hssf/dev/BiffViewer.java
index 7340631680f4f30fb6c14620bf1a856b9721af7a..a3b446e7216edf644b0940bbeb54e3a990410457 100644 (file)
--- a/src/java/org/apache/poi/hssf/dev/BiffViewer.java
+++ b/src/java/org/apache/poi/hssf/dev/BiffViewer.java
@@ -294,7 +294,7 @@ public final class BiffViewer {
                        boolean noint = false;
                        boolean out = false;
                        boolean rawhex = false;
-            boolean header = false;
+            boolean header = true;
                        File file = null;
                        for (int i=0; i<nArgs; i++) {
                                String arg = args[i];

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java b/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java
index 6b266a036256df1620c84385b4ee7f7e811f33b8..4aa75f875bc7cad273e14305a285d02994ba070c 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java
@@ -78,6 +78,11 @@ public final class HSSFPicture extends HSSFSimpleShape implements Picture {
 
     /**
      * Resize the image
+     * <p>
+     * Please note, that this method works correctly only for workbooks
+     * with default font size (Arial 10pt for .xls).
+     * If the default font is changed the resized image can be streched vertically or horizontally.
+     * </p>
      *
      * @param scale the amount by which image dimensions are multiplied relative to the original size.
      * <code>resize(1.0)</code> sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
@@ -103,6 +108,12 @@ public final class HSSFPicture extends HSSFSimpleShape implements Picture {
 
     /**
      * Reset the image to the original size.
+     * 
+     * <p>
+     * Please note, that this method works correctly only for workbooks
+     * with default font size (Arial 10pt for .xls).
+     * If the default font is changed the resized image can be streched vertically or horizontally.
+     * </p>
      */
     public void resize(){
         resize(1.0);

diff --git a/src/java/org/apache/poi/ss/usermodel/Picture.java b/src/java/org/apache/poi/ss/usermodel/Picture.java
index e816c9ac1563773da95f06fb2218d8022beee3e9..1959cad0ce7c782fa538a20a032e52ac793b1068 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/Picture.java
+++ b/src/java/org/apache/poi/ss/usermodel/Picture.java
@@ -25,12 +25,24 @@ public interface Picture {
 
     /**
      * Reset the image to the original size.
+     *
+     * <p>
+     * Please note, that this method works correctly only for workbooks
+     * with default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
+     * If the default font is changed the resized image can be streched vertically or horizontally.
+     * </p>
      */
     void resize();
 
     /**
      * Reset the image to the original size.
      *
+     * <p>
+     * Please note, that this method works correctly only for workbooks
+     * with default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
+     * If the default font is changed the resize() procedure can be 'off'.
+     * </p>
+     *
      * @param scale the amount by which image dimensions are multiplied relative to the original size.
      * <code>resize(1.0)</code> sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
      * <code>resize(2.0)</code> resizes to 200% of the original.

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
index 12f6b064de688961d9c5bb1c321c7bba099bce30..66a6d9c5a742e0266598304c01e33da70bdb3401 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
@@ -149,6 +149,12 @@ public final class XSSFPicture extends XSSFShape implements Picture {
 
     /**
      * Reset the image to the original size.
+     *
+     * <p>
+     * Please note, that this method works correctly only for workbooks
+     * with the default font size (Calibri 11pt for .xlsx).
+     * If the default font is changed the resized image can be streched vertically or horizontally.
+     * </p>
      */
     public void resize(){
         resize(1.0);
@@ -156,6 +162,11 @@ public final class XSSFPicture extends XSSFShape implements Picture {
 
     /**
      * Reset the image to the original size.
+     * <p>
+     * Please note, that this method works correctly only for workbooks
+     * with the default font size (Calibri 11pt for .xlsx).
+     * If the default font is changed the resized image can be streched vertically or horizontally.
+     * </p>
      *
      * @param scale the amount by which image dimensions are multiplied relative to the original size.
      * <code>resize(1.0)</code> sets the original size, <code>resize(0.5)</code> resize to 50% of the original,