bug 59781: promote to Common SS: move PaneInformation from o.a.p.hssf.util to o.a...

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

diff --git a/src/java/org/apache/poi/hssf/model/InternalSheet.java b/src/java/org/apache/poi/hssf/model/InternalSheet.java
index 9dd03a804321f7fd94487725300d73dd5f681c57..b810eaa926fecd2c19b5fa2745e5ca246f149c80 100644 (file)
--- a/src/java/org/apache/poi/hssf/model/InternalSheet.java
+++ b/src/java/org/apache/poi/hssf/model/InternalSheet.java
@@ -70,9 +70,9 @@ import org.apache.poi.hssf.record.aggregates.RecordAggregate.PositionTrackingVis
 import org.apache.poi.hssf.record.aggregates.RecordAggregate.RecordVisitor;
 import org.apache.poi.hssf.record.aggregates.RowRecordsAggregate;
 import org.apache.poi.hssf.record.aggregates.WorksheetProtectionBlock;
-import org.apache.poi.hssf.util.PaneInformation;
 import org.apache.poi.ss.formula.FormulaShifter;
 import org.apache.poi.ss.util.CellRangeAddress;
+import org.apache.poi.ss.util.PaneInformation;
 import org.apache.poi.util.Internal;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
index f0c10efd0300d2c571f952dd9b4eacfa6be76bb3..d1de9ba7ac31df833587c866716dd2f70a11afdd 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
@@ -51,7 +51,6 @@ import org.apache.poi.hssf.record.aggregates.FormulaRecordAggregate;
 import org.apache.poi.hssf.record.aggregates.RecordAggregate.RecordVisitor;
 import org.apache.poi.hssf.record.aggregates.WorksheetProtectionBlock;
 import org.apache.poi.hssf.usermodel.helpers.HSSFRowShifter;
-import org.apache.poi.hssf.util.PaneInformation;
 import org.apache.poi.ss.SpreadsheetVersion;
 import org.apache.poi.ss.formula.FormulaShifter;
 import org.apache.poi.ss.formula.FormulaType;
@@ -70,6 +69,7 @@ import org.apache.poi.ss.util.CellAddress;
 import org.apache.poi.ss.util.CellRangeAddress;
 import org.apache.poi.ss.util.CellRangeAddressList;
 import org.apache.poi.ss.util.CellReference;
+import org.apache.poi.ss.util.PaneInformation;
 import org.apache.poi.ss.util.SSCellRange;
 import org.apache.poi.ss.util.SheetUtil;
 import org.apache.poi.util.Configurator;

diff --git a/src/java/org/apache/poi/hssf/util/PaneInformation.java b/src/java/org/apache/poi/hssf/util/PaneInformation.java
index 3ca96bab37936e26711e0112bcd5c9974cc83e50..d0382961e6b17518d3b1b4b73f4c9391e931c9e7 100644 (file)
--- a/src/java/org/apache/poi/hssf/util/PaneInformation.java
+++ b/src/java/org/apache/poi/hssf/util/PaneInformation.java
@@ -19,87 +19,12 @@ package org.apache.poi.hssf.util;
 
 /**
  * Holds information regarding a split plane or freeze plane for a sheet.
- *
+ * @deprecated POI 3.15 beta 3. Use {@link org.apache.poi.ss.util.PaneInformation} instead.
  */
-public class PaneInformation
+public class PaneInformation extends org.apache.poi.ss.util.PaneInformation
 {
-       /** Constant for active pane being the lower right*/
-    public static final byte PANE_LOWER_RIGHT = (byte)0;
-    /** Constant for active pane being the upper right*/
-    public static final byte PANE_UPPER_RIGHT = (byte)1;
-    /** Constant for active pane being the lower left*/
-    public static final byte PANE_LOWER_LEFT = (byte)2;
-    /** Constant for active pane being the upper left*/
-    public static final byte PANE_UPPER_LEFT = (byte)3;
-    
-       private short x;
-       private short y;
-       private short topRow;
-       private short leftColumn;
-       private byte activePane;
-       private boolean frozen = false;
-       
-       public PaneInformation(short x, short y, short top, short left, byte active, boolean frozen) {
-               this.x = x;
-               this.y = y;
-               this.topRow = top;
-               this.leftColumn = left;
-               this.activePane = active;
-               this.frozen = frozen;
-       }
+        public PaneInformation(short x, short y, short top, short left, byte active, boolean frozen) {
+                super(x, y, top, left, active, frozen);
+        }
 
-
-       /**
-        * Returns the vertical position of the split.
-        * @return 0 if there is no vertical spilt,
-        *         or for a freeze pane the number of columns in the TOP pane,
-        *         or for a split plane the position of the split in 1/20th of a point.
-        */
-       public short getVerticalSplitPosition() {
-         return x;
-       }
-       
-       /**
-        * Returns the horizontal position of the split.
-        * @return 0 if there is no horizontal spilt,
-        *         or for a freeze pane the number of rows in the LEFT pane,
-        *         or for a split plane the position of the split in 1/20th of a point.
-        */
-       public short getHorizontalSplitPosition() {
-         return y;
-       }
-       
-       /**
-        * For a horizontal split returns the top row in the BOTTOM pane.
-        * @return 0 if there is no horizontal split, or the top row of the bottom pane.
-        */
-       public short getHorizontalSplitTopRow() {
-         return topRow;
-       }
-       
-       /**
-        * For a vertical split returns the left column in the RIGHT pane.
-        * @return 0 if there is no vertical split, or the left column in the RIGHT pane.
-        */
-       public short getVerticalSplitLeftColumn() {
-         return leftColumn;
-       }
-       
-       /**
-        * Returns the active pane
-        * @see #PANE_LOWER_RIGHT
-        * @see #PANE_UPPER_RIGHT
-        * @see #PANE_LOWER_LEFT
-        * @see #PANE_UPPER_LEFT
-        * @return the active pane.
-        */
-       public byte getActivePane() {
-         return activePane;
-       }
-       
-       /** Returns true if this is a Freeze pane, false if it is a split pane.
-        */
-       public boolean isFreezePane() {
-               return frozen;
-       }
 }

diff --git a/src/java/org/apache/poi/ss/usermodel/Sheet.java b/src/java/org/apache/poi/ss/usermodel/Sheet.java
index 5fbdd5bc20e34d4bf8bcbfa46943a5c621dbe2cb..34521fd4372a38c847c18cd13ea53331a0329719 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/Sheet.java
+++ b/src/java/org/apache/poi/ss/usermodel/Sheet.java
@@ -22,9 +22,9 @@ import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
-import org.apache.poi.hssf.util.PaneInformation;
 import org.apache.poi.ss.util.CellAddress;
 import org.apache.poi.ss.util.CellRangeAddress;
+import org.apache.poi.ss.util.PaneInformation;
 
 /**
  * High level representation of a Excel worksheet.

diff --git a/src/java/org/apache/poi/ss/util/PaneInformation.java b/src/java/org/apache/poi/ss/util/PaneInformation.java
new file mode 100644 (file)
index 0000000..dc54b4c
--- /dev/null
+++ b/src/java/org/apache/poi/ss/util/PaneInformation.java
@@ -0,0 +1,105 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.ss.util;
+
+/**
+ * Holds information regarding a split plane or freeze plane for a sheet.
+ *
+ */
+public class PaneInformation
+{
+    /** Constant for active pane being the lower right*/
+    public static final byte PANE_LOWER_RIGHT = (byte)0;
+    /** Constant for active pane being the upper right*/
+    public static final byte PANE_UPPER_RIGHT = (byte)1;
+    /** Constant for active pane being the lower left*/
+    public static final byte PANE_LOWER_LEFT = (byte)2;
+    /** Constant for active pane being the upper left*/
+    public static final byte PANE_UPPER_LEFT = (byte)3;
+    
+       private final short x;
+       private final short y;
+       private final short topRow;
+       private final short leftColumn;
+       private final byte activePane;
+       private final boolean frozen;
+       
+       public PaneInformation(short x, short y, short top, short left, byte active, boolean frozen) {
+               this.x = x;
+               this.y = y;
+               this.topRow = top;
+               this.leftColumn = left;
+               this.activePane = active;
+               this.frozen = frozen;
+       }
+
+
+       /**
+        * Returns the vertical position of the split.
+        * @return 0 if there is no vertical spilt,
+        *         or for a freeze pane the number of columns in the TOP pane,
+        *         or for a split plane the position of the split in 1/20th of a point.
+        */
+       public short getVerticalSplitPosition() {
+         return x;
+       }
+       
+       /**
+        * Returns the horizontal position of the split.
+        * @return 0 if there is no horizontal spilt,
+        *         or for a freeze pane the number of rows in the LEFT pane,
+        *         or for a split plane the position of the split in 1/20th of a point.
+        */
+       public short getHorizontalSplitPosition() {
+         return y;
+       }
+       
+       /**
+        * For a horizontal split returns the top row in the BOTTOM pane.
+        * @return 0 if there is no horizontal split, or the top row of the bottom pane.
+        */
+       public short getHorizontalSplitTopRow() {
+         return topRow;
+       }
+       
+       /**
+        * For a vertical split returns the left column in the RIGHT pane.
+        * @return 0 if there is no vertical split, or the left column in the RIGHT pane.
+        */
+       public short getVerticalSplitLeftColumn() {
+         return leftColumn;
+       }
+       
+       /**
+        * Returns the active pane
+        * @see #PANE_LOWER_RIGHT
+        * @see #PANE_UPPER_RIGHT
+        * @see #PANE_LOWER_LEFT
+        * @see #PANE_UPPER_LEFT
+        * @return the active pane.
+        */
+       public byte getActivePane() {
+         return activePane;
+       }
+       
+       /** Returns true if this is a Freeze pane, false if it is a split pane.
+        */
+       public boolean isFreezePane() {
+               return frozen;
+       }
+}

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 a6f31a55540541d26924a10fe9a335473412f15b..d87d4d9b622444f7553a230974221e01d2bb91f6 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
@@ -26,7 +26,6 @@ import java.util.Map;
 import java.util.Set;
 import java.util.TreeMap;
 
-import org.apache.poi.hssf.util.PaneInformation;
 import org.apache.poi.ss.SpreadsheetVersion;
 import org.apache.poi.ss.usermodel.AutoFilter;
 import org.apache.poi.ss.usermodel.Cell;
@@ -44,6 +43,7 @@ import org.apache.poi.ss.usermodel.SheetConditionalFormatting;
 import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.ss.util.CellAddress;
 import org.apache.poi.ss.util.CellRangeAddress;
+import org.apache.poi.ss.util.PaneInformation;
 import org.apache.poi.ss.util.SheetUtil;
 import org.apache.poi.util.Internal;
 import org.apache.poi.util.NotImplemented;

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 8df7b42a6e2f0a9e0ec1570315069af116d425e8..53beb9c505a397fba5bdcb0c377c34c299fbd2a8 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -43,7 +43,7 @@ import javax.xml.namespace.QName;
 
 import org.apache.poi.POIXMLDocumentPart;
 import org.apache.poi.POIXMLException;
-import org.apache.poi.hssf.util.PaneInformation;
+
 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
 import org.apache.poi.openxml4j.exceptions.PartAlreadyExistsException;
 import org.apache.poi.openxml4j.opc.PackagePart;
@@ -71,6 +71,7 @@ import org.apache.poi.ss.util.CellAddress;
 import org.apache.poi.ss.util.CellRangeAddress;
 import org.apache.poi.ss.util.CellRangeAddressList;
 import org.apache.poi.ss.util.CellReference;
+import org.apache.poi.ss.util.PaneInformation;
 import org.apache.poi.ss.util.SSCellRange;
 import org.apache.poi.ss.util.SheetUtil;
 import org.apache.poi.util.Beta;

diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java
index 5f99cfb4a37358c6fa3d131872477f4412ef047f..4a1e02bc48b158afab2c63636181483e09ddf3d8 100644 (file)
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java
@@ -18,10 +18,10 @@
 package org.apache.poi.ss.usermodel;
 
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
-import org.apache.poi.hssf.util.PaneInformation;
 import org.apache.poi.ss.ITestDataProvider;
 import org.apache.poi.ss.SpreadsheetVersion;
 import org.apache.poi.ss.util.CellRangeAddress;
+import org.apache.poi.ss.util.PaneInformation;
 import org.apache.poi.ss.util.SheetUtil;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;

diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheet.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheet.java
index 9bfabf2ea404388c1083092cb46f3292929b2330..9d3b345599d7798631b023a53d6eeff35dbfaad3 100644 (file)
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheet.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheet.java
@@ -39,11 +39,11 @@ import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
 
-import org.apache.poi.hssf.util.PaneInformation;
 import org.apache.poi.ss.ITestDataProvider;
 import org.apache.poi.ss.SpreadsheetVersion;
 import org.apache.poi.ss.util.CellAddress;
 import org.apache.poi.ss.util.CellRangeAddress;
+import org.apache.poi.ss.util.PaneInformation;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;