aboutsummaryrefslogtreecommitdiffstats
path: root/poi-ooxml/src
diff options
context:
space:
mode:
authorPJ Fanning <fanningpj@apache.org>2022-07-20 13:51:17 +0000
committerPJ Fanning <fanningpj@apache.org>2022-07-20 13:51:17 +0000
commit53557251978ddb905e81063a79ea8f49d944a026 (patch)
tree054be19e76a02d2881d4b88d5b3a27fc23767803 /poi-ooxml/src
parent0704929412fe409e37c0ab8086c9ae2bdccbe827 (diff)
downloadpoi-53557251978ddb905e81063a79ea8f49d944a026.tar.gz
poi-53557251978ddb905e81063a79ea8f49d944a026.zip
[bug-55330] add getMargin(PageMargin)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1902880 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'poi-ooxml/src')
-rw-r--r--poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java18
-rw-r--r--poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java29
2 files changed, 39 insertions, 8 deletions
diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
index 264e2e51d8..b57759f447 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
@@ -774,12 +774,28 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions {
*
* @param margin which margin to get
* @return the size of the margin
+ * @deprecated use {@link #getMargin(PageMargin)}
*/
@Override
+ @Deprecated
+ @Removal(version = "7.0.0")
public double getMargin(short margin) {
return _sh.getMargin(margin);
}
+
+ /**
+ * Gets the size of the margin in inches.
+ *
+ * @param margin which margin to get
+ * @return the size of the margin
+ * @since POI 5.2.3
+ */
+ @Override
+ public double getMargin(PageMargin margin) {
+ return _sh.getMargin(margin);
+ }
+
/**
* Sets the size of the margin in inches.
*
@@ -985,7 +1001,7 @@ public class SXSSFSheet implements Sheet, OoxmlSheetExtensions {
*/
@Override
@Deprecated
- @Removal(version = "POI 7.0.0")
+ @Removal(version = "7.0.0")
public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane) {
_sh.createSplitPane(xSplitPos, ySplitPos, leftmostColumn, topRow, activePane);
}
diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index 85e46cc2e2..03c395c301 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -754,7 +754,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx
*/
@Override
@Deprecated
- @Removal(version = "POI 7.0.0")
+ @Removal(version = "7.0.0")
public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane) {
createFreezePane(xSplitPos, ySplitPos, leftmostColumn, topRow);
if (xSplitPos > 0 || ySplitPos > 0) {
@@ -1220,26 +1220,41 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet, OoxmlSheetEx
* @see Sheet#BottomMargin
* @see Sheet#HeaderMargin
* @see Sheet#FooterMargin
+ * @deprecated use {@link #getMargin(PageMargin)}
*/
@Override
+ @Deprecated
+ @Removal(version = "7.0.0")
public double getMargin(short margin) {
+ return getMargin(PageMargin.getByShortValue(margin));
+ }
+
+ /**
+ * Gets the size of the margin in inches.
+ *
+ * @param margin which margin to get
+ * @return the size of the margin
+ * @since POI 5.2.3
+ */
+ @Override
+ public double getMargin(PageMargin margin) {
if (!worksheet.isSetPageMargins()) {
return 0;
}
CTPageMargins pageMargins = worksheet.getPageMargins();
switch (margin) {
- case LeftMargin:
+ case LEFT:
return pageMargins.getLeft();
- case RightMargin:
+ case RIGHT:
return pageMargins.getRight();
- case TopMargin:
+ case TOP:
return pageMargins.getTop();
- case BottomMargin:
+ case BOTTOM:
return pageMargins.getBottom();
- case HeaderMargin:
+ case HEADER:
return pageMargins.getHeader();
- case FooterMargin:
+ case FOOTER:
return pageMargins.getFooter();
default :
throw new IllegalArgumentException("Unknown margin constant: " + margin);