moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

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

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1716048 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Javen O'Neal 2015-11-24 07:43:53 +00:00
parent 891f2d26fc
commit 8eabc4710a
6 changed files with 72 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
View File

@ -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) {
@ -1247,6 +1248,28 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet {
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
* first viewed after opening it in a viewer

20
src/java/org/apache/poi/ss/usermodel/Sheet.java
View File

@ -581,9 +581,29 @@ 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
* first viewed after opening it in a viewer

25
src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
View File

@ -776,6 +776,7 @@ 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)
@ -783,6 +784,30 @@ public class SXSSFSheet implements Sheet, Cloneable
_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
* first viewed after opening it in a viewer

3
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
View File

@ -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);

1
src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
View File

@ -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();

1
src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java
View File

@ -517,6 +517,7 @@ public final class TestHSSFSheet extends BaseTestSheet {
workbook.close();
}
@SuppressWarnings("deprecation")
@Test
public void zoom() throws IOException {
HSSFWorkbook wb = new HSSFWorkbook();