Add a note about XSSF and HSSF x and y values in client anchors differing

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

diff --git a/src/java/org/apache/poi/ss/usermodel/ClientAnchor.java b/src/java/org/apache/poi/ss/usermodel/ClientAnchor.java
index a4e66635cad59b8cb64941499cd72b037267bda1..6131bf554b1af2a15cbb5f4bd6b9f807eeeb23da 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/ClientAnchor.java
+++ b/src/java/org/apache/poi/ss/usermodel/ClientAnchor.java
@@ -16,6 +16,8 @@
 ==================================================================== */
 package org.apache.poi.ss.usermodel;
 
+import org.apache.poi.xssf.usermodel.XSSFShape;
+
 /**
  * A client anchor is attached to an excel worksheet.  It anchors against a
  * top-left and bottom-right cell.
@@ -119,7 +121,11 @@ public interface ClientAnchor {
     public void setRow2(int row2);
 
     /**
-     * Returns the x coordinate within the first cell
+     * Returns the x coordinate within the first cell.
+     * 
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
      *
      * @return the x coordinate within the first cell
      */
@@ -128,6 +134,10 @@ public interface ClientAnchor {
     /**
      * Sets the x coordinate within the first cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @param dx1 the x coordinate within the first cell
      */
     public void setDx1(int dx1);
@@ -135,6 +145,10 @@ public interface ClientAnchor {
     /**
      * Returns the y coordinate within the first cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @return the y coordinate within the first cell
      */
     public int getDy1();
@@ -142,6 +156,10 @@ public interface ClientAnchor {
     /**
      * Sets the y coordinate within the first cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @param dy1 the y coordinate within the first cell
      */
     public void setDy1(int dy1);
@@ -149,6 +167,10 @@ public interface ClientAnchor {
     /**
      * Sets the y coordinate within the second cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @return the y coordinate within the second cell
      */
     public int getDy2();
@@ -156,6 +178,10 @@ public interface ClientAnchor {
     /**
      * Sets the y coordinate within the second cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @param dy2 the y coordinate within the second cell
      */
     public void setDy2(int dy2);
@@ -163,6 +189,10 @@ public interface ClientAnchor {
     /**
      * Returns the x coordinate within the second cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @return the x coordinate within the second cell
      */
     public int getDx2();
@@ -170,6 +200,10 @@ public interface ClientAnchor {
     /**
      * Sets the x coordinate within the second cell
      *
+     * Note - XSSF and HSSF have a slightly different coordinate
+     *  system, values in XSSF are larger by a factor of
+     *  {@link XSSFShape#EMU_PER_PIXEL}
+     *
      * @param dx2 the x coordinate within the second cell
      */
     public void setDx2(int dx2);