bug 58642: deprecate Sheet.setZoom(numerator, denominator) and replace with Sheet...

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

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
index 3aa609d753ea536d136f55fc8ec94644b56d2612..83003a73668710eef44ca8dcb484c387448f0f21 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
@@ -1233,6 +1233,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet {
      *
      * @param numerator   The numerator for the zoom magnification.
      * @param denominator The denominator for the zoom magnification.
+     * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead.
      */
     @Override
     public void setZoom(int numerator, int denominator) {
@@ -1246,6 +1247,28 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet {
         sclRecord.setDenominator((short) denominator);
         getSheet().setSCLRecord(sclRecord);
     }
+    
+    /**
+     * Window zoom magnification for current view representing percent values.
+     * Valid values range from 10 to 400. Horizontal & Vertical scale together.
+     *
+     * For example:
+     * <pre>
+     * 10 - 10%
+     * 20 - 20%
+     * ...
+     * 100 - 100%
+     * ...
+     * 400 - 400%
+     * </pre>
+     *
+     * @param scale window zoom magnification
+     * @throws IllegalArgumentException if scale is invalid
+     */
+    @Override
+    public void setZoom(int scale) {
+        setZoom(scale*100, 100);
+    }
 
     /**
      * The top row in the visible view when the sheet is

diff --git a/src/java/org/apache/poi/ss/usermodel/Sheet.java b/src/java/org/apache/poi/ss/usermodel/Sheet.java
index 7aaffc257589445c0999ea2441114afc98f59a88..14548bc89d9b569a878b35d8ee262d037785f00d 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/Sheet.java
+++ b/src/java/org/apache/poi/ss/usermodel/Sheet.java
@@ -581,8 +581,28 @@ public interface Sheet extends Iterable<Row> {
      *
      * @param numerator     The numerator for the zoom magnification.
      * @param denominator   The denominator for the zoom magnification.
+     * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead.
      */
     void setZoom(int numerator, int denominator);
+    
+    /**
+     * Window zoom magnification for current view representing percent values.
+     * Valid values range from 10 to 400. Horizontal & Vertical scale together.
+     *
+     * For example:
+     * <pre>
+     * 10 - 10%
+     * 20 - 20%
+     * ...
+     * 100 - 100%
+     * ...
+     * 400 - 400%
+     * </pre>
+     *
+     * @param scale window zoom magnification
+     * @throws IllegalArgumentException if scale is invalid
+     */
+    public void setZoom(int scale);
 
     /**
      * The top row in the visible view when the sheet is

diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
index 4fd9da73921016b77c44aa70fabded403fcf60f8..70a4f7f20aec493c7e440de84469a3c1d282903c 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
@@ -776,12 +776,37 @@ public class SXSSFSheet implements Sheet, Cloneable
      *
      * @param numerator     The numerator for the zoom magnification.
      * @param denominator   The denominator for the zoom magnification.
+     * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead.
      */
     @Override
     public void setZoom(int numerator, int denominator)
     {
         _sh.setZoom(numerator,denominator);
     }
+    
+    /**
+     * Window zoom magnification for current view representing percent values.
+     * Valid values range from 10 to 400. Horizontal & Vertical scale together.
+     *
+     * For example:
+     * <pre>
+     * 10 - 10%
+     * 20 - 20%
+     * ...
+     * 100 - 100%
+     * ...
+     * 400 - 400%
+     * </pre>
+     *
+     * Current view can be Normal, Page Layout, or Page Break Preview.
+     *
+     * @param scale window zoom magnification
+     * @throws IllegalArgumentException if scale is invalid
+     */
+    @Override
+    public void setZoom(int scale) {
+        _sh.setZoom(scale);
+    }
 
     /**
      * The top row in the visible view when the sheet is

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index 856b8fcc3ea5a49b788ad40e3123417bfc9f5b6b..7ffe73601408500560166510929d8ff9780bfb5b 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -2620,7 +2620,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
      *
      * @param numerator     The numerator for the zoom magnification.
      * @param denominator   The denominator for the zoom magnification.
-     * @see #setZoom(int)
+     * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead.
      */
     @Override
     public void setZoom(int numerator, int denominator) {
@@ -2647,6 +2647,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
      * @param scale window zoom magnification
      * @throws IllegalArgumentException if scale is invalid
      */
+    @Override
     public void setZoom(int scale) {
         if(scale < 10 || scale > 400) throw new IllegalArgumentException("Valid scale values range from 10 to 400");
         getSheetTypeSheetView().setZoomScale(scale);

diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheet.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
index e22f16972695c3561042459abdfba5b49af4a3eb..34e5ae49609fd9ce5881cbf58418c856cae1670b 100644 (file)
--- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
+++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
@@ -408,6 +408,7 @@ public final class TestXSSFSheet extends BaseTestSheet {
         workbook.close();
     }
 
+    @SuppressWarnings("deprecation")
     @Test(expected=IllegalArgumentException.class)
     public void setZoom() throws IOException {
         XSSFWorkbook workBook = new XSSFWorkbook();

diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java
index c7298fda21605d9fee2eebf1d85f2b96e768f333..fed4bc54669328cea91ed5fecf96d91c3e3d61e7 100644 (file)
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java
@@ -517,6 +517,7 @@ public final class TestHSSFSheet extends BaseTestSheet {
         workbook.close();
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     public void zoom() throws IOException {
         HSSFWorkbook wb = new HSSFWorkbook();