bug 58642: deprecate Sheet.setZoom(numerator, denominator) and replace with Sheet.setZoom(scale)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1716048 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
891f2d26fc
commit
8eabc4710a
@ -1233,6 +1233,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet {
|
|||||||
*
|
*
|
||||||
* @param numerator The numerator for the zoom magnification.
|
* @param numerator The numerator for the zoom magnification.
|
||||||
* @param denominator The denominator 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
|
@Override
|
||||||
public void setZoom(int numerator, int denominator) {
|
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);
|
sclRecord.setDenominator((short) denominator);
|
||||||
getSheet().setSCLRecord(sclRecord);
|
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
|
* The top row in the visible view when the sheet is
|
||||||
|
@ -581,8 +581,28 @@ public interface Sheet extends Iterable<Row> {
|
|||||||
*
|
*
|
||||||
* @param numerator The numerator for the zoom magnification.
|
* @param numerator The numerator for the zoom magnification.
|
||||||
* @param denominator The denominator 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);
|
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
|
* The top row in the visible view when the sheet is
|
||||||
|
@ -776,12 +776,37 @@ public class SXSSFSheet implements Sheet, Cloneable
|
|||||||
*
|
*
|
||||||
* @param numerator The numerator for the zoom magnification.
|
* @param numerator The numerator for the zoom magnification.
|
||||||
* @param denominator The denominator 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
|
@Override
|
||||||
public void setZoom(int numerator, int denominator)
|
public void setZoom(int numerator, int denominator)
|
||||||
{
|
{
|
||||||
_sh.setZoom(numerator,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
|
* The top row in the visible view when the sheet is
|
||||||
|
@ -2620,7 +2620,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
|
|||||||
*
|
*
|
||||||
* @param numerator The numerator for the zoom magnification.
|
* @param numerator The numerator for the zoom magnification.
|
||||||
* @param denominator The denominator 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
|
@Override
|
||||||
public void setZoom(int numerator, int denominator) {
|
public void setZoom(int numerator, int denominator) {
|
||||||
@ -2647,6 +2647,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
|
|||||||
* @param scale window zoom magnification
|
* @param scale window zoom magnification
|
||||||
* @throws IllegalArgumentException if scale is invalid
|
* @throws IllegalArgumentException if scale is invalid
|
||||||
*/
|
*/
|
||||||
|
@Override
|
||||||
public void setZoom(int scale) {
|
public void setZoom(int scale) {
|
||||||
if(scale < 10 || scale > 400) throw new IllegalArgumentException("Valid scale values range from 10 to 400");
|
if(scale < 10 || scale > 400) throw new IllegalArgumentException("Valid scale values range from 10 to 400");
|
||||||
getSheetTypeSheetView().setZoomScale(scale);
|
getSheetTypeSheetView().setZoomScale(scale);
|
||||||
|
@ -408,6 +408,7 @@ public final class TestXSSFSheet extends BaseTestSheet {
|
|||||||
workbook.close();
|
workbook.close();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@SuppressWarnings("deprecation")
|
||||||
@Test(expected=IllegalArgumentException.class)
|
@Test(expected=IllegalArgumentException.class)
|
||||||
public void setZoom() throws IOException {
|
public void setZoom() throws IOException {
|
||||||
XSSFWorkbook workBook = new XSSFWorkbook();
|
XSSFWorkbook workBook = new XSSFWorkbook();
|
||||||
|
@ -517,6 +517,7 @@ public final class TestHSSFSheet extends BaseTestSheet {
|
|||||||
workbook.close();
|
workbook.close();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@SuppressWarnings("deprecation")
|
||||||
@Test
|
@Test
|
||||||
public void zoom() throws IOException {
|
public void zoom() throws IOException {
|
||||||
HSSFWorkbook wb = new HSSFWorkbook();
|
HSSFWorkbook wb = new HSSFWorkbook();
|
||||||
|
Loading…
Reference in New Issue
Block a user