@@ -30,27 +43,17 @@
http://starter.io
-
- https://bitbucket.org/openxls/openxls
- scm:git:ssh://git@bitbucket.org/openxls/openxls.git
- master
-
-
-
- log4j
- log4j
-
-
- log4j
- log4j
- 1.2.16
-
+
org.json
json
- 20090211
+ 20180813
@@ -65,6 +68,17 @@
4.10
test
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-jdk8
+ ${kotlin.version}
+
+
+ org.jetbrains.kotlin
+ kotlin-test
+ ${kotlin.version}
+ test
+
@@ -75,21 +89,7 @@
1.2.1
-
-
- false
- ${basedir}/src/main/resources
-
-
-
- true
- ${basedir}/src/main/resources
-
- io/starter/OpenXLS/build.properties
-
-
-
@@ -118,14 +118,22 @@
-
+
+ maven-surefire-plugin
+
+
+ ${exclude.tests}
+
+ alphabetical
+
+
org.apache.maven.plugins
maven-compiler-plugin
2.5.1
- 1.5
- 1.5
+ 1.8
+ 1.8
@@ -139,7 +147,7 @@
- com/extench/profiling/**/*
+ io/starter/profiling/**/*
**/*$*
@@ -148,10 +156,64 @@
+
+ org.jetbrains.kotlin
+ kotlin-maven-plugin
+ ${kotlin.version}
+
+
+ compile
+ compile
+
+ compile
+
+
+
+ test-compile
+ test-compile
+
+ test-compile
+
+
+
+
+ 1.8
+
+
+
+
+ false
+ ${basedir}/src/main/resources
+
+
+
+
+ true
+ ${basedir}/src/main/resources
+
+ io/starter/OpenXLS/build.properties
+
+
+
+
+
+ mac-profile
+
+ true
+
+ ${java.home}/../lib/tools.jar
+
+
+
+ ${java.home}/../lib/tools.jar
+
+
+
+
release
@@ -212,22 +274,30 @@
-
+
+
- repo.starter.io
+ snapshot.repo.starter.io
s3://repo.starter.io/snapshot
- repo.starter.io
+ release.repo.starter.io
s3://repo.starter.io/release
+
- repo.starter.io
+ snapshot.repo.starter.io
+ s3://repo.starter.io/snapshot
+
+
+ release.repo.starter.io
s3://repo.starter.io/release
+
+
diff --git a/src/main/java/io/starter/OpenXLS/AutoFilterHandle.java b/src/main/java/io/starter/OpenXLS/AutoFilterHandle.java
deleted file mode 100644
index 14e11d7..0000000
--- a/src/main/java/io/starter/OpenXLS/AutoFilterHandle.java
+++ /dev/null
@@ -1,248 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- *
- * Object value can be of type
- *
- * String
- * String operator may be one of: "=", ">", ">=", "<>", "<", "<="
- *
- * @param Object
- * val - value to set
- * @param String
- * op - operator
- * @see setVal2
- */
- public void setVal(Object val, String op) {
- if (af != null)
- af.setVal(val, op);
- }
-
- /**
- * Sets the custom comparison of the second condition of this AutoFilter via a
- * String operator and an Object value
- * Only those rows that meet the equation:
- * Object value can be of type
- *
- * String
- * String operator may be one of: "=", ">", ">=", "<>", "<", "<="
- *
- * @param Object
- * val - value to set
- * @param String
- * op - operator
- * @param boolean
- * AND - true if two conditions should be AND'ed, false if OR'd
- * @see setVal2
- */
- public void setVal2(Object val, String op, boolean AND) {
- if (af != null)
- af.setVal2(val, op, AND);
- }
-
- /**
- * returns the String representation of the comparison value for this
- * AutoFilter, if any
- *
- * http://java.sun.com/docs/books/tutorial/i18n/format/decimalFormat.html
- * Starter Inc.
- *
- */
-public class CellComparator implements Comparator {
-
- /**
- * Compare 2 cellHandle classes
- *
- * This method handles comparisons of cells, note that formula results are used
- * rather than formula strings, Numbers are sorted ahead of string values. Dates
- * are stored as numbers internally in excel so are sorted against numbers
- *
- */
- public int compare(Object cellHandle1, Object cellHandle2) {
- CellHandle cell1 = (CellHandle) cellHandle1;
- CellHandle cell2 = (CellHandle) cellHandle2;
-
- int cellType1 = cell1.getCellType();
- int cellType2 = cell1.getCellType();
-
- // numerics - possibly break out more to see if values are floating point or
- // not.
- // would help for equality, which is likely never reached here.
- if (cell1.isNumber() && cell2.isNumber()) {
- if (cell1.getDoubleVal() > cell2.getDoubleVal())
- return 1;
- if (cell1.getDoubleVal() < cell2.getDoubleVal())
- return -1;
- return 0;
- } else if (cell1.isNumber()) {// get formula value if exists and is a numeric value
- if (cellType2 == CellHandle.TYPE_FORMULA) {
- FormulaHandle f = null;
- try {
- f = cell2.getFormulaHandle();
- } catch (FormulaNotFoundException e) {
- }
- Double d = f.getDoubleVal();
- if (!(d == Double.NaN)) {
- if (cell1.getDoubleVal() > d)
- return 1;
- if (cell1.getDoubleVal() < d)
- return -1;
- return 0;
- }
- } else {
- return 1;
- }
- } else if (cell2.isNumber()) {
- if (cellType1 == CellHandle.TYPE_FORMULA) {
- FormulaHandle f = null;
- try {
- f = cell1.getFormulaHandle();
- } catch (FormulaNotFoundException e) {
- }
- Double d = f.getDoubleVal();
- if (!(d == Double.NaN)) {
- if (cell2.getDoubleVal() < d)
- return 1;
- if (cell2.getDoubleVal() > d)
- return -1;
- return 0;
- }
- } else {
- return -1;
- }
- }
-
- // Two formulas;
- if (cellType1 == CellHandle.TYPE_FORMULA && cellType2 == CellHandle.TYPE_FORMULA) {
- try {
- FormulaHandle f1 = cell1.getFormulaHandle();
- FormulaHandle f2 = cell2.getFormulaHandle();
- double d1 = f1.getDoubleVal();
- double d2 = f2.getDoubleVal();
- if (!(d1 == Double.NaN) && !(d2 == Double.NaN)) {
- if (d1 > d2)
- return 1;
- if (d1 < d2)
- return -1;
- return 0;
- } else if (!(d1 == Double.NaN)) {
- return 1;
- } else if (!(d2 == Double.NaN)) {
- return -1;
- }
- } catch (FormulaNotFoundException e) {
- }
- }
-
- // Strings, the last choice
- String val1 = cell1.getStringVal();
- String val2 = cell2.getStringVal();
- return val1.compareTo(val2);
- }
-
-}
diff --git a/src/main/java/io/starter/OpenXLS/CellComparator.kt b/src/main/java/io/starter/OpenXLS/CellComparator.kt
new file mode 100644
index 0000000..5bacbf4
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/CellComparator.kt
@@ -0,0 +1,128 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ * {
+
+ /**
+ * Compare 2 cellHandle classes
+ *
+ *
+ * This method handles comparisons of cells, note that formula results are used
+ * rather than formula strings, Numbers are sorted ahead of string values. Dates
+ * are stored as numbers internally in excel so are sorted against numbers
+ */
+ override fun compare(cellHandle1: Any, cellHandle2: Any): Int {
+ val cell1 = cellHandle1 as CellHandle
+ val cell2 = cellHandle2 as CellHandle
+
+ val cellType1 = cell1.cellType
+ val cellType2 = cell1.cellType
+
+ // numerics - possibly break out more to see if values are floating point or
+ // not.
+ // would help for equality, which is likely never reached here.
+ if (cell1.isNumber && cell2.isNumber) {
+ if (cell1.doubleVal > cell2.doubleVal)
+ return 1
+ return if (cell1.doubleVal < cell2.doubleVal) -1 else 0
+ } else if (cell1.isNumber) {// get formula value if exists and is a numeric value
+ if (cellType2 == CellHandle.TYPE_FORMULA) {
+ var f: FormulaHandle? = null
+ try {
+ f = cell2.formulaHandle
+ } catch (e: FormulaNotFoundException) {
+ }
+
+ val d = f!!.doubleVal
+ if (d != java.lang.Double.NaN) {
+ if (cell1.doubleVal > d)
+ return 1
+ return if (cell1.doubleVal < d) -1 else 0
+ }
+ } else {
+ return 1
+ }
+ } else if (cell2.isNumber) {
+ if (cellType1 == CellHandle.TYPE_FORMULA) {
+ var f: FormulaHandle? = null
+ try {
+ f = cell1.formulaHandle
+ } catch (e: FormulaNotFoundException) {
+ }
+
+ val d = f!!.doubleVal
+ if (d != java.lang.Double.NaN) {
+ if (cell2.doubleVal < d)
+ return 1
+ return if (cell2.doubleVal > d) -1 else 0
+ }
+ } else {
+ return -1
+ }
+ }
+
+ // Two formulas;
+ if (cellType1 == CellHandle.TYPE_FORMULA && cellType2 == CellHandle.TYPE_FORMULA) {
+ try {
+ val f1 = cell1.formulaHandle
+ val f2 = cell2.formulaHandle
+ val d1 = f1.doubleVal
+ val d2 = f2.doubleVal
+ if (d1 != java.lang.Double.NaN && d2 != java.lang.Double.NaN) {
+ if (d1 > d2)
+ return 1
+ return if (d1 < d2) -1 else 0
+ } else if (d1 != java.lang.Double.NaN) {
+ return 1
+ } else if (d2 != java.lang.Double.NaN) {
+ return -1
+ }
+ } catch (e: FormulaNotFoundException) {
+ }
+
+ }
+
+ // Strings, the last choice
+ val val1 = cell1.stringVal
+ val val2 = cell2.stringVal
+ return val1!!.compareTo(val2!!)
+ }
+
+}
diff --git a/src/main/java/io/starter/OpenXLS/CellHandle.java b/src/main/java/io/starter/OpenXLS/CellHandle.java
deleted file mode 100644
index b89f64e..0000000
--- a/src/main/java/io/starter/OpenXLS/CellHandle.java
+++ /dev/null
@@ -1,3066 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- * WorkBookHandle book = newWorkBookHandle("testxls.xls"); With a CellHandle you can:Starter Inc.
- *
- * @see WorkBookHandle
- * @see WorkSheetHandle
- * @see FormulaHandle
- * @see CellNotFoundException
- * @see CellTypeMismatchException
- */
-public class CellHandle implements Cell, Serializable, Handle, Comparable {
-
- /**
- *
- *
- */
- private static final long serialVersionUID = 4737120893891570607L;
- /**
- * Cell types
- */
- public static final int TYPE_BLANK = Cell.TYPE_BLANK;
- public static final int TYPE_STRING = Cell.TYPE_STRING;
- public static final int TYPE_FP = Cell.TYPE_FP;
- public static final int TYPE_INT = Cell.TYPE_INT;
- public static final int TYPE_FORMULA = Cell.TYPE_FORMULA;
- public static final int TYPE_BOOLEAN = Cell.TYPE_BOOLEAN;
- public static final int TYPE_DOUBLE = Cell.TYPE_DOUBLE;
- public static final int NOTATION_STANDARD = 0, NOTATION_SCIENTIFIC = 1, NOTATION_SCIENTIFIC_EXCEL = 2;
-
- private transient WorkBook wbh = null;
- private transient WorkSheetHandle wsh = null;
- private ColHandle mycol;
- private RowHandle myrow;
- private FormatHandle formatter;
- // reusing or creating new xfs is handled in FormatHandle/cloneXf and
- // updateXf
- // boolean useExistingXF = !false;
- private boolean DEBUG = false;
- private XLSRecord mycell;
-
- /**
- * returns the underlying BIFF8 record for the Cell Microsoft KB264372 .
- *
- * @param pat
- * the Excel number format pattern to apply
- * @see FormatConstantsImpl#getBuiltinFormats
- */
- public void setFormatPattern(String pat) {
- setFormatHandle();
- formatter.setFormatPattern(pat);
- }
-
- /**
- * Gets the number format pattern for this cell, if set. For more information on
- * number format patterns see
- * Microsoft KB264372 .
- *
- * @return the Excel number format pattern for this cell or null if
- * none is applied
- */
- public String getFormatPattern() {
- if (this.getFont() == null)
- return "";
- return mycell.getFormatPattern();
- }
-
- /**
- * Returns whether this Cell has Date formatting applied. ftmap = new HashMap();
- // implement underlines
- try {
- if (this.getIsUnderlined()) {
- ftmap.put(java.awt.font.TextAttribute.UNDERLINE, java.awt.font.TextAttribute.UNDERLINE);
- }
- } catch (Exception e) {
- ;
- }
- // Ahhh, much cooler fonts here!
- ftmap.put(java.awt.font.TextAttribute.FAMILY, fface);
- float fx = this.getFontWeight();
- ftmap.put(java.awt.font.TextAttribute.SIZE, new Float(sz));
- // TODO: Interpret other weights- LIGHT, DEMI_LIGHT, DEMI_BOLD, etc.
- if (fx == FormatHandle.BOLD)
- ftmap.put(java.awt.font.TextAttribute.WEIGHT, java.awt.font.TextAttribute.WEIGHT_BOLD);
- else
- ftmap.put(java.awt.font.TextAttribute.WEIGHT, java.awt.font.TextAttribute.WEIGHT_REGULAR);
- return new java.awt.Font(ftmap);
- }
-
- /**
- * Set the Font for this Cell via font name, font style and font size "String"
- * "Float"
- * "Integer"
- * "Formula"
- * "Double"
- *
- * @return String java data type
- */
- public String getCellTypeName() {
- String typename = "Object";
- int tp = getCellType();
- switch (tp) {
- case XLSConstants.TYPE_BLANK:
- typename = "String";
- break;
- case XLSConstants.TYPE_STRING:
- typename = "String";
- break;
- case XLSConstants.TYPE_FP:
- typename = "Float";
- break;
- case XLSConstants.TYPE_INT:
- typename = "Integer";
- break;
- case XLSConstants.TYPE_FORMULA:
- typename = "Formula";
- break;
- case XLSConstants.TYPE_DOUBLE:
- typename = "Double";
- break;
- }
- return typename;
- }
-
- /**
- * Returns the type of the Cell as an int TYPE_STRING = 0,
- * TYPE_FP = 1,
- * TYPE_INT = 2,
- * TYPE_FORMULA = 3,
- * TYPE_BOOLEAN = 4,
- * TYPE_DOUBLE = 5;
- *
- * @return int type for this Cell
- */
- public int getCellType() {
- return mycell.getCellType();
- }
-
- /**
- * return the underlying cell record Microsoft KB264372 .
- *
- * @return the value of the cell as a string formatted according to the cell
- * type and, if present, the number format pattern
- */
- public String getFormattedStringVal() {
- FormatHandle myfmt = this.getFormatHandle();
- return CellFormatFactory.fromPatternString(myfmt.getFormatPattern()).format(this);
- }
-
- /**
- * Gets the value of the cell as a String with the number format applied.
- * Boolean cell types will return "true" or "false". Custom number formats are
- * not currently supported, although they will be written correctly to the
- * output file. Patterns that display negative numbers in red are not currently
- * supported; the number will be prefixed with a minus sign instead. For more
- * information on number format patterns see
- * Microsoft KB264372 .
- *
- * @param formatForXML
- * if true non-compliant characters will be properly qualified
- * @return the value of the cell as a string formatted according to the cell
- * type and, if present, the number format pattern
- */
- public String getFormattedStringVal(boolean formatForXML) {
- FormatHandle myfmt = this.getFormatHandle();
- String val = this.getVal().toString();
- if (formatForXML)
- val = io.starter.formats.XLS.OOXMLAdapter.stripNonAscii(val).toString();
- return CellFormatFactory.fromPatternString(myfmt.getFormatPattern()).format(val);
- }
-
- /**
- * Returns the value of the Cell as a String. CellHandle.NOTATION_STANDARD e.g. "8002974342"
- * CellHandle.NOTATION_SCIENTIFIC e.g. "8.002974342E9"
- * CellHandle.NOTATION_SCIENTIFIC_EXCEL e.g. "8.002974342+E9" cfhandles = new ArrayList();
- for (int i = 0; i < cfs.length; i++) {
- if (cfs[i].contains(this))
- cfhandles.add(cfs[i]);
- }
- ConditionalFormatHandle[] c = new ConditionalFormatHandle[cfhandles.size()];
- return (ConditionalFormatHandle[]) cfhandles.toArray(c);
- }
-
- /**
- * Gets the FormatHandle (a Format Object describing the formats for this Cell)
- * for this Cell.
- *
- * @return FormatHandle for this Cell
- */
- public FormatHandle getFormatHandle() {
- if (this.formatter == null)
- this.setFormatHandle();
-
- return this.formatter;
- }
-
- /**
- * locks or unlocks this Cell for editing
- *
- * @param boolean
- * locked - true if Cell should be locked, false otherwise
- */
- public void setLocked(boolean locked) {
- // create a new xf for this
- // this causes formats to be lost this.useExistingXF = false;
- getFormatHandle().setLocked(locked);
- }
-
- /**
- * Hides or shows the formula for this Cell, if present
- *
- * @param boolean
- * hidden - setting whether to hide or show formulas for this Cell
- */
- public void setFormulaHidden(boolean hidden) {
- // create a new xf for this
- // this causes formats to be lost this.useExistingXF = false;
- getFormatHandle().setFormulaHidden(hidden);
- }
-
- /**
- * Sets the FormatHandle (a Format Object describing the formats for this Cell)
- * for this Cell
- *
- * @param FormatHandle
- * to apply to this Cell
- * @see FormatHandle
- */
- public void setFormatHandle(FormatHandle f) {
- f.addCell(this.mycell);
- this.formatter = f;
- }
-
- /**
- * Sets the Formatting record ID (FormatId) for this Cell
- *
- * This can be used with 'getFormatId()' to copy the formatting from one Cell to
- * another (ie: a template cell to a new cell)
- *
- * @param int
- * i - the new index to the Format for this Cell
- */
- public void setFormatId(int i) {
- mycell.setXFRecord(i);
- }
-
- /**
- * Resets this cell's format to the default.
- */
- public void clearFormats() {
- this.setFormatId(this.getWorkBook().getWorkBook().getDefaultIxfe());
- }
-
- /**
- * Resets this cells contents to blank.
- */
- public void clearContents() {
- this.setVal(null);
- }
-
- /**
- * Resets this cell to the default, as if it had just been added.
- */
- public void clear() {
- this.clearFormats();
- this.clearContents();
- }
-
- /**
- * Returns the Formula Handle (an Object describing a Formula) for this Cell, if
- * it contains a formula
- *
- * @return FormulaHandle the Formula of the Cell
- * @see FormulaHandle
- * @exception FormulaNotFoundException
- */
- public FormulaHandle getFormulaHandle() throws FormulaNotFoundException {
- Formula f = mycell.getFormulaRec();
- if (f == null) {
- throw new FormulaNotFoundException("No Formula for: " + getCellAddress());
- }
- FormulaHandle fh = new FormulaHandle(f, this.wbh);
- return fh;
- }
-
- /**
- * Returns the Hyperlink URL String for this Cell, if any
- *
- * @return String URL if this Cell contains a hyperlink
- */
- public String getURL() {
- if (mycell.hyperlink != null)
- return mycell.hyperlink.getURL();
- return null;
- }
-
- /**
- * Returns the URL Description String for this Cell, if any
- *
- * @return String URL Description, if this Cell contains a hyperlink
- */
- public String getURLDescription() {
- if (mycell.hyperlink != null)
- return mycell.hyperlink.getDescription();
- return "";
- }
-
- /**
- * returns true if this Cell contains a hyperlink
- *
- * @return boolean true if this Cell contains a hyperlink
- */
- public boolean hasHyperlink() {
- return (mycell.hyperlink != null);
- }
-
- /**
- * Creates a new Hyperlink for this Cell from a URL String. Can be any valid
- * URL. This URL String must include the protocol. ");
- if (typename.equals("DateTime")) {
- retval.append(DateConverter.getFormattedDateVal(this));
- } else if (this.getCellType() == CellHandle.TYPE_STRING) {
- val = this.getStringVal(); // (String)getVal();
- if (val.equals("")) { // 20070216 KSC: John, had the same edits,
- // seems to work well in cursory tests ...
- // retval.append(" "); does this screw up formulas expecting
- // empty strings? -jm
- } else {
- retval.append(StringTool.convertXMLChars(val.toString()));
- }
- } else {
- try {
- // if(val == null)
- val = this.getVal();
- retval.append(StringTool.convertXMLChars(val.toString()) + vl);
- } catch (Exception e) {
- Logger.logErr("CellHandle.getXML failed for: " + this.getCellAddress() + " in: "
- + this.getWorkBook().toString(), e);
- retval.append("XML ERROR!");
- }
- }
- retval.append(" ");
- retval.append(end_cell_xml);
- } else {
- int c = ((Mulblank) this.mycell).getColFirst();
- int lastcol = ((Mulblank) this.mycell).getColLast();
- for (; c <= lastcol; c++) {
- mulblankcolnum = (short) c;
- // Put the style ID in
- sv = " StyleID=\"s" + getFormatId() + "\"";
- if (this.getCol().isHidden()) {
- hd = " Hidden=\"true\"";
- }
- // TODO: HRefScreenTip ????
- if (this.getURL() != null) {
- hlink = " HRef=\"" + StringTool.convertXMLChars(this.getURL()) + "\"";
- }
-
- // put the date formattingin
- // Assemble the string
- retval.append(" | ";
-
- static final String begin_cell_xml = " | ";
- static final String end_cell_xml = " | ";
-
- /**
- * Returns an xml representation of an empty cell
- *
- * @param loc
- * - the cell address
- * @param isVisible
- * - if the cell is visible (not hidden)
- * @return
- */
- protected static String getEmptyCellXML(String loc, boolean isVisible) {
- if (!isVisible) {
- return begin_hidden_emptycell_xml + loc + end_hidden_emptycell_xml;
- } else {
- return begin_cell_xml + loc + end_emptycell_xml;
- }
- }
-
- /**
- * Calculates and returns all formulas that reference this CellHandle. calculateAffectedCells() {
- ReferenceTracker rt = this.wbh.getWorkBook().getRefTracker();
- Iterator its = rt.clearAffectedFormulaCells(this).values().iterator();
-
- List ret = new ArrayList();
- while (its.hasNext()) {
- CellHandle cx = new CellHandle((BiffRec) its.next(), this.wbh);
- ret.add(cx);
- }
- return ret;
- }
-
- /**
- * Internal method for clearing affected cells, does the same thing as
- * calculateAffectedCells, but does not create a list
- */
- protected void clearAffectedCells() {
- ReferenceTracker rt = this.wbh.getWorkBook().getRefTracker();
- rt.clearAffectedFormulaCells(this);
- }
-
- /**
- * Calculates and returns all formulas on the same sheet that reference this
- * CellHandle. calculateAffectedCellsOnSheet() {
- Iterator its = this.wbh.getWorkBook().getRefTracker()
- .clearAffectedFormulaCellsOnSheet(this, this.getWorkSheetName()).values().iterator();
- List ret = new ArrayList();
- while (its.hasNext()) {
- CellHandle cx = new CellHandle((BiffRec) its.next(), this.wbh);
- ret.add(cx);
- }
- return ret;
- }
-
- /**
- * flags chart references to the particular cell as dirty/ needing caches
- * rebuilt
- */
- public void clearChartReferences() {
- ArrayList ret = new ArrayList();
- Iterator ii = this.wbh.getWorkBook().getRefTracker().getChartReferences(this.getCell()).iterator();
- while (ii.hasNext()) {
- Ai ai = (Ai) ii.next();
- if (ai.getParentChart() != null)
- ai.getParentChart().setMetricsDirty();
- }
- }
-
- /**
- * Creates a copy of this cell on the given worksheet at the given address.
- *
- * @param sourcecell
- * the cell to copy
- * @param newsheet
- * the sheet to which the cell should be copied
- * @param row
- * the row in which the copied cell should be placed
- * @param col
- * the row in which the copied cell should be placed
- * @return CellHandle representing the new Cell
- */
- public static final CellHandle copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet, int row,
- int col) throws CellPositionConflictException, CellNotFoundException {
- return copyCellToWorkSheet(sourcecell, newsheet, row, col, false);
- }
-
- /**
- * Creates a copy of this cell on the given worksheet at the given address.
- *
- * @param sourcecell
- * the cell to copy
- * @param newsheet
- * the sheet to which the cell should be copied
- * @param row
- * the row in which the copied cell should be placed
- * @param col
- * the row in which the copied cell should be placed
- * @param copyByValue
- * whether to copy formulas' values instead of the formulas
- * themselves
- * @return CellHandle representing the new cell
- */
- public static CellHandle copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet, int row, int col,
- boolean copyByValue) {
- // copy cell values
- CellHandle newcell = null;
-
- int offsets[] = { row - sourcecell.getRowNum(), col - sourcecell.getColNum() };
-
- if (sourcecell.isFormula() && !copyByValue)
- try {
- FormulaHandle fmh = sourcecell.getFormulaHandle();
- newcell = newsheet.add(fmh.getFormulaString(), row, col);
- FormulaHandle fm2 = newcell.getFormulaHandle();
- FormulaHandle.moveCellRefs(fm2, offsets);
- } catch (FormulaNotFoundException ex) {
- newcell = null;
- }
-
- if (newcell == null)
- newcell = newsheet.add(sourcecell.getVal(), row, col);
-
- return copyCellHelper(sourcecell, newcell);
- }
-
- /**
- * Create a copy of this Cell in another WorkBook
- *
- *
- * @param sourcecell
- * the cell to copy
- * @param target
- * worksheet to copy this cell into
- * @return
- */
- public static final CellHandle copyCellToWorkSheet(CellHandle sourcecell, WorkSheetHandle newsheet) {
- // copy cell values
- CellHandle newcell = null;
- try {
- FormulaHandle fmh = sourcecell.getFormulaHandle();
- // Logger.logInfo("testFormats Formula encountered: "+
- // fmh.getFormulaString());
-
- newcell = newsheet.add(fmh.getFormulaString(), sourcecell.getCellAddress());
- } catch (FormulaNotFoundException ex) {
- newcell = newsheet.add(sourcecell.getVal(), sourcecell.getCellAddress());
- }
- return copyCellHelper(sourcecell, newcell);
- }
-
- /**
- * Get the JSON object for this cell.
- *
- * @return String representing the JSON for this Cell
- */
- public String getJSON() {
- return getJSONObject().toString();
- }
-
- /** Get the JSON object for this cell. */
- public JSONObject getJSONObject() {
- CellRange cr = getMergedCellRange();
- int[] mergedCellRange = null;
- if (cr != null) {
- try {
- mergedCellRange = cr.getRangeCoords();
- if (mycell.getOpcode() == XLSRecord.MULBLANK) {
- Mulblank m = (Mulblank) mycell;
- if (!cr.contains(m.getIntLocation())) {
- mergedCellRange = null;
- }
- }
- } catch (CellNotFoundException e) {
- ;
- }
- }
-
- return getJSONObject(mergedCellRange);
- }
-
- /**
- * Get a JSON Object representation of a cell utilizing a merged range
- * identifier.
- *
- * @deprecated The {@code mergedRange} parameter is unnecessary. This method
- * will be removed in a future version. Use {@link #getJSONObject()}
- * instead.
- */
- @Deprecated
- public JSONObject getJSONObject(int[] mergedRange) {
- JSONObject theCell = new JSONObject();
- try {
- theCell.put(JSON_LOCATION, getCellAddress());
-
- Object val;
- try {
- val = getVal();
- if (val == null)
- val = "";
- } catch (Exception ex) {
- Logger.logWarn("OpenXLS.getJSONObject failed: " + ex.toString());
- val = "#ERR!";
- }
-
- String typename = getCellTypeName();
- JSONObject dataval = new JSONObject();
-
- if (typename.equals("Formula")) {
- try {
- FormulaHandle fmh = getFormulaHandle();
- String fms = fmh.getFormulaString();
-
- theCell.put(JSON_CELL_FORMULA, fms);
-
- try {
- if (Float.parseFloat(val.toString()) == (Float.NaN)) {
- typename = JSON_FLOAT;
- } else if (val instanceof Float)
- typename = JSON_FLOAT;
- else if (val instanceof Double)
- typename = JSON_DOUBLE;
- else if (val instanceof Integer)
- typename = JSON_INTEGER;
- else if (val instanceof java.util.Date || val instanceof java.sql.Date
- || val instanceof java.sql.Timestamp) {
- typename = JSON_DATETIME;
- } else
- typename = JSON_STRING;
- } catch (Exception e) {
- typename = JSON_STRING; // default
- }
- } catch (Exception e) {
- Logger.logErr("OpenXLS.getJSON() failed getting type of Formula for: " + toString(), e);
- }
- }
-
- if (isDate())
- typename = JSON_DATETIME;
-
- dataval.put(JSON_TYPE, typename);
-
- // TODO: Handle Conditional Format
- // cell should return the style id for its condition
- // this is an ID that begins incrementing after the last Xf
- // and should be contained in the CSS for the output
-
- // if the conditional format evaluates to TRUE
- // then we use *that* style ID not the default
-
- // We can have multiple CF styles per cell, one per each rule... we'll need that
- // from CSS standpoint so...
-
- // style
- theCell.put(JSON_STYLEID, getConditionalFormatId());
-
- // merges
- if (mergedRange != null) {
- theCell.put(JSON_MERGEACROSS, (mergedRange[3] - mergedRange[1]));
- theCell.put(JSON_MERGEDOWN, (mergedRange[2] - mergedRange[0]));
- if (isMergeParent()) {
- theCell.put(JSON_MERGEPARENT, true);
- } else {
- theCell.put(JSON_MERGECHILD, true);
- }
- }
-
- // handle hidden setting
- try {
- if (getCol().isHidden())
- theCell.put(JSON_HIDDEN, true);
- } catch (Exception e) {
- ;
- }
-
- // handle the locked/formula hidden setting
- // only active if sheet is protected
- try {
- if (isFormulaHidden())
- theCell.put(JSON_FORMULA_HIDDEN, true);
-
- theCell.put(JSON_LOCKED, isLocked());
- } catch (Exception e) {
- ;
- }
-
- try {
- ValidationHandle vh = getValidationHandle();
- if (vh != null)
- theCell.put(JSON_VALIDATION_MESSAGE, vh.getPromptBoxTitle() + ":" + vh.getPromptBoxText());
- } catch (Exception e) {
- ;
- }
-
- // hyperlinks
- if (!(getURL() == null))
- theCell.put(JSON_HREF, getURL());
-
- if (getWrapText())
- theCell.put(JSON_WORD_WRAP, true);
-
- // store alignment for container issues
- int alignment = getFormatHandle().getHorizontalAlignment();
- if (alignment == FormatHandle.ALIGN_RIGHT) {
- theCell.put(JSON_TEXT_ALIGN, "right");
- } else if (alignment == FormatHandle.ALIGN_CENTER) {
- theCell.put(JSON_TEXT_ALIGN, "center");
- } else if (alignment == FormatHandle.ALIGN_LEFT) {
- theCell.put(JSON_TEXT_ALIGN, "left");
- }
-
- // dates
- if (typename.equals(JSON_DATETIME) && !(val == null) && !val.equals("")) {
- dataval.put(JSON_CELL_VALUE, getFormattedStringVal());
- // dataval.put(JSON_DATEVALUE, ch.getFloatVal());
- dataval.put("time", DateConverter.getCalendarFromCell(this).getTimeInMillis());
- } else if (getCellType() == CellHandle.TYPE_STRING) {
- // FORCES CALC
- if (((String) val).indexOf("\n") > -1) {
- val = ((String) val).replaceAll("\n", " WorkBookHandle book = newWorkBookHandle("testxls.xls"); * With a CellHandle you can: {
+
+ /**
+ * returns the WorkBookHandle for this Cell
+ *
+ * @return WorkBook the book
+ */
+ @Transient
+ val workBook: WorkBook? = null
+ /**
+ * get the WorkSheetHandle for this Cell
+ *
+ * @return the WorkSheetHandle for this Cell
+ */
+ /**
+ * set the WorkSheetHandle for this Cell
+ *
+ * @param WorkSheetHandle handle - the new worksheet for this Cell
+ * @see WorkSheetHandle
+ */
+ @Transient // This is redundant, already done in WSH.getCell().
+ // if (wsh!=null) //20080616 KSC
+ // wsh.cellhandles.put(this.getCellAddress(), this);
+ var workSheetHandle: WorkSheetHandle? = null
+ private var mycol: ColHandle? = null
+ private var myrow: RowHandle? = null
+ private var formatter: FormatHandle? = null
+ // reusing or creating new xfs is handled in FormatHandle/cloneXf and
+ // updateXf
+ // boolean useExistingXF = !false;
+ private val DEBUG = false
+ /**
+ * returns the underlying BIFF8 record for the Cell ()
+ try {
+ if (this.isUnderlined) {
+ ftmap[java.awt.font.TextAttribute.UNDERLINE] = java.awt.font.TextAttribute.UNDERLINE
+ }
+ } catch (e: Exception) {
+ }
+
+ ftmap[java.awt.font.TextAttribute.FAMILY] = fface
+ val fx = this.fontWeight.toFloat()
+ ftmap[java.awt.font.TextAttribute.SIZE] = sz
+ if (fx == FormatHandle.BOLD.toFloat())
+ ftmap[java.awt.font.TextAttribute.WEIGHT] = java.awt.font.TextAttribute.WEIGHT_BOLD
+ else
+ ftmap[java.awt.font.TextAttribute.WEIGHT] = java.awt.font.TextAttribute.WEIGHT_REGULAR
+ return java.awt.Font(ftmap)
+ }
+
+ /**
+ * Get a CommentHandle to the note attached to this cell
+ */
+ // this needs significant cleanup. We should not have to iterate notes
+ val comment: CommentHandle
+ @Throws(DocumentObjectNotFoundException::class)
+ get() {
+ val notes = record!!.sheet!!.notes
+ for (i in notes.indices) {
+ val n = notes[i] as Note
+ if (n.cellAddressWithSheet == this.cellAddressWithSheet) {
+ return CommentHandle(n)
+ }
+ }
+ throw DocumentObjectNotFoundException("Note record not found at " + this.cellAddressWithSheet)
+ }
+
+ /**
+ * returns whether the Font for this Cell is underlined
+ *
+ * @return boolean true if Font is underlined
+ */
+ /**
+ * Set whether the Font for this Cell is underlined
+ *
+ * @param boolean b - true if the Font for this Cell should be underlined (single
+ * underline only)
+ */
+ var isUnderlined: Boolean
+ get() = if (this.font == null) false else this.font!!.underlineStyle != 0x0
+ set(isUnderlined) {
+ setFormatHandle()
+ if (isUnderlined)
+ this.font!!.setUnderlineStyle(Font.STYLE_UNDERLINE_SINGLE)
+ else
+ this.font!!.setUnderlineStyle(Font.STYLE_UNDERLINE_NONE)
+ }
+
+ /**
+ * Returns any other Cells merged with this one, or null if this Cell is not a
+ * part of a merged range.
+ get() {
+ formatHandle
+ return this.formatter!!.borderColors
+ }
+
+ /**
+ * returns the low-level bytes for the underlying BIFF8 record. ?
+ get() {
+ val cfhandles = this.conditionalFormatHandles
+ if (cfhandles != null) {
+ val fmx = arrayOfNulls(cfhandles[0].cndfmt!!.rules.size)
+ var t = 0
+ while (t < fmx.size) {
+ fmx[t++] = FormatHandle(cfhandles[0].cndfmt!!, workBook!!, t, this)
+ t++
+ }
+ return fmx
+ }
+ return null
+ }
+
+ /**
+ * return all the ConditionalFormatHandles for this Cell, if any
+ *
+ * @return
+ */
+ val conditionalFormatHandles: Array?
+ get() {
+ val sh = this.workSheetHandle ?: return null
+ val cfs = sh.conditionalFormatHandles
+ val cfhandles = ArrayList()
+ for (i in cfs.indices) {
+ if (cfs[i].contains(this))
+ cfhandles.add(cfs[i])
+ }
+ val c = arrayOfNulls(cfhandles.size)
+ return cfhandles.toTypedArray()
+ }
+
+ /**
+ * Gets the FormatHandle (a Format Object describing the formats for this Cell)
+ * for this Cell.
+ *
+ * @return FormatHandle for this Cell
+ */
+ /**
+ * Sets the FormatHandle (a Format Object describing the formats for this Cell)
+ * for this Cell
+ *
+ * @param FormatHandle to apply to this Cell
+ * @see FormatHandle
+ */
+ var formatHandle: FormatHandle?
+ get() {
+ if (this.formatter == null)
+ this.setFormatHandle()
+
+ return this.formatter
+ }
+ set(f) {
+ f.addCell(this.record)
+ this.formatter = f
+ }
+
+ /**
+ * Returns the Formula Handle (an Object describing a Formula) for this Cell, if
+ * it contains a formula
+ *
+ * @return FormulaHandle the Formula of the Cell
+ * @throws FormulaNotFoundException
+ * @see FormulaHandle
+ */
+ val formulaHandle: FormulaHandle
+ @Throws(FormulaNotFoundException::class)
+ get() {
+ val f = record!!.formulaRec ?: throw FormulaNotFoundException("No Formula for: $cellAddress")
+ return FormulaHandle(f, workBook)
+ }
+
+ /**
+ * Returns the Hyperlink URL String for this Cell, if any
+ *
+ * @return String URL if this Cell contains a hyperlink
+ */
+ /**
+ * Creates a new Hyperlink for this Cell from a URL String. Can be any valid
+ * URL. This URL String must include the protocol. ")
+ if (typename == "DateTime") {
+ retval.append(DateConverter.getFormattedDateVal(this))
+ } else if (this.cellType == CellHandle.TYPE_STRING) {
+ `val` = this.stringVal // (String)getVal();
+ if (`val` == "") { // 20070216 KSC: John, had the same edits,
+ // seems to work well in cursory tests ...
+ // retval.append(" "); does this screw up formulas expecting
+ // empty strings? -jm
+ } else {
+ retval.append(StringTool.convertXMLChars(`val`!!.toString()))
+ }
+ } else {
+ try {
+ // if(val == null)
+ `val` = this.`val`
+ retval.append(StringTool.convertXMLChars(`val`!!.toString()) + vl)
+ } catch (e: Exception) {
+ Logger.logErr("CellHandle.getXML failed for: " + this.cellAddress + " in: "
+ + this.workBook!!.toString(), e)
+ retval.append("XML ERROR!")
+ }
+
+ }
+ retval.append(" ")
+ retval.append(end_cell_xml)
+ } else {
+ var c = (this.record as Mulblank).colFirst
+ val lastcol = (this.record as Mulblank).colLast
+ while (c <= lastcol) {
+ mulblankcolnum = c.toShort()
+ // Put the style ID in
+ sv = " StyleID=\"s$formatId\""
+ if (this.col.isHidden) {
+ hd = " Hidden=\"true\""
+ }
+ // TODO: HRefScreenTip ????
+ if (this.url != null) {
+ hlink = " HRef=\"" + StringTool.convertXMLChars(this.url) + "\""
+ }
+
+ // put the date formattingin
+ // Assemble the string
+ retval.append(" {
+ val rt = this.workBook!!.workBook.refTracker
+ val its = rt!!.clearAffectedFormulaCells(this).values.iterator()
+
+ val ret = ArrayList()
+ while (its.hasNext()) {
+ val cx = CellHandle(its.next() as BiffRec, this.workBook)
+ ret.add(cx)
+ }
+ return ret
+ }
+
+ /**
+ * Internal method for clearing affected cells, does the same thing as
+ * calculateAffectedCells, but does not create a list
+ */
+ fun clearAffectedCells() {
+ val rt = this.workBook!!.workBook.refTracker
+ rt!!.clearAffectedFormulaCells(this)
+ }
+
+ /**
+ * Calculates and returns all formulas on the same sheet that reference this
+ * CellHandle. {
+ val its = this.workBook!!.workBook.refTracker!!
+ .clearAffectedFormulaCellsOnSheet(this, this.workSheetName).values.iterator()
+ val ret = ArrayList()
+ while (its.hasNext()) {
+ val cx = CellHandle(its.next() as BiffRec, this.workBook)
+ ret.add(cx)
+ }
+ return ret
+ }
+
+ /**
+ * flags chart references to the particular cell as dirty/ needing caches
+ * rebuilt
+ */
+ fun clearChartReferences() {
+ val ret = ArrayList()
+ val ii = this.workBook!!.workBook.refTracker!!.getChartReferences(this.cell!!).iterator()
+ while (ii.hasNext()) {
+ val ai = ii.next() as Ai
+ if (ai.parentChart != null)
+ ai.parentChart!!.setMetricsDirty()
+ }
+ }
+
+ /**
+ * Get a JSON Object representation of a cell utilizing a merged range
+ * identifier.
+ *
+ */
+ @Deprecated("The {@code mergedRange} parameter is unnecessary. This method\n" +
+ " will be removed in a future version. Use {@link #getJSONObject()}\n" +
+ " instead.")
+ fun getJSONObject(mergedRange: IntArray?): JSONObject {
+ val theCell = JSONObject()
+ try {
+ theCell.put(JSON_LOCATION, cellAddress)
+
+ var `val`: Any?
+ try {
+ `val` = `val`
+ if (`val` == null)
+ `val` = ""
+ } catch (ex: Exception) {
+ Logger.logWarn("OpenXLS.getJSONObject failed: $ex")
+ `val` = "#ERR!"
+ }
+
+ var typename = cellTypeName
+ val dataval = JSONObject()
+
+ if (typename == "Formula") {
+ try {
+ val fmh = formulaHandle
+ val fms = fmh.formulaString
+
+ theCell.put(JSON_CELL_FORMULA, fms)
+
+ try {
+ if (java.lang.Float.parseFloat(`val`!!.toString()) == java.lang.Float.NaN) {
+ typename = JSON_FLOAT
+ } else if (`val` is Float)
+ typename = JSON_FLOAT
+ else if (`val` is Double)
+ typename = JSON_DOUBLE
+ else if (`val` is Int)
+ typename = JSON_INTEGER
+ else if (`val` is java.util.Date || `val` is java.sql.Date
+ || `val` is java.sql.Timestamp) {
+ typename = JSON_DATETIME
+ } else
+ typename = JSON_STRING
+ } catch (e: Exception) {
+ typename = JSON_STRING // default
+ }
+
+ } catch (e: Exception) {
+ Logger.logErr("OpenXLS.getJSON() failed getting type of Formula for: " + toString(), e)
+ }
+
+ }
+
+ if (isDate)
+ typename = JSON_DATETIME
+
+ dataval.put(JSON_TYPE, typename)
+
+ // TODO: Handle Conditional Format
+ // cell should return the style id for its condition
+ // this is an ID that begins incrementing after the last Xf
+ // and should be contained in the CSS for the output
+
+ // if the conditional format evaluates to TRUE
+ // then we use *that* style ID not the default
+
+ // We can have multiple CF styles per cell, one per each rule... we'll need that
+ // from CSS standpoint so...
+
+ // style
+ theCell.put(JSON_STYLEID, conditionalFormatId)
+
+ // merges
+ if (mergedRange != null) {
+ theCell.put(JSON_MERGEACROSS, mergedRange[3] - mergedRange[1])
+ theCell.put(JSON_MERGEDOWN, mergedRange[2] - mergedRange[0])
+ if (isMergeParent) {
+ theCell.put(JSON_MERGEPARENT, true)
+ } else {
+ theCell.put(JSON_MERGECHILD, true)
+ }
+ }
+
+ // handle hidden setting
+ try {
+ if (col.isHidden)
+ theCell.put(JSON_HIDDEN, true)
+ } catch (e: Exception) {
+ }
+
+ // handle the locked/formula hidden setting
+ // only active if sheet is protected
+ try {
+ if (isFormulaHidden)
+ theCell.put(JSON_FORMULA_HIDDEN, true)
+
+ theCell.put(JSON_LOCKED, isLocked)
+ } catch (e: Exception) {
+ }
+
+ try {
+ val vh = validationHandle
+ if (vh != null)
+ theCell.put(JSON_VALIDATION_MESSAGE, vh.promptBoxTitle + ":" + vh.promptBoxText)
+ } catch (e: Exception) {
+ }
+
+ // hyperlinks
+ if (url != null)
+ theCell.put(JSON_HREF, url)
+
+ if (wrapText)
+ theCell.put(JSON_WORD_WRAP, true)
+
+ // store alignment for container issues
+ val alignment = formatHandle!!.horizontalAlignment
+ if (alignment == FormatHandle.ALIGN_RIGHT) {
+ theCell.put(JSON_TEXT_ALIGN, "right")
+ } else if (alignment == FormatHandle.ALIGN_CENTER) {
+ theCell.put(JSON_TEXT_ALIGN, "center")
+ } else if (alignment == FormatHandle.ALIGN_LEFT) {
+ theCell.put(JSON_TEXT_ALIGN, "left")
+ }
+
+ // dates
+ if (typename == JSON_DATETIME && `val` != null && `val` != "") {
+ dataval.put(JSON_CELL_VALUE, formattedStringVal)
+ // dataval.put(JSON_DATEVALUE, ch.getFloatVal());
+ dataval.put("time", DateConverter.getCalendarFromCell(this).timeInMillis)
+ } else if (cellType == CellHandle.TYPE_STRING) {
+ // FORCES CALC
+ if ((`val` as String).indexOf("\n") > -1) {
+ `val` = `val`.replace("\n".toRegex(), " | "
+
+ internal val begin_cell_xml = " | "
+ internal val end_cell_xml = " | "
+
+ /**
+ * Returns an xml representation of an empty cell
+ *
+ * @param loc - the cell address
+ * @param isVisible - if the cell is visible (not hidden)
+ * @return
+ */
+ protected fun getEmptyCellXML(loc: String, isVisible: Boolean): String {
+ return if (!isVisible) {
+ begin_hidden_emptycell_xml + loc + end_hidden_emptycell_xml
+ } else {
+ begin_cell_xml + loc + end_emptycell_xml
+ }
+ }
+
+ /**
+ * Creates a copy of this cell on the given worksheet at the given address.
+ *
+ * @param sourcecell the cell to copy
+ * @param newsheet the sheet to which the cell should be copied
+ * @param row the row in which the copied cell should be placed
+ * @param col the row in which the copied cell should be placed
+ * @param copyByValue whether to copy formulas' values instead of the formulas
+ * themselves
+ * @return CellHandle representing the new cell
+ */
+ @JvmOverloads
+ fun copyCellToWorkSheet(sourcecell: CellHandle, newsheet: WorkSheetHandle, row: Int, col: Int,
+ copyByValue: Boolean = false): CellHandle {
+ // copy cell values
+ var newcell: CellHandle? = null
+
+ val offsets = intArrayOf(row - sourcecell.rowNum, col - sourcecell.colNum)
+
+ if (sourcecell.isFormula && !copyByValue)
+ try {
+ val fmh = sourcecell.formulaHandle
+ newcell = newsheet.add(fmh.formulaString, row, col)
+ val fm2 = newcell!!.formulaHandle
+ FormulaHandle.moveCellRefs(fm2, offsets)
+ } catch (ex: FormulaNotFoundException) {
+ newcell = null
+ }
+
+ if (newcell == null)
+ newcell = newsheet.add(sourcecell.`val`, row, col)
+
+ return copyCellHelper(sourcecell, newcell!!)
+ }
+
+ /**
+ * Create a copy of this Cell in another WorkBook
+ *
+ * @param sourcecell the cell to copy
+ * @param target worksheet to copy this cell into
+ * @return
+ */
+ fun copyCellToWorkSheet(sourcecell: CellHandle, newsheet: WorkSheetHandle): CellHandle {
+ // copy cell values
+ var newcell: CellHandle? = null
+ try {
+ val fmh = sourcecell.formulaHandle
+ // Logger.logInfo("testFormats Formula encountered: "+
+ // fmh.getFormulaString());
+
+ newcell = newsheet.add(fmh.formulaString, sourcecell.cellAddress)
+ } catch (ex: FormulaNotFoundException) {
+ newcell = newsheet.add(sourcecell.`val`, sourcecell.cellAddress)
+ }
+
+ return copyCellHelper(sourcecell, newcell!!)
+ }
+
+ /**
+ * Copies all formatting - xf and non-xf (such as column width, hidden state)
+ * plus merged cell range from a sourcecell to a new cell (usually in a new
+ * workbook)
+ *
+ * @param sourcecell the cell to copy
+ * @param newcell the cell to copy to
+ * @return
+ */
+ protected fun copyCellHelper(sourcecell: CellHandle, newcell: CellHandle): CellHandle {
+ // copy row height & attributes
+ val rz = sourcecell.row.height
+ newcell.row.height = rz
+ if (sourcecell.row.isHidden) {
+ newcell.row.isHidden = true
+ }
+ // copy col width & attributes
+ val rzx = sourcecell.col.width
+ newcell.col.width = rzx
+ if (sourcecell.col.isHidden) {
+ newcell.col.isHidden = true
+ // Logger.logInfo("column " + rzx + " is hidden");
+ }
+
+ try {
+ // copy merged ranges
+ var rng = sourcecell.mergedCellRange
+ if (rng != null) {
+ rng = CellRange(rng.getRange(), newcell.workBook)
+ rng.addCellToRange(newcell)
+ rng.mergeCells(false)
+ }
+ // Handle formats:
+ val origxf = sourcecell.workBook!!.workBook.getXf(sourcecell.formatId)
+ newcell.formatHandle!!.addXf(origxf!!)
+ return newcell
+ } catch (ex: Exception) {
+ Logger.logErr("CellHandle.copyCellHelper failed.", ex)
+ }
+
+ return newcell
+ }
+ }
+
+}
+/**
+ * Creates a copy of this cell on the given worksheet at the given address.
+ *
+ * @param sourcecell the cell to copy
+ * @param newsheet the sheet to which the cell should be copied
+ * @param row the row in which the copied cell should be placed
+ * @param col the row in which the copied cell should be placed
+ * @return CellHandle representing the new Cell
+ */
diff --git a/src/main/java/io/starter/OpenXLS/CellRange.java b/src/main/java/io/starter/OpenXLS/CellRange.java
deleted file mode 100644
index 0c70226..0000000
--- a/src/main/java/io/starter/OpenXLS/CellRange.java
+++ /dev/null
@@ -1,2038 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- * CellRange cr = new CellRange("Sheet1!A1:B10", workbk);
- *
- * Starter Inc.
- *
- * @see DataBoundCellRange
- * @see XLSRecord
- */
-public class CellRange implements Serializable {
-
- Condfmt cfx = null;
-
- /**
- * returns the conditional format object for this range, if any
- *
- * @return Condfmt object
- */
- protected Condfmt getConditionalFormat() {
- return cfx;
- }
-
- /**
- *
- *
- *
- */
- private static final long serialVersionUID = -3609881364824289079L;
- private boolean ismerged = false;
- private BiffRec parent = null; // if cell range is child of a named range, must ensure update correctly
- public static final boolean REMOVE_MERGED_CELLS = true;
- public static final boolean RETAIN_MERGED_CELLS = false;
- // private Ptg myptg = null;
- public boolean DEBUG = false;
- private boolean isDirty = false; // true if addCellsToRange without init
- int firstcellrow = -1;
- int firstcellcol = -1;
- int lastcellrow = -1;
- int lastcellcol = -1;
- private boolean createBlanks = false;
- private boolean initializeCells = true;
- public transient CellHandle[] cells;
- protected transient String range, sheetname;
- protected transient io.starter.OpenXLS.WorkBook mybook;
- private transient WorkSheetHandle sheet = null;
- private int[] myrowints;
- private int[] mycolints;
- private transient RowHandle[] myrows;
- private transient ColHandle[] mycols;
-
- // for OOXML External References
- protected int externalLink1 = 0;
- protected int externalLink2 = 0;
-
- FormatHandle fmtr = null;
- boolean wholeCol = false, wholeRow = false;
-
- /** Protected constructor for creating result ranges. */
- protected CellRange(WorkSheetHandle sheet, int row, int col, int width, int height) {
- this.sheet = sheet;
- sheetname = sheet.getSheetName();
- mybook = sheet.getWorkBook();
-
- firstcellrow = row;
- firstcellcol = col;
- lastcellrow = row + height - 1;
- lastcellcol = col + width - 1;
-
- range = sheetname + "!"
- + ExcelTools.formatRange(new int[] { firstcellcol, firstcellrow, lastcellcol, lastcellrow });
-
- cells = new CellHandle[width * height];
- }
-
- /**
- * Initializes a CellRange from a CellRangeRef. The
- * source CellRangeRef instance must be qualified with a single
- * resolved worksheet.
- *
- * @param source
- * the CellRangeRef from which to initialize
- * @param init
- * whether to populate the cell array
- * @param create
- * whether to fill gaps in the range with blank cells
- * @throws IllegalArgumentException
- * if the source range does not have a resolved sheet or has more
- * than one sheet
- */
- public CellRange(CellRangeRef source, boolean init, boolean create) {
- initializeCells = init;
- createBlanks = create;
-
- sheet = source.getFirstSheet();
- if (sheet == null || source.isMultiSheet())
- throw new IllegalArgumentException("the source range must have a single resolved sheet");
-
- mybook = this.sheet.getWorkBook();
- sheetname = this.sheet.getSheetName();
-
- // This is inefficient, but fixing it would require rewriting init.
- this.range = source.toString();
-
- try {
- this.init();
- } catch (CellNotFoundException e) {
- // this should be impossible
- throw new RuntimeException(e);
- }
- }
-
- /**
- * Initializes a CellRange from a CellRangeRef. The
- * source CellRangeRef instance must be qualified with a single
- * resolved worksheet.
- *
- * @param source
- * the CellRangeRef from which to initialize
- * @throws IllegalArgumentException
- * if the source range does not have a resolved sheet or has more
- * than one sheet
- */
- public CellRange(CellRangeRef source) {
- this(source, false, true);
- }
-
- public void clearFormats() {
- for (int idx = 0; idx < cells.length; idx++)
- if (cells[idx] != null)
- cells[idx].clearFormats();
- }
-
- /**
- * @deprecated use clear()
- */
- @Deprecated
- public void clearContents() {
- for (int idx = 0; idx < cells.length; idx++)
- if (cells[idx] != null)
- cells[idx].clearContents();
- }
-
- /**
- * clears the contents and formats of the cells referenced by this range but
- * does not remove the cells from the workbook.
- *
- */
- public void clear() {
- for (int idx = 0; idx < cells.length; idx++)
- if (cells[idx] != null)
- cells[idx].clear();
- }
-
- /**
- * removes the cells referenced by this range from the sheet.
- *
- * NOTE: method does not shift rows or cols.
- *
- */
- public void removeCells() {
- for (int idx = 0; idx < cells.length; idx++)
- if (cells[idx] != null)
- cells[idx].remove(true);
- }
-
- /**
- * Un-Merge the Cells contained in this CellRange
- *
- * @throws Exception
- */
- public void unMergeCells() throws Exception {
- BiffRec[] mycells = this.getCellRecs();
- for (int t = 0; t < mycells.length; t++) {
- mycells[t].setMergeRange(null); // unset the range of merged cells
- mycells[t].getXfRec().setMerged(false);
- }
- Mergedcells mc = this.getSheet().getSheet().getMergedCellsRec();
- if (mc != null)
- mc.removeCellRange(this);
- this.ismerged = false;
- }
-
- /**
- * Set the format ID of all cells in this CellRange getCellList() {
- return Arrays.asList(cells);
- }
-
- /**
- * get the underlying Cell Records in this range comparator, boolean ascending) throws RowNotFoundException {
- this.createBlanks();
- ArrayList sortRow = this.getCellsByRow(rownumber);
- Collections.sort(sortRow, comparator);
- if (!ascending)
- Collections.reverse(sortRow);
- // now we have sorted the array list, come up with a map to resort the rows.
- int[] coords = null;
- try {
- coords = this.getRangeCoords();
- // fix stupid wrong offsets;
- coords[0] = coords[0]--;
- coords[2] = coords[2]--;
- } catch (CellNotFoundException e1) {
- }
- ArrayList outputCols = new ArrayList();
- for (int i = 0; i < sortRow.size(); i++) {
- CellHandle cell = sortRow.get(i);
- ArrayList cells = null;
- try {
- cells = this.getCellsByCol(ExcelTools.getAlphaVal(cell.getColNum()));
- } catch (ColumnNotFoundException e) {
- // if there are no cells in this column ignore it
- }
- outputCols.add(cells);
- }
- this.removeCells();
- for (int i = coords[1]; i <= coords[3]; i++) {
- ArrayList cells = outputCols.get(i - coords[1]);
- for (int x = 0; x < cells.size(); x++) {
- CellHandle cell = (CellHandle) cells.get(x);
- Boundsheet bs = this.getSheet().getBoundsheet();
- cell.getCell().setCol((short) i);
- bs.addCell((CellRec) cell.getCell());
- }
- }
-
- }
-
- /**
- * Changes the cellRange to a createBlanks cellrange and re-initializes the
- * range, creating the missing blanks.
- */
- private void createBlanks() {
- if (!this.createBlanks) {
- this.createBlanks = true;
- this.initializeCells = true;
- try {
- this.init();
- } catch (CellNotFoundException e) {
- }
- }
- }
-
- /**
- * Resort all cells in the range according to the rownumber passed in.
- *
- * @param rownumber
- * the 0 based row number
- * @param ascending
- * @throws RowNotFoundException
- * @throws ColumnNotFoundException
- */
- public void sort(int rownumber, boolean ascending) throws RowNotFoundException {
- Comparator cp = new CellComparator();
- this.sort(rownumber, cp, ascending);
- }
-
- /**
- * Re-sort all cells in this cell range according to the column.
- *
- * A custom comparator can be passed in, or the default one can be used with
- * sort(String, boolean).
- *
- * Comparators will be passed 2 CellHandle objects for comparison.
- *
- * * Collections.reverse will be called on the results if ascending is set to
- * false;
- *
- * @param columnName
- * @param comparator
- * @throws RowNotFoundException
- * @throws ColumnNotFoundException
- */
- public void sort(String columnName, Comparator comparator, boolean ascending) throws ColumnNotFoundException {
- if (!this.createBlanks) {
- // we cannot have empty cells in this operation
- this.createBlanks = true;
- try {
- this.init();
- } catch (CellNotFoundException e) {
- }
- }
- ArrayList sortCol = this.getCellsByCol(columnName);
- Collections.sort(sortCol, comparator);
- if (!ascending)
- Collections.reverse(sortCol);
- // now we have sorted the array list, come up with a map to resort the rows.
- int[] coords = null;
- try {
- coords = this.getRangeCoords();
- // fix stupid wrong offsets;
- coords[0] = coords[0]--;
- coords[2] = coords[2]--;
- } catch (CellNotFoundException e1) {
- e1.printStackTrace();
- }
- ArrayList> outputRows = new ArrayList>();
- for (int i = 0; i < sortCol.size(); i++) {
- CellHandle cell = (CellHandle) sortCol.get(i);
- ArrayList cells = null;
- try {
- cells = this.getCellsByRow(cell.getRowNum());
- } catch (RowNotFoundException e) {
- // ignore if no cells available
- }
- outputRows.add(cells);
- }
- this.removeCells();
- for (int i = coords[0]; i <= coords[2]; i++) {
- ArrayList cells = outputRows.get(i - coords[0]);
- for (int x = 0; x < cells.size(); x++) {
- CellHandle cell = (CellHandle) cells.get(x);
- Boundsheet bs = this.getSheet().getBoundsheet();
- cell.getCell().setRowNumber(i - 1);
- bs.addCell((CellRec) cell.getCell());
- }
- }
- }
-
- /**
- * Resort all cells in the range according to the column passed in.
- *
- *
- * @param columnName
- * @param ascending
- * @throws ColumnNotFoundException
- * @throws RowNotFoundException
- */
- @SuppressWarnings("unchecked")
- public void sort(String columnName, boolean ascending) throws ColumnNotFoundException {
- Comparator cp = new CellComparator();
- this.sort(columnName, cp, ascending);
- }
-
- public static String xmlResponsePre = "";
- public static String xmlResponsePost = " ";
-
- /**
- * Return the XML representation of this CellRange object
- *
- * @return String of XML
- */
- public String getXML() {
- StringBuffer sb = new StringBuffer("");
- // StringBuffer sb = new StringBuffer(xmlResponsePre);
- CellHandle[] cx = this.getCells();
- sb.append("\r\n");
- // append cellxml
- for (int t = 0; t < cx.length; t++) {
- sb.append(cx[t].getXML());
- sb.append("\r\n");
- }
- sb.append(xmlResponsePost);
- return sb.toString();
- }
-
- /**
- * gets the array of Cells in this Name
- *
- * NOTE: this method variation also returns the Sheetname for the name record if
- * not null.
- *
- * Thus this method is limited to use with 2D ranges.
- *
- *
- * @return Cell[] all Cells defined in this Name
- * @param fragment
- * whether to enclose result in NameHandle tag
- */
- public String getCellRangeXML(boolean fragment) {
- StringBuffer sbx = new StringBuffer();
- if (!fragment)
- sbx.append("");
- sbx.append("");
- sbx.append(getXML());
- sbx.append("");
- return sbx.toString();
- }
-
- /**
- * gets the array of Cells in this Name
- *
- * Thus this method is limited to use with 2D ranges.
- *
- * @return Cell[] all Cells defined in this Name
- * @param fragment
- * whether to enclose result in NameHandle tag
- */
- public String getCellRangeXML() {
- StringBuffer sbx = new StringBuffer();
- sbx.append("");
- sbx.append(getXML());
- return sbx.toString();
- }
-
- /**
- * Constructor which creates a new CellRange using an array of cells as it's
- * constructor. cellsfromcomplexrange = new java.util.ArrayList();
- for (int i = 0; i < p.length; i++) {
- try {
- cellsfromcomplexrange.add(mybook.getCell(((PtgRef) p[i]).getLocation()));
- } catch (CellNotFoundException e) {
- if (this.createBlanks) {
- cells[i] = sheet.add(null, p[i].getLocation());
- }
- }
- }
- cells = new CellHandle[cellsfromcomplexrange.size()];
- cells = cellsfromcomplexrange.toArray(cells);
- } catch (Exception e) {
- throw new IllegalArgumentException(e.toString());
- }
-
- }
- isDirty = false;
- }
-
- /**
- * Initializes this CellRange's cell list if necessary. This method
- * is useful if this CellRange was created with
- * initCells set to false and it is later necessary to
- * retrieve the cell list.
- *
- * @param createBlanks
- * whether missing cells should be created as blanks. If this is
- * false they will appear in the cell list as
- * nulls.
- */
- public void initCells(boolean createBlanks) {
- // If we don't need to do anything, return
- if (initializeCells == true && (createBlanks ? this.createBlanks : true))
- return;
-
- this.initializeCells = true;
- this.createBlanks = createBlanks;
-
- try {
- this.init();
- } catch (CellNotFoundException e) {
- // This will never actually happen but we have to catch it anyway
- throw new Error();
- }
- }
-
- /**
- * @return the workbook object attached to this CellRange
- */
- public WorkBook getWorkBook() {
- return mybook;
- }
-
- /**
- * gets whether this CellRange will add blank records to the WorkBook for any
- * missing Cells contained within the range.
- *
- * @return true if should create blank records for missing Cells
- */
- public boolean getCreateBlanks() {
- return createBlanks;
- }
-
- /**
- * set whether this CellRange will add blank records to the WorkBook for any
- * missing Cells contained within the range.
- *
- * @param boolean
- * b - true if should create blank records for missing Cells
- */
- public void setCreateBlanks(boolean b) {
- createBlanks = b;
- }
-
- /**
- * Return the String representation of this range
- *
- * @return the String range
- */
- public String getRange() {
- return range;
- }
-
- /**
- * Return the String cell address of this range in R1C1 format
- *
- * @return String range in R1C1 format
- */
- public String getR1C1Range() {
- String rc1x = "R";
- try {
- int[] rc1 = this.getRangeCoords();
- rc1x += rc1[0] + 1; // rangecoords are already 1-based
- rc1x += "C" + rc1[1];
- rc1x += ":R" + (rc1[2] + 1);
- rc1x += "C" + rc1[3];
-
- } catch (CellNotFoundException e) {
- Logger.logErr("CellRange.getR1C1Range failed", e);
- }
- return rc1x;
- }
-
- /**
- * Sets the range of cells for this CellRange to a string range
- *
- * @param String
- * rng - Range string
- */
- public void setRange(String rng) {
- range = rng;
- try {
- this.init();
- } catch (CellNotFoundException e) {
- ; // don't have to report anything
- }
- }
-
- /**
- * sets a border around the range of cells
- *
- * @param int
- * width - line width
- * @param int
- * linestyle - line style
- * @param java.awt.Color
- * colr - color of border line
- */
- public void setBorder(int width, int linestyle, java.awt.Color colr) {
- CellHandle[] ch = getCells();
- for (int t = 0; t < ch.length; t++) {
- int[] coords = getEdgePositions(ch[t], width);
- // create Excel border -- top, left, bottom, right
- if (coords[0] > 0) {
- ch[t].setTopBorderLineStyle((short) linestyle);
- ch[t].setBorderTopColor(colr);
- }
- if (coords[1] > 0) {
- ch[t].setLeftBorderLineStyle((short) linestyle);
- ch[t].setBorderLeftColor(colr);
- }
- if (coords[2] > 0) {
- ch[t].setBottomBorderLineStyle((short) linestyle);
- ch[t].setBorderBottomColor(colr);
- }
- if (coords[3] > 0) {
- ch[t].setRightBorderLineStyle((short) linestyle);
- ch[t].setBorderRightColor(colr);
- }
- }
- }
-
- /**
- * update the CellRange when the underlying Cells change their location
- *
- * @return boolean true if the CellRange could be updated, false if there are no
- * cells represented by this range
- *
- *
- */
- public boolean update() {
- if (cells == null)
- return false; // this is an invalid range -- see Mergedcells prob.
- // jm
-
- // arbitrarily set the initial vals...
- if (cells[0] != null) { // 20100106 KSC: if didn't create blanks it's possible that cells are null
- firstcellrow = cells[0].getRowNum() + 1;
- firstcellcol = cells[0].getColNum();
- lastcellrow = cells[0].getRowNum() + 1;
- lastcellcol = cells[0].getColNum();
- for (int t = 0; t < cells.length; t++) {
- CellHandle cx = cells[t];
- // 20090901 KSC: apparently can be null
- if (cx != null)
- this.addCellToRange(cx);
- }
- this.myrowints = null;
- this.mycolints = null;
- return true;
- } else if (this.range != null) {// 20100106 KSC: handle ranges containing null cell[0] (i.e. ranges referencing
- // cells not present and createBlanks==false)
- if (this.DEBUG)
- Logger.logWarn("CellRange.update: trying to access blank cells in range " + this.range);
- try {
- this.getRangeCoords();
- return true;
- } catch (CellNotFoundException e) { // shouldn't
- return false;
- }
- }
- return false; // return false if it doesn't have it's cells defined
- }
-
- /**
- * returns the merged state of the CellRange
- *
- * @return true if this CellRange is merged
- */
- public boolean isMerged() {
- return ismerged;
- }
-
- /**
- * Sets the sheet reference for this CellRange.
- *
- * @param WorkSheetHandle
- * aSheet
- */
- public void setSheet(WorkSheetHandle aSheet) {
- this.sheet = aSheet;
- this.sheetname = aSheet.getSheetName();
- }
-
- /**
- * Whether to copy the cell contents.
- *
- */
- public static final int COPY_CONTENTS = 0x01;
-
- /**
- * Whether formulas should be copied. If this bit is not set the formula result
- * will be copied instead.
- */
- public static final int COPY_FORMULAS = 0x02;
-
- public static final int COPY_FORMATS = 0x0100;
-
- /**
- * Copies this range to another location. At present only contents and complete
- * formats may be copied.
- *
- * @param row
- * the topmost row of the target area
- * @param col
- * the leftmost column of the target area
- * @param what
- * a set of flags determining what will be copied
- * @return the destination range
- */
- public CellRange copy(WorkSheetHandle sheet, int row, int col, int what) {
- CellRange result = new CellRange(sheet, row, col, this.getWidth(), this.getHeight());
-
- int first_col = col;
-
- // note these are not currently used, see setting below
- boolean copy_contents = (what & COPY_CONTENTS) != 0;
- boolean copy_formulas = (what & COPY_FORMULAS) != 0;
- boolean copy_formats = (what & COPY_FORMATS) != 0;
-
- // set to true until this thing is fully implemented
- copy_formats = true;
- copy_formulas = true;
-
- int cur_row = cells[0].getRowNum();
- for (int idx = 0; idx < cells.length; idx++) {
- CellHandle source = cells[idx];
-
- if (source.getRowNum() != cur_row) {
- cur_row = source.getRowNum();
- row++;
- col = first_col;
- }
-
- CellHandle target = null;
- try {
- target = sheet.getCell(row, col);
- } catch (CellNotFoundException e) {
- }
-
- int formatID;
- if (copy_formats)
- formatID = source.getFormatId();
- else if (target != null)
- formatID = target.getFormatId();
- else
- formatID = sheet.getWorkBook().getWorkBook().getDefaultIxfe();
-
- if (copy_contents) {
- Object value;
-
- if (copy_formulas && source.isFormula()) {
- try {
- value = source.getFormulaHandle().getFormulaString();
- } catch (FormulaNotFoundException e) {
- // This shouldn't happen; we known the formula exists.
- // If it does happen it indicates a bug in OpenXLS,
- // thus we throw an Error.
- throw new Error("formula cell has no Formula record", e);
- }
- } else {
- value = source.getVal();
- }
-
- target = sheet.add(value, row, col, formatID);
-
- if (target.isFormula())
- try {
- FormulaHandle.moveCellRefs(target.getFormulaHandle(),
- new int[] { row - source.getRowNum(), col - source.getColNum() });
- } catch (FormulaNotFoundException e) {
- }
- }
-
- else if (target == null) {
- target = sheet.add(null, row, col, formatID);
- }
-
- if (copy_formats) {
- target.setFormatId(formatID);
- }
-
- result.cells[idx] = target;
- col++;
- }
-
- return result;
- }
-
- /**
- * Fills this range from the given cell.
- *
- * @param source
- * the cell whose attributes should be copied or null to
- * copy from the first cell in the range
- * @param what
- * a set of flags determining what will be copied
- * @param increment
- * the amount by which to increment numeric values or
- * NaN for no increment
- */
- public void fill(CellHandle source, int what, double increment) {
- if (null == source)
- source = cells[0];
-
- boolean copy_contents = (what & COPY_CONTENTS) != 0;
- boolean copy_formulas = (what & COPY_FORMULAS) != 0;
- boolean copy_formats = (what & COPY_FORMATS) != 0;
-
- int sourceRow = source.getRowNum();
- int sourceCol = source.getColNum();
-
- Object value = null;
- if (copy_contents) {
- if (copy_formulas && source.isFormula()) {
- try {
- value = source.getFormulaHandle().getFormulaString();
- } catch (FormulaNotFoundException e) {
- throw new Error("formula cell has no Formula record", e);
- }
- } else {
- value = source.getVal();
- }
- }
-
- // if increment is set, ensure the value can be incremented
- if (!Double.isNaN(increment) && !(copy_contents && value instanceof Number))
- throw new IllegalArgumentException("cannot increment unless filling with a numeric value");
-
- for (int idx = 0; idx < cells.length; idx++) {
- CellHandle target = cells[idx];
-
- // don't overwrite the source cell
- if (source.equals(target))
- continue;
-
- if (!Double.isNaN(increment))
- value = ((Number) value).doubleValue() + increment;
-
- int formatID = (copy_formats ? source : target).getFormatId();
-
- if (copy_contents) {
- cells[idx] = target = sheet.add(value, target.getRowNum(), target.getColNum(), formatID);
-
- if (target.isFormula())
- try {
- FormulaHandle.moveCellRefs(target.getFormulaHandle(),
- new int[] { target.getRowNum() - sourceRow, target.getColNum() - sourceCol });
- } catch (FormulaNotFoundException e) {
- }
- }
-
- // when adding Date values passing the format ID to sheet.add
- // doesn't set the format so we always set it here
- if (copy_formats) {
- target.setFormatId(formatID);
- }
-
- }
- }
-
- public Collection calculateAffectedCellsOnSheet() {
- Set affected = new HashSet();
- for (CellHandle cell : cells) {
- if (cell != null) {
- affected.add(cell);
- affected.addAll(cell.calculateAffectedCellsOnSheet());
- }
- }
- return affected;
- }
-
- /**
- * return a JSON array of cell values for the given range getCellsByRow(int rownumber) throws RowNotFoundException {
- ArrayList al = new ArrayList();
- RowHandle r = this.getSheet().getRow(rownumber);
- CellHandle[] cells = r.getCells();
- int[] coords = null;
- try {
- coords = this.getRangeCoords();
- } catch (CellNotFoundException e) {
- throw new RowNotFoundException("Error getting internal coordinates for CellRange" + e);
- }
- for (int i = 0; i < cells.length; i++) {
- if (cells[i].getColNum() >= coords[1] && cells[i].getColNum() <= coords[3]) {
- al.add(cells[i]);
- }
- }
- return al;
- }
-
- /**
- * Get the cells from a particular column, constrained by the boundaries of the
- * cellRange
- *
- * @param rownumber
- * @throws ColumnNotFoundException
- */
- public ArrayList getCellsByCol(String col) throws ColumnNotFoundException {
- ArrayList al = new ArrayList();
- ColHandle r = this.getSheet().getCol(col);
- CellHandle[] cells = r.getCells();
- int[] coords = null;
- try {
- coords = this.getRangeCoords();
- coords[0] = coords[0] - 1;
- coords[2] = coords[2] - 1;
- } catch (CellNotFoundException e) {
- throw new ColumnNotFoundException("Error getting internal coordinates for CellRange" + e);
- }
- for (int i = 0; i < cells.length; i++) {
- if (cells[i].getRowNum() >= coords[0] && cells[i].getRowNum() <= coords[2]) {
- al.add(cells[i]);
- }
- }
- return al;
- }
-
- /**
- * returns the cells for a given range CellRange cr = new CellRange("Sheet1!A1:B10", workbk); *
+ *
+ * [Starter Inc.](http://starter.io)
+ *
+ * @see DataBoundCellRange
+ *
+ * @see XLSRecord
+ */
+class CellRange : Serializable {
+
+ /**
+ * returns the conditional format object for this range, if any
+ *
+ * @return Condfmt object
+ */
+ protected var conditionalFormat: Condfmt? = null
+ internal set
+ /**
+ * returns the merged state of the CellRange
+ *
+ * @return true if this CellRange is merged
+ */
+ var isMerged = false
+ private set
+ private var parent: BiffRec? = null // if cell range is child of a named range, must ensure update correctly
+ // private Ptg myptg = null;
+ var DEBUG = false
+ private var isDirty = false // true if addCellsToRange without init
+ internal var firstcellrow = -1
+ internal var firstcellcol = -1
+ internal var lastcellrow = -1
+ internal var lastcellcol = -1
+ /**
+ * gets whether this CellRange will add blank records to the WorkBook for any
+ * missing Cells contained within the range.
+ *
+ * @return true if should create blank records for missing Cells
+ */
+ /**
+ * set whether this CellRange will add blank records to the WorkBook for any
+ * missing Cells contained within the range.
+ *
+ * @param boolean b - true if should create blank records for missing Cells
+ */
+ var createBlanks = false
+ private var initializeCells = true
+ @Transient
+ var cells: Array? = null
+ @Transient
+ protected var range: String? = null
+ @Transient
+ protected var sheetname: String? = null
+ /**
+ * @return the workbook object attached to this CellRange
+ */
+ /**
+ * attach the workbook for this CellRange
+ *
+ * @param WorkBook bk
+ */
+ @Transient
+ var workBook: WorkBook? = null
+ @Transient
+ private var sheet: WorkSheetHandle? = null
+ private var myrowints: IntArray? = null
+ private var mycolints: IntArray? = null
+ @Transient
+ private var myrows: Array? = null
+ @Transient
+ private var mycols: Array? = null
+
+ // for OOXML External References
+ protected var externalLink1 = 0
+ protected var externalLink2 = 0
+
+ internal var fmtr: FormatHandle? = null
+ internal var wholeCol = false
+ internal var wholeRow = false
+
+ /**
+ * Gets the number of columns in the range.
+ */
+ val width: Int
+ get() = lastcellcol - firstcellcol + 1
+
+ /**
+ * Gets the number of rows in the range.
+ */
+ val height: Int
+ get() = lastcellrow - firstcellrow + 1
+
+ /**
+ * Returns an array of the row numbers referenced by this CellRange
+ *
+ * @return int[] array of row ints
+ */
+ val rowInts: IntArray
+ get() {
+ if (myrowints != null)
+ return myrowints
+ val numrows = lastcellrow + 1 - firstcellrow
+ myrowints = IntArray(numrows)
+ for (t in 0 until numrows) {
+ myrowints[t] = firstcellrow + t
+ }
+ return myrowints
+ }
+
+ /**
+ * returns an array of column numbers referenced by this CellRange
+ *
+ * @return int[] array of col ints
+ */
+ val colInts: IntArray
+ get() {
+ if (mycolints != null)
+ return mycolints
+ val numcols = lastcellcol + 1 - firstcellcol
+ mycolints = IntArray(numcols)
+ for (t in 0 until numcols) {
+ mycolints[t] = firstcellcol + t
+ }
+ return mycolints
+ }
+
+ /**
+ * Returns an array of Rows (RowHandles) referenced by this CellRange
+ *
+ * @return RowHandle[] array of row handles
+ */
+ // typically empty rows
+ val rows: Array
+ @Throws(RowNotFoundException::class)
+ get() {
+ if (myrows != null)
+ return myrows
+ val numrows = lastcellrow + 1 - firstcellrow
+ myrows = arrayOfNulls(numrows)
+ for (t in 0 until numrows) {
+ var rx: RowHandle? = null
+ try {
+ rx = sheet!!.getRow(firstcellrow - 1 + t)
+ } catch (x: Exception) {
+ }
+
+ myrows[t] = rx
+ }
+ return myrows
+ }
+
+ /**
+ * Get the number of rows that this CellRange encompasses
+ *
+ * @return
+ */
+ val numberOfRows: Int
+ get() = lastcellrow + 1 - firstcellrow
+
+ /**
+ * Returns an array of Columns (ColHandles) referenced by this CellRange
+ *
+ * @return ColHandle[] array of columns handles
+ */
+ val cols: Array
+ @Throws(ColumnNotFoundException::class)
+ get() {
+ if (mycols != null)
+ return mycols
+ val numcols = lastcellcol + 1 - firstcellcol
+ mycols = arrayOfNulls(numcols)
+ for (t in 0 until numcols) {
+ mycols[t] = sheet!!.getCol(firstcellcol + t)
+ }
+ return mycols
+ }
+
+ /**
+ * Get the number of columns that this CellRange encompasses
+ *
+ * @return
+ */
+ val numberOfCols: Int
+ get() = lastcellcol + 1 - firstcellcol
+
+ /**
+ * Return a list of the cells in this cell range
+ *
+ * @return List of CellHandles
+ */
+ val cellList: List
+ get() = Arrays.asList(*cells!!)
+
+ /**
+ * get the underlying Cell Records in this range
+ get() {
+ val ch = this.getCells()
+ val ret = arrayOfNulls(ch!!.size)
+ for (t in ret.indices) {
+ if (ch[t] != null)
+ ret[t] = ch[t].cell
+ }
+ return ret
+ }
+
+ /*
+ * reset the underlying cell records in this range ")
+ val cx = this.getCells()
+ sb.append("\r\n")
+ for (t in cx!!.indices) {
+ sb.append(cx[t].xml)
+ sb.append("\r\n")
+ }
+ sb.append(xmlResponsePost)
+ return sb.toString()
+ }
+
+ /**
+ * gets the array of Cells in this Name
+ *
+ *
+ * Thus this method is limited to use with 2D ranges.
+ *
+ * @param fragment whether to enclose result in NameHandle tag
+ * @return Cell[] all Cells defined in this Name
+ */
+ val cellRangeXML: String
+ get() {
+ val sbx = StringBuffer()
+ sbx.append("")
+ sbx.append(xml)
+ return sbx.toString()
+ }
+
+ /**
+ * Gets the coordinates of this cell range,
+ *
+ * @return int[5]: [0] first row (zero based, ie row 1=0), [1] first column, [2]
+ * last row (zero based, ie row 1=0), [3] last column, [4] number of
+ * cells in range
+ */
+ // qualify sheet and reset range - necessary if sheetname with spaces is used in
+ // formula parsing
+ /*
+ * check for R1C1
+ */// no range
+ // get the first cell's coordinates
+ // get the last cell's coordinates
+ // handle swapped cells ie: "B1:A1"
+ // not an error if it is a whole column or whole row range
+ // what should numcells be for wholerow?
+ // what should numcells be for wholecol?
+ // trap OOXML external reference link, if any
+ val coords: IntArray
+ @Throws(CellNotFoundException::class)
+ get() {
+ var numrows = 0
+ var numcols = 0
+ var numcells = 0
+ val coords = IntArray(5)
+ var temprange = range
+ val s = ExcelTools.stripSheetNameFromRange(temprange!!)
+ temprange = s[1]
+ sheetname = GenericPtg.qualifySheetname(s[0])
+ if (sheetname != null && sheetname != "") {
+ if (s[2] == null)
+ this.range = "$sheetname!$temprange"
+ else {
+ s[2] = GenericPtg.qualifySheetname(s[2])
+ this.range = sheetname + ":" + s[2] + "!" + temprange
+ }
+ }
+ if (temprange!!.indexOf("R") == 0 && temprange.indexOf("C") > 1
+ && Character.isDigit(temprange[temprange.indexOf("C") - 1])) {
+
+ val b = ExcelTools.getRangeRowCol(temprange)
+
+ numrows = b[2] - b[0]
+ if (numrows <= 0)
+ numrows = 1
+
+ numcols = b[3] - b[2]
+ if (numcols <= 0)
+ numcols = 1
+
+ numcells = numrows * numcols
+
+ val retr = IntArray(5)
+ retr[0] = b[0]
+ retr[1] = b[1]
+ retr[2] = b[2]
+ retr[3] = b[3]
+ retr[4] = numcells
+ return retr
+ }
+ var startcell = ""
+ var endcell = ""
+ val lastcolon = temprange.lastIndexOf(":")
+ endcell = temprange.substring(lastcolon + 1)
+ if (lastcolon == -1)
+ startcell = endcell
+ else
+ startcell = temprange.substring(0, lastcolon)
+
+ startcell = StringTool.strip(startcell, "$")
+ endcell = StringTool.strip(endcell, "$")
+ var charct = startcell.length
+ while (charct > 0) {
+ if (!Character.isDigit(startcell[--charct])) {
+ charct++
+ break
+ }
+ }
+ val firstcellrowstr = startcell.substring(charct)
+ firstcellrow = Integer.parseInt(firstcellrowstr)
+ val firstcellcolstr = startcell.substring(0, charct)
+ firstcellcol = ExcelTools.getIntVal(firstcellcolstr)
+ charct = endcell.length
+ while (charct > 0) {
+ if (!Character.isDigit(endcell[--charct])) {
+ charct++
+ break
+ }
+ }
+ val lastcellrowstr = endcell.substring(charct)
+ lastcellrow = Integer.parseInt(lastcellrowstr)
+ val lastcellcolstr = endcell.substring(0, charct)
+ lastcellcol = ExcelTools.getIntVal(lastcellcolstr)
+ numrows = lastcellrow - firstcellrow + 1
+ numcols = lastcellcol - firstcellcol + 1
+
+ numcells = numrows * numcols
+ if (numcells < 0)
+ numcells *= -1
+
+ coords[0] = firstcellrow - 1
+ coords[1] = firstcellcol
+ coords[2] = lastcellrow - 1
+ coords[3] = lastcellcol
+ coords[4] = numcells
+ if (firstcellrow < 0 && lastcellrow < 0 || firstcellcol < 0 || lastcellcol < 0) {
+ if (firstcellcol == -1 && lastcellcol == -1) {
+ wholeRow = true
+ } else if (firstcellrow == -1 && lastcellrow == -1) {
+ wholeCol = true
+ } else
+ Logger.logErr("CellRange.getRangeCoords: Error in Range " + range!!)
+ }
+ if (s[3] != null)
+ externalLink1 = Integer.valueOf(s[3].substring(1, s[3].length - 1)).toInt()
+ if (s[4] != null)
+ externalLink2 = Integer.valueOf(s[4].substring(1, s[4].length - 1)).toInt()
+
+ return coords
+
+ }
+
+ /**
+ * Gets the coordinates of this cell range.
+ *
+ * @return int[5]: [0] first row, [1] first column, [2] last row, [3] last
+ * column, [4] number of cells in range
+ */
+ val rangeCoords: IntArray
+ @Deprecated("{@link #getCoords()} instead, which returns zero based values for\n" +
+ " rows.")
+ @Throws(CellNotFoundException::class)
+ get() {
+ val ordinalValues = this.coords
+ ordinalValues[0] += 1
+ ordinalValues[2] += 1
+ return ordinalValues
+ }
+
+ /**
+ * Return the String cell address of this range in R1C1 format
+ *
+ * @return String range in R1C1 format
+ */
+ // rangecoords are already 1-based
+ val r1C1Range: String
+ get() {
+ var rc1x = "R"
+ try {
+ val rc1 = this.rangeCoords
+ rc1x += rc1[0] + 1
+ rc1x += "C" + rc1[1]
+ rc1x += ":R" + (rc1[2] + 1)
+ rc1x += "C" + rc1[3]
+
+ } catch (e: CellNotFoundException) {
+ Logger.logErr("CellRange.getR1C1Range failed", e)
+ }
+
+ return rc1x
+ }
+
+ /**
+ * Return a json object representing this cell range, entries contain only
+ * address and values for more compact space
+ *
+ * @param range
+ * @param wbh
+ * @return
+ */
+ // should this possibly be full
+ val basicJSON: JSONObject
+ get() {
+ try {
+ val crObj = JSONObject()
+ crObj.put(JSON_RANGE, this.getRange())
+ val rangeArray = JSONArray()
+ val cells = this.getCells()
+ for (j in cells!!.indices) {
+ val result = JSONObject()
+ val addy = cells[j].cellAddress
+ val `val` = cells[j].`val`!!.toString()
+ result.put(JSON_LOCATION, addy)
+ result.put(JSON_CELL_VALUE, `val`)
+ rangeArray.put(result)
+ }
+ crObj.put(JSON_CELLS, rangeArray)
+ return crObj
+ } catch (e: Exception) {
+ Logger.logErr("Error obtaining CellRange $range JSON: $e")
+ }
+
+ return JSONObject()
+ }
+
+ /**
+ * Return a json object representing this cell range with full cell information
+ * embedded.
+ */
+ val json: JSONObject
+ get() {
+ val theRange = JSONObject()
+ val cells = JSONArray()
+ try {
+ theRange.put(JSON_RANGE, getRange())
+ val chandles = getCells()
+ for (i in chandles!!.indices) {
+ val thisCell = chandles[i]
+ val result = JSONObject()
+
+ result.put(JSON_CELL, thisCell.jsonObject)
+ cells.put(result)
+ }
+ theRange.put(JSON_CELLS, cells)
+ } catch (e: JSONException) {
+ Logger.logErr("Error getting cellRange JSON: $e")
+ }
+
+ return theRange
+ }
+
+ /**
+ * Protected constructor for creating result ranges.
+ */
+ protected constructor(sheet: WorkSheetHandle, row: Int, col: Int, width: Int, height: Int) {
+ this.sheet = sheet
+ sheetname = sheet.sheetName
+ workBook = sheet.workBook
+
+ firstcellrow = row
+ firstcellcol = col
+ lastcellrow = row + height - 1
+ lastcellcol = col + width - 1
+
+ range = (sheetname + "!"
+ + ExcelTools.formatRange(intArrayOf(firstcellcol, firstcellrow, lastcellcol, lastcellrow)))
+
+ cells = arrayOfNulls(width * height)
+ }
+
+ /**
+ * Initializes a `CellRange` from a `CellRangeRef`. The
+ * source `CellRangeRef` instance must be qualified with a single
+ * resolved worksheet.
+ *
+ * @param source the `CellRangeRef` from which to initialize
+ * @param init whether to populate the cell array
+ * @param create whether to fill gaps in the range with blank cells
+ * @throws IllegalArgumentException if the source range does not have a resolved sheet or has more
+ * than one sheet
+ `` */
+ @JvmOverloads
+ constructor(source: CellRangeRef, init: Boolean = false, create: Boolean = true) {
+ initializeCells = init
+ createBlanks = create
+
+ sheet = source.firstSheet
+ if (sheet == null || source.isMultiSheet)
+ throw IllegalArgumentException("the source range must have a single resolved sheet")
+
+ workBook = this.sheet!!.workBook
+ sheetname = this.sheet!!.sheetName
+
+ // This is inefficient, but fixing it would require rewriting init.
+ this.range = source.toString()
+
+ try {
+ this.init()
+ } catch (e: CellNotFoundException) {
+ // this should be impossible
+ throw RuntimeException(e)
+ }
+
+ }
+
+ fun clearFormats() {
+ for (idx in cells!!.indices)
+ if (cells!![idx] != null)
+ cells!![idx].clearFormats()
+ }
+
+
+ @Deprecated("use clear()")
+ fun clearContents() {
+ for (idx in cells!!.indices)
+ if (cells!![idx] != null)
+ cells!![idx].clearContents()
+ }
+
+ /**
+ * clears the contents and formats of the cells referenced by this range but
+ * does not remove the cells from the workbook.
+ */
+ fun clear() {
+ for (idx in cells!!.indices)
+ if (cells!![idx] != null)
+ cells!![idx].clear()
+ }
+
+ /**
+ * removes the cells referenced by this range from the sheet.
+ *
+ *
+ * NOTE: method does not shift rows or cols.
+ */
+ fun removeCells() {
+ for (idx in cells!!.indices)
+ if (cells!![idx] != null)
+ cells!![idx].remove(true)
+ }
+
+ /**
+ * Un-Merge the Cells contained in this CellRange
+ *
+ * @throws Exception
+ */
+ @Throws(Exception::class)
+ fun unMergeCells() {
+ val mycells = this.cellRecs
+ for (t in mycells.indices) {
+ mycells[t].mergeRange = null // unset the range of merged cells
+ mycells[t].xfRec.merged = false
+ }
+ val mc = this.getSheet()!!.sheet!!.mergedCellsRec
+ mc?.removeCellRange(this)
+ this.isMerged = false
+ }
+
+ /**
+ * Set the format ID of all cells in this CellRange ? {
+ if (isDirty)
+ try {
+ init()
+ } catch (e: CellNotFoundException) {
+ }
+
+ return cells
+ }
+
+ /**
+ * Constructor which creates a new CellRange from a String range , ascending: Boolean) {
+ this.createBlanks()
+ val sortRow = this.getCellsByRow(rownumber)
+ Collections.sort(sortRow, comparator)
+ if (!ascending)
+ Collections.reverse(sortRow)
+ // now we have sorted the array list, come up with a map to resort the rows.
+ var coords: IntArray? = null
+ try {
+ coords = this.rangeCoords
+ // fix stupid wrong offsets;
+ coords[0] = coords[0]--
+ coords[2] = coords[2]--
+ } catch (e1: CellNotFoundException) {
+ }
+
+ val outputCols = ArrayList>()
+ for (i in sortRow.indices) {
+ val cell = sortRow[i]
+ var cells: ArrayList<*>? = null
+ try {
+ cells = this.getCellsByCol(ExcelTools.getAlphaVal(cell.colNum))
+ } catch (e: ColumnNotFoundException) {
+ // if there are no cells in this column ignore it
+ }
+
+ outputCols.add(cells)
+ }
+ this.removeCells()
+ for (i in coords!![1]..coords[3]) {
+ val cells = outputCols[i - coords[1]]
+ for (x in cells.indices) {
+ val cell = cells[x] as CellHandle
+ val bs = this.getSheet()!!.boundsheet
+ cell.cell!!.setCol(i.toShort())
+ bs!!.addCell(cell.cell as CellRec)
+ }
+ }
+
+ }
+
+ /**
+ * Changes the cellRange to a createBlanks cellrange and re-initializes the
+ * range, creating the missing blanks.
+ */
+ private fun createBlanks() {
+ if (!this.createBlanks) {
+ this.createBlanks = true
+ this.initializeCells = true
+ try {
+ this.init()
+ } catch (e: CellNotFoundException) {
+ }
+
+ }
+ }
+
+ /**
+ * Resort all cells in the range according to the rownumber passed in.
+ *
+ * @param rownumber the 0 based row number
+ * @param ascending
+ * @throws RowNotFoundException
+ * @throws ColumnNotFoundException
+ */
+ @Throws(RowNotFoundException::class)
+ fun sort(rownumber: Int, ascending: Boolean) {
+ val cp = CellComparator()
+ this.sort(rownumber, cp, ascending)
+ }
+
+ /**
+ * Re-sort all cells in this cell range according to the column.
+ *
+ *
+ * A custom comparator can be passed in, or the default one can be used with
+ * sort(String, boolean).
+ *
+ *
+ * Comparators will be passed 2 CellHandle objects for comparison.
+ *
+ *
+ * * Collections.reverse will be called on the results if ascending is set to
+ * false;
+ *
+ * @param columnName
+ * @param comparator
+ * @throws RowNotFoundException
+ * @throws ColumnNotFoundException
+ */
+ @Throws(ColumnNotFoundException::class)
+ fun sort(columnName: String, comparator: Comparator<*>, ascending: Boolean) {
+ if (!this.createBlanks) {
+ // we cannot have empty cells in this operation
+ this.createBlanks = true
+ try {
+ this.init()
+ } catch (e: CellNotFoundException) {
+ }
+
+ }
+ val sortCol = this.getCellsByCol(columnName)
+ Collections.sort(sortCol, comparator)
+ if (!ascending)
+ Collections.reverse(sortCol)
+ // now we have sorted the array list, come up with a map to resort the rows.
+ var coords: IntArray? = null
+ try {
+ coords = this.rangeCoords
+ // fix stupid wrong offsets;
+ coords[0] = coords[0]--
+ coords[2] = coords[2]--
+ } catch (e1: CellNotFoundException) {
+ e1.printStackTrace()
+ }
+
+ val outputRows = ArrayList>()
+ for (i in sortCol.indices) {
+ var cells: ArrayList? = null
+ try {
+ cells = this.getCellsByRow(sortCol[i].rowNum)
+ } catch (e: RowNotFoundException) {
+ // ignore if no cells available
+ }
+
+ outputRows.add(cells)
+ }
+ this.removeCells()
+ for (i in coords!![0]..coords[2]) {
+ val cells = outputRows[i - coords[0]]
+ for (x in cells.indices) {
+ val cell = cells[x]
+ val bs = this.getSheet()!!.boundsheet
+ cell.cell!!.rowNumber = i - 1
+ bs!!.addCell(cell.cell as CellRec)
+ }
+ }
+ }
+
+ /**
+ * Resort all cells in the range according to the column passed in.
+ *
+ * @param columnName
+ * @param ascending
+ * @throws ColumnNotFoundException
+ * @throws RowNotFoundException
+ */
+ @Throws(ColumnNotFoundException::class)
+ fun sort(columnName: String, ascending: Boolean) {
+ val cp = CellComparator()
+ this.sort(columnName, cp, ascending)
+ }
+
+ /**
+ * gets the array of Cells in this Name
+ *
+ *
+ * NOTE: this method variation also returns the Sheetname for the name record if
+ * not null.
+ *
+ *
+ * Thus this method is limited to use with 2D ranges.
+ *
+ * @param fragment whether to enclose result in NameHandle tag
+ * @return Cell[] all Cells defined in this Name
+ */
+ fun getCellRangeXML(fragment: Boolean): String {
+ val sbx = StringBuffer()
+ if (!fragment)
+ sbx.append("")
+ sbx.append("")
+ sbx.append(xml)
+ sbx.append("")
+ return sbx.toString()
+ }
+
+ /**
+ * Constructor which creates a new CellRange using an array of cells as it's
+ * constructor. ) {
+ this.workBook = newcells[0].workBook
+ this.sheet = newcells[0].workSheetHandle
+ for (x in newcells.indices) {
+ this.addCellToRange(newcells[x])
+ }
+ this.init()
+ }
+
+ /**
+ * create a new CellRange using an array of cells as it's constructor. , createblanks: Boolean) {
+ this.createBlanks = createblanks
+ this.workBook = newcells[0].workBook
+ this.sheet = newcells[0].workSheetHandle
+ for (x in newcells.indices) {
+ this.addCellToRange(newcells[x])
+ }
+ this.init()
+ }
+
+ /**
+ * Returns the WorkSheet referenced in this CellRange.
+ *
+ * @return WorkSheetHandle sheet referenced in this CellRange.
+ */
+ fun getSheet(): WorkSheetHandle? {
+ return sheet
+ }
+
+ /**
+ * initializes this CellRange
+ *
+ * @throws CellNotFoundException
+ */
+ @Throws(CellNotFoundException::class)
+ fun init() {
+ if (!FormulaParser.isComplexRange(range)) {
+ val coords = this.rangeCoords
+ var rowctr = coords[0]
+ val firstcellcol = coords[1]
+ val lastcellcol = coords[3]
+ val numcells = coords[4]
+
+ var cellctr = firstcellcol - 1
+ try {
+ if (sheetname != null) {
+ if (sheetname == "")
+ // 20080214 KSC - is this a good idea?
+ // default to work sheet 0
+ sheetname = this.workBook!!.getWorkSheet(0).sheetName
+ }
+ if (sheetname == null) {
+ if (this.sheet != null)
+ sheetname = this.sheet!!.sheetName
+ else
+ throw IllegalArgumentException("sheet name not specified: " + range!!)
+ }
+
+ var s = sheetname
+ if (s != null) {
+ // handle enclosing apostrophes which are added to PtgRefs
+ if (s[0] == '\'') {
+ s = s.substring(1)
+ if (s[s.length - 1] == '\'') {
+ s = s.substring(0, s.length - 1)
+ }
+ }
+ }
+ sheet = workBook!!.getWorkSheet(s)
+ // if wholerow or wholecol, don't gather cells
+ if (this.wholeCol || this.wholeRow)
+ return
+ cells = arrayOfNulls(numcells)
+ var resetFastAdds = false
+ if (sheet!!.fastCellAdds && this.createBlanks) {
+ resetFastAdds = true
+ sheet!!.fastCellAdds = false
+ }
+ for (i in 0 until numcells) {
+ if (cellctr == lastcellcol) {// if its the end of the row,
+ // increment row.
+ cellctr = firstcellcol - 1
+ rowctr++
+ }
+ ++cellctr
+ try {
+ // use caching 20080917 KSC: PROBLEM HERE [Claritas
+ // BugTracker 1862]
+ if (this.initializeCells)
+ cells[i] = sheet!!.getCell(rowctr - 1, cellctr, sheet!!.useCache) // 20080917 KSC: use
+ // cache
+ // setting instead of
+ // defaulting to true);
+ } catch (e: CellNotFoundException) {
+ if (this.createBlanks) {
+ cells[i] = sheet!!.add(null, rowctr - 1, cellctr)
+ }
+
+ }
+
+ }
+ if (resetFastAdds) {
+ sheet!!.fastCellAdds = true
+ }
+ } catch (e: WorkSheetNotFoundException) {
+ throw IllegalArgumentException(e.toString())
+ }
+
+ } else { // gather cells for a complex range ...
+ val pm = io.starter.formats.XLS.formulas.PtgMemFunc()
+ val b = XLSRecord()
+ b.workBook = this.workBook!!.workBook
+ pm.parentRec = b
+ try {
+ pm.location = range
+ val p = pm.components
+ val cellsfromcomplexrange = java.util.ArrayList()
+ for (i in p!!.indices) {
+ try {
+ cellsfromcomplexrange.add(workBook!!.getCell((p[i] as PtgRef).location))
+ } catch (e: CellNotFoundException) {
+ if (this.createBlanks) {
+ cells[i] = sheet!!.add(null, p[i].location)
+ }
+ }
+
+ }
+ cells = arrayOfNulls(cellsfromcomplexrange.size)
+ cells = cellsfromcomplexrange.toTypedArray()
+ } catch (e: Exception) {
+ throw IllegalArgumentException(e.toString())
+ }
+
+ }
+ isDirty = false
+ }
+
+ /**
+ * Initializes this `CellRange`'s cell list if necessary. This method
+ * is useful if this `CellRange` was created with
+ * `initCells` set to `false` and it is later necessary to
+ * retrieve the cell list.
+ *
+ * @param createBlanks whether missing cells should be created as blanks. If this is
+ * `false` they will appear in the cell list as
+ * `null`s.
+ */
+ fun initCells(createBlanks: Boolean) {
+ // If we don't need to do anything, return
+ if (initializeCells == true && (!createBlanks || this.createBlanks))
+ return
+
+ this.initializeCells = true
+ this.createBlanks = createBlanks
+
+ try {
+ this.init()
+ } catch (e: CellNotFoundException) {
+ // This will never actually happen but we have to catch it anyway
+ throw Error()
+ }
+
+ }
+
+ /**
+ * Return the String representation of this range
+ *
+ * @return the String range
+ */
+ fun getRange(): String? {
+ return range
+ }
+
+ /**
+ * Sets the range of cells for this CellRange to a string range
+ *
+ * @param String rng - Range string
+ */
+ fun setRange(rng: String) {
+ range = rng
+ try {
+ this.init()
+ } catch (e: CellNotFoundException) {
+ // don't have to report anything
+ }
+
+ }
+
+ /**
+ * sets a border around the range of cells
+ *
+ * @param int width - line width
+ * @param int linestyle - line style
+ * @param java.awt.Color colr - color of border line
+ */
+ fun setBorder(width: Int, linestyle: Int, colr: java.awt.Color) {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ val coords = getEdgePositions(ch[t], width)
+ // create Excel border -- top, left, bottom, right
+ if (coords[0] > 0) {
+ ch[t].setTopBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderTopColor(colr)
+ }
+ if (coords[1] > 0) {
+ ch[t].setLeftBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderLeftColor(colr)
+ }
+ if (coords[2] > 0) {
+ ch[t].setBottomBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderBottomColor(colr)
+ }
+ if (coords[3] > 0) {
+ ch[t].setRightBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderRightColor(colr)
+ }
+ }
+ }
+
+ /**
+ * update the CellRange when the underlying Cells change their location
+ *
+ * @return boolean true if the CellRange could be updated, false if there are no
+ * cells represented by this range
+ */
+ fun update(): Boolean {
+ if (cells == null)
+ return false // this is an invalid range -- see Mergedcells prob.
+ // jm
+
+ // arbitrarily set the initial vals...
+ if (cells!![0] != null) { // 20100106 KSC: if didn't create blanks it's possible that cells are null
+ firstcellrow = cells!![0].rowNum + 1
+ firstcellcol = cells!![0].colNum
+ lastcellrow = cells!![0].rowNum + 1
+ lastcellcol = cells!![0].colNum
+ for (t in cells!!.indices) {
+ val cx = cells!![t]
+ // 20090901 KSC: apparently can be null
+ if (cx != null)
+ this.addCellToRange(cx)
+ }
+ this.myrowints = null
+ this.mycolints = null
+ return true
+ } else if (this.range != null) {// 20100106 KSC: handle ranges containing null cell[0] (i.e. ranges referencing
+ // cells not present and createBlanks==false)
+ if (this.DEBUG)
+ Logger.logWarn("CellRange.update: trying to access blank cells in range " + this.range!!)
+ try {
+ this.rangeCoords
+ return true
+ } catch (e: CellNotFoundException) { // shouldn't
+ return false
+ }
+
+ }
+ return false // return false if it doesn't have it's cells defined
+ }
+
+ /**
+ * Sets the sheet reference for this CellRange.
+ *
+ * @param WorkSheetHandle aSheet
+ */
+ fun setSheet(aSheet: WorkSheetHandle) {
+ this.sheet = aSheet
+ this.sheetname = aSheet.sheetName
+ }
+
+ /**
+ * Copies this range to another location. At present only contents and complete
+ * formats may be copied.
+ *
+ * @param row the topmost row of the target area
+ * @param col the leftmost column of the target area
+ * @param what a set of flags determining what will be copied
+ * @return the destination range
+ */
+ fun copy(sheet: WorkSheetHandle, row: Int, col: Int, what: Int): CellRange {
+ var row = row
+ var col = col
+ val result = CellRange(sheet, row, col, this.width, this.height)
+
+ val first_col = col
+
+ // note these are not currently used, see setting below
+ val copy_contents = what and COPY_CONTENTS != 0
+ var copy_formulas = what and COPY_FORMULAS != 0
+ var copy_formats = what and COPY_FORMATS != 0
+
+ // set to true until this thing is fully implemented
+ copy_formats = true
+ copy_formulas = true
+
+ var cur_row = cells!![0].rowNum
+ for (idx in cells!!.indices) {
+ val source = cells!![idx]
+
+ if (source.rowNum != cur_row) {
+ cur_row = source.rowNum
+ row++
+ col = first_col
+ }
+
+ var target: CellHandle? = null
+ try {
+ target = sheet.getCell(row, col)
+ } catch (e: CellNotFoundException) {
+ }
+
+ val formatID: Int
+ if (copy_formats)
+ formatID = source.formatId
+ else if (target != null)
+ formatID = target.formatId
+ else
+ formatID = sheet.workBook!!.workBook!!.defaultIxfe
+
+ if (copy_contents) {
+ val value: Any?
+
+ if (copy_formulas && source.isFormula) {
+ try {
+ value = source.formulaHandle.formulaString
+ } catch (e: FormulaNotFoundException) {
+ // This shouldn't happen; we known the formula exists.
+ // If it does happen it indicates a bug in OpenXLS,
+ // thus we throw an Error.
+ throw Error("formula cell has no Formula record", e)
+ }
+
+ } else {
+ value = source.`val`
+ }
+
+ target = sheet.add(value, row, col, formatID)
+
+ if (target!!.isFormula)
+ try {
+ FormulaHandle.moveCellRefs(target.formulaHandle,
+ intArrayOf(row - source.rowNum, col - source.colNum))
+ } catch (e: FormulaNotFoundException) {
+ }
+
+ } else if (target == null) {
+ target = sheet.add(null, row, col, formatID)
+ }
+
+ if (copy_formats) {
+ target!!.formatId = formatID
+ }
+
+ result.cells[idx] = target
+ col++
+ }
+
+ return result
+ }
+
+ /**
+ * Fills this range from the given cell.
+ *
+ * @param source the cell whose attributes should be copied or `null` to
+ * copy from the first cell in the range
+ * @param what a set of flags determining what will be copied
+ * @param increment the amount by which to increment numeric values or
+ * `NaN` for no increment
+ */
+ fun fill(source: CellHandle?, what: Int, increment: Double) {
+ var source = source
+ if (null == source)
+ source = cells!![0]
+
+ val copy_contents = what and COPY_CONTENTS != 0
+ val copy_formulas = what and COPY_FORMULAS != 0
+ val copy_formats = what and COPY_FORMATS != 0
+
+ val sourceRow = source.rowNum
+ val sourceCol = source.colNum
+
+ var value: Any? = null
+ if (copy_contents) {
+ if (copy_formulas && source.isFormula) {
+ try {
+ value = source.formulaHandle.formulaString
+ } catch (e: FormulaNotFoundException) {
+ throw Error("formula cell has no Formula record", e)
+ }
+
+ } else {
+ value = source.`val`
+ }
+ }
+
+ // if increment is set, ensure the value can be incremented
+ if (!java.lang.Double.isNaN(increment) && !(copy_contents && value is Number))
+ throw IllegalArgumentException("cannot increment unless filling with a numeric value")
+
+ for (idx in cells!!.indices) {
+ var target: CellHandle? = cells!![idx]
+
+ // don't overwrite the source cell
+ if (source == target)
+ continue
+
+ if (!java.lang.Double.isNaN(increment))
+ value = (value as Number).toDouble() + increment
+
+ val formatID = (if (copy_formats) source else target).formatId
+
+ if (copy_contents) {
+ target = sheet!!.add(value, target!!.rowNum, target.colNum, formatID)
+ cells[idx] = target
+
+ if (target!!.isFormula)
+ try {
+ FormulaHandle.moveCellRefs(target.formulaHandle,
+ intArrayOf(target.rowNum - sourceRow, target.colNum - sourceCol))
+ } catch (e: FormulaNotFoundException) {
+ }
+
+ }
+
+ // when adding Date values passing the format ID to sheet.add
+ // doesn't set the format so we always set it here
+ if (copy_formats) {
+ target!!.formatId = formatID
+ }
+
+ }
+ }
+
+ fun calculateAffectedCellsOnSheet(): Collection {
+ val affected = HashSet()
+ for (cell in cells!!) {
+ if (cell != null) {
+ affected.add(cell)
+ affected.addAll(cell.calculateAffectedCellsOnSheet())
+ }
+ }
+ return affected
+ }
+
+ /**
+ * Get the cells from a particular rownumber, constrained by the boundaries of
+ * the cellRange
+ *
+ * @param rownumber
+ */
+ @Throws(RowNotFoundException::class)
+ fun getCellsByRow(rownumber: Int): ArrayList {
+ val al = ArrayList()
+ val r = this.getSheet()!!.getRow(rownumber)
+ val cells = r.cells
+ var coords: IntArray? = null
+ try {
+ coords = this.rangeCoords
+ } catch (e: CellNotFoundException) {
+ throw RowNotFoundException("Error getting internal coordinates for CellRange$e")
+ }
+
+ for (i in cells.indices) {
+ if (cells[i].colNum >= coords[1] && cells[i].colNum <= coords[3]) {
+ al.add(cells[i])
+ }
+ }
+ return al
+ }
+
+ /**
+ * Get the cells from a particular column, constrained by the boundaries of the
+ * cellRange
+ *
+ * @param rownumber
+ * @throws ColumnNotFoundException
+ */
+ @Throws(ColumnNotFoundException::class)
+ fun getCellsByCol(col: String): ArrayList {
+ val al = ArrayList()
+ val r = this.getSheet()!!.getCol(col)
+ val cells = r.cells
+ var coords: IntArray? = null
+ try {
+ coords = this.rangeCoords
+ coords[0] = coords[0] - 1
+ coords[2] = coords[2] - 1
+ } catch (e: CellNotFoundException) {
+ throw ColumnNotFoundException("Error getting internal coordinates for CellRange$e")
+ }
+
+ for (i in cells.indices) {
+ if (cells[i].rowNum >= coords[0] && cells[i].rowNum <= coords[2]) {
+ al.add(cells[i])
+ }
+ }
+ return al
+ }
+
+ /**
+ * removes the border from all of the cells in this range
+ */
+ fun removeBorder() {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ ch[t].removeBorder()
+ }
+ }
+
+ /**
+ * Sets a bottom border on all cells in the cellrange
+ *
+ *
+ * Linestyle should be set through the FormatHandle constants
+ */
+ fun setInnerBorderBottom(linestyle: Int, colr: java.awt.Color) {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ ch[t].setBottomBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderBottomColor(colr)
+ }
+ }
+
+ /**
+ * Sets a right border on all cells in the cellrange
+ *
+ *
+ * Linestyle should be set through the FormatHandle constants
+ */
+ fun setInnerBorderRight(linestyle: Int, colr: java.awt.Color) {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ ch[t].setRightBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderRightColor(colr)
+ }
+ }
+
+ /**
+ * Sets a left border on all cells in the cellrange
+ *
+ *
+ * Linestyle should be set through the FormatHandle constants
+ */
+ fun setInnerBorderLeft(linestyle: Int, colr: java.awt.Color) {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ ch[t].setLeftBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderLeftColor(colr)
+ }
+ }
+
+ /**
+ * Sets a top border on all cells in the cellrange
+ *
+ *
+ * Linestyle should be set through the FormatHandle constants
+ */
+ fun setInnerBorderTop(linestyle: Int, colr: java.awt.Color) {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ ch[t].setTopBorderLineStyle(linestyle.toShort())
+ ch[t].setBorderTopColor(colr)
+ }
+ }
+
+ /**
+ * Sets a surround border on all cells in the cellrange
+ *
+ *
+ * Linestyle should be set through the FormatHandle constants
+ */
+ fun setInnerBorderSurround(linestyle: Int, colr: java.awt.Color) {
+ val ch = getCells()
+ for (t in ch!!.indices) {
+ ch[t].setBorderColor(colr)
+ ch[t].setBorderLineStyle(linestyle.toShort())
+ }
+ }
+
+ companion object {
+
+ /**
+ *
+ */
+ private const val serialVersionUID = -3609881364824289079L
+ val REMOVE_MERGED_CELLS = true
+ val RETAIN_MERGED_CELLS = false
+
+ var xmlResponsePre = ""
+ var xmlResponsePost = " "
+
+ /**
+ * Whether to copy the cell contents.
+ */
+ val COPY_CONTENTS = 0x01
+
+ /**
+ * Whether formulas should be copied. If this bit is not set the formula result
+ * will be copied instead.
+ */
+ val COPY_FORMULAS = 0x02
+
+ val COPY_FORMATS = 0x0100
+
+ /**
+ * return a JSON array of cell values for the given range ? {
+ val cr = CellRange(range, wbh, true)
+ return cr.getCells()
+ }
+ }
+
+}
+/**
+ * Initializes a `CellRange` from a `CellRangeRef`. The
+ * source `CellRangeRef` instance must be qualified with a single
+ * resolved worksheet.
+ *
+ * @param source the `CellRangeRef` from which to initialize
+ * @throws IllegalArgumentException if the source range does not have a resolved sheet or has more
+ * than one sheet
+`` */
+/**
+ * Constructor to create a new CellRange from a WorkSheetHandle and a set of
+ * range coordinates: Starter Inc.
- *
- * @see DataBoundCellRange
- * @see XLSRecord
- */
-public class CellRangeRef implements Cloneable {
- private int first_col, first_row, last_col, last_row;
- private String first_sheet_name, last_sheet_name;
- private WorkSheetHandle first_sheet, last_sheet;
-
- /** Private nullary constructor for use by static pseudo-constructors. */
- private CellRangeRef() {
- }
-
- public CellRangeRef(int first_row, int first_col, int last_row, int last_col) {
- this.first_row = first_row;
- this.first_col = first_col;
- this.last_row = last_row;
- this.last_col = last_col;
- }
-
- /**
- * return the number of cells in this rangeref
- *
- * @return number of cells in ref
- */
- public int numCells() {
- int ret = -1;
- int numrows = this.last_row - this.first_row;
- numrows++;
- int numcols = this.last_col - this.first_col;
- numcols++;
- ret = numrows * numcols;
- return ret;
- }
-
- public CellRangeRef(int first_row, int first_col, int last_row, int last_col, String first_sheet,
- String last_sheet) {
- this(first_row, first_col, last_row, last_col);
- this.first_sheet_name = first_sheet;
- this.last_sheet_name = last_sheet;
- }
-
- public CellRangeRef(int first_row, int first_col, int last_row, int last_col, WorkSheetHandle first_sheet,
- WorkSheetHandle last_sheet) {
- this(first_row, first_col, last_row, last_col);
- this.first_sheet = first_sheet;
- this.last_sheet = last_sheet;
- }
-
- /**
- * Parses a range in A1 notation and returns the equivalent CellRangeRef.
- */
- public static CellRangeRef fromA1(String reference) {
- CellRangeRef ret = new CellRangeRef();
- String range;
-
- {
- String[] parts = ExcelTools.stripSheetNameFromRange(reference);
- ret.first_sheet_name = parts[0];
- range = parts[1];
- ret.last_sheet_name = parts[2];
- }
-
- if (range == null)
- throw new IllegalArgumentException("missing range component");
-
- {
- int[] parts = ExcelTools.getRangeRowCol(range);
- ret.first_row = parts[0];
- ret.first_col = parts[1];
- ret.last_row = parts[2];
- ret.last_col = parts[3];
- }
-
- return ret;
- }
-
- /**
- * Convenience method combining {@link #fromA1(String)} and
- * {@link #resolve(WorkBookHandle)}.
- */
- public static CellRangeRef fromA1(String reference, WorkBookHandle book) throws WorkSheetNotFoundException {
- CellRangeRef ret = fromA1(reference);
- ret.resolve(book);
- return ret;
- }
-
- /**
- * Resolves sheet names into sheet handles against the given book.
- *
- * @param book
- * the book against which the sheet names should be resolved
- * @throws WorkSheetNotFoundException
- * if either of the sheets does not exist in the given book
- */
- public void resolve(WorkBookHandle book) throws WorkSheetNotFoundException {
- if (first_sheet_name != null)
- first_sheet = book.getWorkSheet(first_sheet_name);
- if (last_sheet_name != null)
- last_sheet = book.getWorkSheet(last_sheet_name);
- }
-
- /**
- * Returns the lowest-indexed row in this range.
- *
- * @return the row index or null if this is a column range
- */
- public int getFirstRow() {
- return first_row;
- }
-
- /**
- * Returns the lowest-indexed column in this range.
- *
- * @return the column index or null if this is a row range
- */
- public int getFirstColumn() {
- return first_col;
- }
-
- /**
- * Returns the highest-indexed row in this range.
- *
- * @return the row index or null if this is a column range
- */
- public int getLastRow() {
- return last_row;
- }
-
- /**
- * Returns the highest-indexed column in this range.
- *
- * @return the column index or null if this is a row range
- */
- public int getLastColumn() {
- return last_col;
- }
-
- /**
- * Returns the name of the first sheet in this range.
- *
- * @return the name of the sheet or null if this range is not qualified with a
- * sheet
- */
- public String getFirstSheetName() {
- if (first_sheet != null)
- return first_sheet.getSheetName();
- else
- return first_sheet_name;
- }
-
- /**
- * Returns the first sheet in this range.
- *
- * @return the WorkSheetHandle or null if this range is not qualified with a
- * sheet or the sheet names have not been resolved
- */
- public WorkSheetHandle getFirstSheet() {
- return first_sheet;
- }
-
- /**
- * Returns the name of the last sheet in this range.
- *
- * @return the name of the sheet or null if this range is not qualified with a
- * sheet
- */
- public String getLastSheetName() {
- if (last_sheet != null)
- return last_sheet.getSheetName();
- else
- return last_sheet_name;
- }
-
- /**
- * Returns the last sheet in this range.
- *
- * @return the WorkSheetHandle or null if this range is not qualified with a
- * sheet or the sheet names have not been resolved
- */
- public WorkSheetHandle getLastSheet() {
- return last_sheet;
- }
-
- /**
- * Determines whether this range is qualified with a sheet.
- */
- public boolean hasSheet() {
- return first_sheet != null || first_sheet_name != null;
- }
-
- /**
- * Determines whether this range spans multiple sheets.
- */
- public boolean isMultiSheet() {
- return (first_sheet != null && last_sheet != null && first_sheet != last_sheet)
- || (first_sheet_name != null && last_sheet_name != null && first_sheet_name != last_sheet_name);
- }
-
- /**
- * Sets the first row in this range.
- *
- * @param value
- * the row index to set
- */
- public void setFirstRow(int value) {
- first_row = value;
- }
-
- /**
- * Sets the first column in this range.
- *
- * @param value
- * the column index to set
- */
- public void setFirstColumn(int value) {
- first_col = value;
- }
-
- /**
- * Sets the first sheet in this range.
- */
- public void setFirstSheet(WorkSheetHandle sheet) {
- first_sheet_name = null;
- first_sheet = sheet;
- }
-
- /**
- * Sets the last row in this range.
- *
- * @param value
- * the row index to set
- */
- public void setLastRow(int value) {
- last_row = value;
- }
-
- /**
- * Sets the last column in this range.
- *
- * @param value
- * the column index to set
- */
- public void setLastColumn(int value) {
- last_col = value;
- }
-
- /**
- * Sets the last sheet in this range.
- */
- public void setLastSheet(WorkSheetHandle sheet) {
- last_sheet_name = null;
- last_sheet = sheet;
- }
-
- /**
- * Returns whether this range entirely contains the given range. This ignores
- * the sheets, if any, and compares only the cell ranges.
- */
- public boolean contains(CellRangeRef range) {
- return this.first_row <= range.first_row && this.last_row >= range.last_row && this.first_col <= range.first_col
- && this.last_col >= range.last_col;
- }
-
- /**
- * Compares this range to the specified object. The result is true
- * if and only if the argument is not null and is a
- * CellRangeRef object that represents the same range as this
- * object.
- */
- @Override
- public boolean equals(Object other) {
- // if it's null or not a CellRangeRef it can't be equal
- if (other == null || !(other instanceof CellRangeRef))
- return false;
-
- return this.toString().equals(other.toString());
- }
-
- /** Creates and returns a copy of this range. */
- @Override
- public Object clone() {
- try {
- return super.clone();
- } catch (CloneNotSupportedException e) {
- // This can't happen (we're Cloneable) but we have to catch it
- throw new Error("Object.clone() threw CNSE but we're Cloneable");
- }
- }
-
- /** Gets this range in A1 notation. */
- @Override
- public String toString() {
- String sheet1 = getFirstSheetName();
- String sheet2 = getLastSheetName();
- return (sheet1 != null ? sheet1 + (sheet2 != null && sheet2 != sheet1 ? ":" + sheet2 : "") + "!" : "")
- + ExcelTools.formatRange(new int[] { first_col, first_row, last_col, last_row });
- }
-}
diff --git a/src/main/java/io/starter/OpenXLS/CellRangeRef.kt b/src/main/java/io/starter/OpenXLS/CellRangeRef.kt
new file mode 100644
index 0000000..114f09f
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/CellRangeRef.kt
@@ -0,0 +1,300 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ * Starter Inc.
- *
- * @see WorkBookHandle
- *
- */
-public class ChartHandle implements ChartConstants {
- // 20080114 KSC: delegate so visible
- public static final int BARCHART = ChartConstants.BARCHART;
- public static final int COLCHART = ChartConstants.COLCHART;
- public static final int LINECHART = ChartConstants.LINECHART;
- public static final int PIECHART = ChartConstants.PIECHART;
- public static final int AREACHART = ChartConstants.AREACHART;
- public static final int SCATTERCHART = ChartConstants.SCATTERCHART;
- public static final int RADARCHART = ChartConstants.RADARCHART;
- public static final int SURFACECHART = ChartConstants.SURFACECHART;
- public static final int DOUGHNUTCHART = ChartConstants.DOUGHNUTCHART;
- public static final int BUBBLECHART = ChartConstants.BUBBLECHART;
- public static final int OFPIECHART = ChartConstants.OFPIECHART;
- public static final int PYRAMIDCHART = ChartConstants.PYRAMIDCHART;
- public static final int CYLINDERCHART = ChartConstants.CYLINDERCHART;
- public static final int CONECHART = ChartConstants.CONECHART;
- public static final int PYRAMIDBARCHART = ChartConstants.PYRAMIDBARCHART;
- public static final int CYLINDERBARCHART = ChartConstants.CYLINDERBARCHART;
- public static final int CONEBARCHART = ChartConstants.CONEBARCHART;
- public static final int RADARAREACHART = ChartConstants.RADARAREACHART;
- public static final int STOCKCHART = ChartConstants.STOCKCHART;
-
- // legacy
- public static final int BAR = BARCHART;
- public static final int COL = COLCHART;
- public static final int LINE = LINECHART;
- public static final int PIE = PIECHART;
- public static final int AREA = AREACHART;
- public static final int SCATTER = SCATTERCHART;
- public static final int RADAR = RADARCHART;
- public static final int SURFACE = SURFACECHART;
- public static final int DOUGHNUT = DOUGHNUTCHART;
- public static final int BUBBLE = BUBBLECHART;
- public static final int RADARAREA = RADARAREACHART;
- public static final int PYRAMID = PYRAMIDCHART;
- public static final int CYLINDER = CYLINDERCHART;
- public static final int CONE = CONECHART;
- public static final int PYRAMIDBAR = PYRAMIDBARCHART;
- public static final int CYLINDERBAR = CYLINDERBARCHART;
- public static final int CONEBAR = CONEBARCHART;
- // axis types
- public static final int XAXIS = ChartConstants.XAXIS;
- public static final int YAXIS = ChartConstants.YAXIS;
- public static final int ZAXIS = ChartConstants.ZAXIS;
- public static final int XVALAXIS = ChartConstants.XVALAXIS; // an X axis type but VAL records
- // coordinates
- public static final int X = 0;
- public static final int Y = 1;
- public static final int WIDTH = 2;
- public static final int HEIGHT = 3;
-
- protected WorkBookHandle wbh;
- private Chart mychart;
-
- /**
- * Constructor which creates a new ChartHandle from an existing Chart Object
- *
- * @param Chart
- * c - the source Chart object
- * @param WorkBookHandle
- * wb - the parent WorkBookHandle
- */
- public ChartHandle(Chart c, WorkBookHandle wb) {
- // super();
- mychart = c;
- wbh = wb;
- if (mychart.getWorkBook() == null) // TODO: WHY IS THIS NULL????
- mychart.setWorkBook(wb.getWorkBook());
- }
-
- /**
- * Returns the title of the Chart
- *
- * @return String title of the Chart
- */
- public String getTitle() {
- return mychart.getTitle();
- }
-
- /**
- * Sets the title of the Chart
- *
- * @param String
- * title - Chart title
- */
- public void setTitle(String title) {
- this.mychart.setTitle(title);
- }
-
- /**
- * returns the data range used by the chart
- *
- * @return
- */
- public String getDataRangeJSON() {
- return this.mychart.getChartSeries().getDataRangeJSON().toString();
- }
-
- public int[] getEncompassingDataRange() {
- return getEncompassingDataRange(this.mychart.getChartSeries().getDataRangeJSON());
- }
-
- /**
- * returns the encompassing range for this chart, or null if the chart data is
- * too complex to represent
- *
- * @param jsonDataRange
- * @return
- */
- public static int[] getEncompassingDataRange(JSONObject jsonDataRange) {
- try {
- String catrange = jsonDataRange.get("c").toString();
- String sheet = catrange.substring(0, catrange.indexOf('!'));
- int[] retVals = ExcelTools.getRangeRowCol(catrange);
- int nSeries = jsonDataRange.getJSONArray("Series").length();
- for (int i = 0; i < nSeries; i++) {
- JSONObject series = (JSONObject) jsonDataRange.getJSONArray("Series").get(i);
- String serrange = series.get("v").toString();
- if (!serrange.startsWith(sheet))
- continue;
- int[] locs = ExcelTools.getRangeRowCol(serrange);
- try {
- if (locs[0] < retVals[0])
- retVals[0] = locs[0];
- if (locs[1] < retVals[1])
- retVals[1] = locs[1];
- if (locs[2] > retVals[2])
- retVals[2] = locs[2];
- if (locs[3] > retVals[3])
- retVals[3] = locs[3];
-
- String legendrange = series.get("l").toString();
- locs = ExcelTools.getRowColFromString(legendrange);
- if (locs[0] < retVals[0])
- retVals[0] = locs[0];
- if (locs[1] < retVals[1])
- retVals[1] = locs[1];
- if (locs[0] > retVals[2])
- retVals[2] = locs[0];
- if (locs[1] > retVals[3])
- retVals[3] = locs[1];
-
- if (series.has("b")) {
- String bubblerange = series.get("b").toString();
- locs = ExcelTools.getRangeRowCol(serrange);
- if (locs[0] < retVals[0])
- retVals[0] = locs[0];
- if (locs[1] < retVals[1])
- retVals[1] = locs[1];
- if (locs[2] > retVals[2])
- retVals[2] = locs[2];
- if (locs[3] > retVals[3])
- retVals[3] = locs[3];
- }
- } catch (Exception e) {
- // just continue
- }
- }
- return retVals;
- } catch (Exception e) {
- }
- return null;
- /*
- * while (ptgs.hasNext()) { PtgRef pr= (PtgRef) ptgs.next(); // PtgRef pr=
- * (PtgRef)refs[i]; int[] locs = pr.getIntLocation(); for (int x=0;x<2;x++) {
- * if((locs[x]retValues[x]))retValues[x]=locs[x]; } i++; }
- */
- }
-
- /**
- * returns the ordinal id associated with the underlying Chart Object
- *
- * @return int chart id
- * @see WorkBookHandle.getChartById
- */
- public int getId() {
- return this.mychart.getId();
- }
-
- /**
- * returns the string representation of this ChartHandle
- */
- @Override
- public String toString() {
- return mychart.getTitle();
- }
-
- /***************************************************************************************************************************************/
- /**
- * Returns an ordered array of strings representing all the series ranges in the
- * Chart.
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * Automatic Scaling automatically sets the scale maximum, minimum and tick
- * units upon data changes, and is the default setting for charts
- *
- * @param int
- * axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
- * ChartHandle.ZAXIS
- * @param boolean
- * b - true if set Automatic scaling on, false otherwise
- * @see setAxisAutomaticScale(boolean b)
- */
- public void setAxisAutomaticScale(int axisType, boolean b) {
- mychart.getAxes().setAxisAutomaticScale(axisType, b);
- mychart.setDirtyFlag(true);
- }
-
- /**
- * Returns the minimum scale value of the the desired Value axis
- *
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * @param int
- * axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
- * ChartHandle.ZAXIS
- * @return int Miminum Scale value for the desired axis
- * @see getAxisMinScale()
- */
- public double getAxisMinScale(int axisType) {
- double[] minmax = mychart.getMinMax(this.wbh);
- return mychart.getAxes().getMinMax(minmax[0], minmax[1], axisType)[0];
- }
-
- /**
- * Returns the maximum scale value of the desired Value axis
- *
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * @param int
- * axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
- * ChartHandle.ZAXIS
- * @return int - Maximum Scale value for the desired axis
- * @see getAxisMaxScale()
- */
- public double getAxisMaxScale(int axisType) {
- double[] minmax = mychart.getMinMax(this.wbh); // -1 is flag for all rather than for a specific chart
- return mychart.getAxes().getMinMax(minmax[0], minmax[1], axisType)[1];
- }
-
- /**
- * Returns the major tick unit of the desired Value axis
- *
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * @param int
- * axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
- * ChartHandle.ZAXIS
- * @return int major tick unit
- * @see getAxisMajorUnit()
- */
- public int getAxisMajorUnit(int axisType) {
- return mychart.getAxes().getAxisMajorUnit(axisType);
- }
-
- /**
- * Returns the minor tick unit of the desired Value axis
- *
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * @param int
- * axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
- * ChartHandle.ZAXIS
- * @return int - minor tick unit of the desired axis
- * @see getAxisMinorUnit()
- */
- public int getAxisMinorUnit(int axisType) {
- return mychart.getAxes().getAxisMinorUnit(axisType);
- }
-
- /**
- * Sets the maximum scale value of the desired Value axis
- *
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * Note: The default scale setting for charts is known as Automatic Scaling
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * Note: The default setting for charts is known as Automatic Scaling
- * The Value axis contains numbers rather than labels, and is normally the Y
- * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
- * well
- *
- * Note: The default setting for charts is known as Automatic Scaling
- * The default setting for charts is known as Automatic Scaling
- * Automatic Scaling will automatically set the scale maximum, minimum and tick
- * units upon data changes, and is the default chart setting
- *
- * @param b
- * @see setAxisAutomaticScale(int axisType boolean b)
- */
- public void setAxisAutomaticScale(boolean b) {
- mychart.getAxes().setAxisAutomaticScale(b);
- mychart.setDirtyFlag(true);
- }
-
- /**
- * Returns the minimum value of the Y Axis (Value Axis) scale
- *
- * @return int Miminum Scale value for Y axis
- * @see getAxisMinScale(int axisType)
- */
- public double getAxisMinScale() {
- double[] minmax = mychart.getMinMax(this.wbh); // -1 is flag for all rather than for a specific chart
- return mychart.getAxes().getMinMax(minmax[0], minmax[1])[0];
- }
-
- /**
- * Returns the maximum value of the Y Axis (Value Axis) scale
- *
- * @return int Maximum Scale value for Y axis
- * @see getAxisMaxScale(int axisType)
- */
- public double getAxisMaxScale() {
- double[] minmax = mychart.getMinMax(this.wbh);
- return mychart.getAxes().getMinMax(minmax[0], minmax[1])[1];
- }
-
- /**
- * Returns the major tick unit of the Y Axis (Value Axis)
- *
- * @return int major tick unit
- * @see getAxisMajorUnit(int axisType)
- */
- public int getAxisMajorUnit() {
- double[] minmax = mychart.getMinMax(this.wbh);
- return (int) mychart.getAxes().getMinMax(minmax[0], minmax[1])[2];
- }
-
- /**
- * Returns the minor tick unit of the Y Axis (Value Axis)
- *
- * @return int minor tick unit
- * @see getAxisMinorUnit(int axisType)
- */
- public int getAxisMinorUnit() {
- double[] minmax = mychart.getMinMax(this.wbh);
- return (int) mychart.getAxes().getMinMax(minmax[0], minmax[1])[1];
- }
-
- /**
- * Sets the maximum value of the Y Axis (Value Axis) Scale
- *
- * Note: The default scale setting for charts is known as Automatic Scaling
- * Note: The default setting for charts is known as Automatic Scaling NOTE: THIS HAS NOT BEEN 100% IMPLEMENTED YET
- * To see possible Chart Types, view the public static int's in ChartHandle.
- *
- * @see ChartHandle.ChartOptions
- * @see setChartType
- * @return
- */
- public static ChartHandle createNewChart(WorkSheetHandle sheet, int chartType, EnumSet options) {
- // Create Initial Basic Chart
- ChartHandle cht = sheet.getWorkBook().createChart("", sheet);
- // Change Chart Type with Desired Options:
- cht.setChartType(chartType, 0, options);
- return cht;
- }
-
- /**
- * Sets the Chart type to the specified type (no 3d, no stacked ...)
- * 0 or more chart options (Such as Stacked, Exploded ...)
- * @see ChartHandle.ChartOptions
- */
- public void setChartType(int chartType, int nChart, EnumSet options) {
- mychart.setChartType(chartType, nChart, options);
- }
-
- /**
- * Sets the basic chart type (no 3d, stacked...) for multiple or overlay Charts.
- * unique and in order To set explicit chart options, @see setChartType(chartType, nChart, is3d,
- * isStacked, is100PercentStacked)
- * ChartHandle.addSeriesRange("Sheet1!A3", "Sheet1!B1:E1", "Sheet1:B3:E3",
- * null);
- * Note that the category does not change, it is usually constant through
- * series.
- * ChartHandle.addSeriesRange("Sheet1!A3", "Sheet1!B1:E1", "Sheet1:B3:E3",
- * null);
- * Note that the category does not change, it is usually constant through
- * series.
- * NOTE: String arrays come in reverse order from plugins, so this method adds
- * series LIFO i.e. reversed
- *
- * @param String[]
- * valueRanges - Array of Cell Ranges representing the Values or Data
- * points for each series (bar, line or wedge) on the Chart
- * @param String[]
- * legendCells - Array of Cell Addresses representing the legends for
- * each Series
- * @param String[]
- * bubbleSizeRanges - Array of Cell ranges representing the bubble
- * sizes for the Chart, or null if chart is not of type BUBBLE
- * @param String
- * categoryRange - The Cell Range representing the categories (X
- * Axis) for the entire Chart
- */
- public void addAllSeries(String[] valueRanges, String[] legendCells, String[] bubbleSizeRanges,
- String categoryRange) {
- addAllSeries(valueRanges, legendCells, bubbleSizeRanges, categoryRange, 0); // do for default chart
- }
-
- /**
- * updates (replaces) every Chart Series (bar, line or wedge on the Chart) with
- * the data from the array of values, legends, bubble sizes (optional) and
- * category range For the desired chart (0=default 1-9=overlay charts)
- * NOTE: String arrays come in reverse order from plugins, so this method adds
- * series LIFO i.e. reversed
- *
- * @param String[]
- * valueRanges - Array of Cell Ranges representing the Values or Data
- * points for each series (bar, line or wedge) on the Chart
- * @param String[]
- * legendCells - Array of Cell Addresses representing the legends for
- * each Series
- * @param String[]
- * bubbleSizeRanges - Array of Cell ranges representing the bubble
- * sizes for the Chart, or null if chart is not of type BUBBLE
- * @param String
- * categoryRange - The Cell Range representing the categories (X
- * Axis) for the entire Chart
- * @param nChart
- * number and drawing order of the desired chart (default= 0 max=9
- * where 1-9 indicate an overlay chart)
- */
- private void addAllSeries(String[] valueRanges, String[] legendCells, String[] bubbleSizeRanges,
- String categoryRange, int nChart) {
- // first, remove all existing series
- Vector v = mychart.getAllSeries();
- for (int i = 0; i < v.size(); i++) {
- mychart.removeSeries((Series) v.get(i));
- }
- try {
- HashMap chartMetrics = mychart.getMetrics(wbh); // build or retrieve Chart Metrics -->
- // dimensions + series data ...
- this.mychart.getLegend().resetPos(chartMetrics.get("y"), chartMetrics.get("h"), chartMetrics.get("canvash"),
- legendCells.length);
- } catch (Exception e) {
- }
- setDimensionsRecord();
- // now add series
- boolean hasBubbles = ((bubbleSizeRanges != null && bubbleSizeRanges.length == valueRanges.length));
- for (int i = valueRanges.length - 1; i >= 0; i--) {
- try {
- if (!hasBubbles) // usual case
- this.addSeriesRange(legendCells[i], categoryRange, valueRanges[i], null, nChart);
- else
- this.addSeriesRange(legendCells[i], categoryRange, valueRanges[i], bubbleSizeRanges[i], nChart);
- } catch (Exception e) {
- Logger.logErr("Error adding series: " + e.toString());
- }
- }
- }
-
- /**
- * Appends a series one row below the last series in the chart.
- *
- * This can be utilized when programmatically adding rows of data that should be
- * reflected in the chart.
- * This can be utilized when programmatically adding rows of data that should be
- * reflected in the chart. 0) { // insert row i.e.
- * shift ai location down if ((loc.length==2 && loc[0]>=rownum) ||
- * (loc[0]>=rownum || loc[2]>=rownum)) { adjustAiLocation(ai,
- * p[0].getIntLocation(), shiftamt); bMod= true; } } else { if ((loc.length==2
- * && loc[0]==rownum) || (loc[0]>=rownum && loc[2]<=rownum)) { // remove it
- * this.removeSeries(i); bMod= true; continue; } } } catch(Exception e) {
- *
- * } } catch (Exception e) {
- *
- * } try { // CATEGORY Ai ai= s.getCategoryValueAi(); Ptg[]
- * p=ai.getCellRangePtgs(); try { int[] loc= p[0].getIntLocation(); if (shiftamt
- * > 0) { // insert row i.e. shift ai location down if ((loc.length==2 &&
- * loc[0]>=rownum) || (loc[0]>=rownum || loc[2]>=rownum)) { adjustAiLocation(ai,
- * p[0].getIntLocation(), shiftamt); bMod= true; } } else { if ((loc.length==2
- * && loc[0]==rownum) || (loc[0]>=rownum && loc[2]<=rownum)) { // remove it ????
- * this.removeSeries(i); bMod= true; } } } catch(Exception e) {
- *
- * } } catch (Exception e) {
- *
- * } try { // LEGEND Ai ai= s.getLegendAi(); Ptg[] p=ai.getCellRangePtgs();
- * int[] loc= p[0].getIntLocation(); if (shiftamt > 0) { // insert row i.e.
- * shift ai location down if ((loc.length==2 && loc[0]>=rownum) ||
- * (loc[0]>=rownum || loc[2]>=rownum)) { adjustAiLocation(ai,
- * p[0].getIntLocation(), shiftamt); bMod= true; } } else { if ((loc.length==2
- * && loc[0]==rownum) || (loc[0]>=rownum && loc[2]<=rownum)) { // remove it
- * this.removeSeries(i); bMod= true; } } } catch(Exception e) {
- *
- * } } if (bMod)// one or more series elements were modified
- * setDimensionsRecord(); // update dimensions i.e. Data Range
- *
- * }
- */
-
- /*
- * doesn't appear to be used right now move the ai location (row) according to
- * shift amount
- *
- * @param ai
- *
- * @param loc
- *
- * @param shift
- *
- * private void adjustAiLocation(Ai ai, int[] loc, int shift) { String oldloc=
- * ExcelTools.formatLocation(loc); if (loc.length>2) // get 2nd part of range
- * oldloc += ":" + ExcelTools.formatLocation(new int[]{loc[2], loc[3]}); oldloc=
- * this.getSheet().getSheetName() + "!" + oldloc; if (loc.length==2)// single
- * cell loc[0]+=shift; else { // range loc[0]+=shift; loc[2]+=shift; } String
- * newloc= ExcelTools.formatLocation(loc); if (loc.length>2) // get 2nd part of
- * range newloc += ":" + ExcelTools.formatLocation(new int[]{loc[2], loc[3]});
- * ai.changeAiLocation(oldloc, newloc); }
- *
- */
- /**
- * Get the Chart's bytes
- *
- * This is an internal method that is not useful to the end user.
- *
- */
- public byte[] getChartBytes() {
- return mychart.getChartBytes();
- }
-
- public byte[] getSerialBytes() {
- return mychart.getSerialBytes();
- }
-
- /**
- * get the chart-type-specific options in XML form
- *
- * @return String XML
- */
- private String getChartOptionsXML() {
- return mychart.getChartOptionsXML(0); // 0 for default chart
- }
-
- private String t(int n) {
- String tabs = "\t\t\t\t\t\t\t\t\t\t\t\t\t";
- return (tabs.substring(0, n));
- }
-
- /**
- * given a XmlPullParser positioned at the chart element, parse all chart
- * elements to create desired chart
- *
- * @param sht
- * WorkSheetHandle
- * @param xpp
- * XmlPullParser
- */
- public void parseXML(WorkSheetHandle sht, XmlPullParser xpp, HashMap maps) {
- try {
- int eventType = xpp.getEventType();
- while (eventType != XmlPullParser.END_DOCUMENT) {
- if (eventType == XmlPullParser.START_TAG) {
- String tnm = xpp.getName();
- if (tnm.equals("ChartFonts")) {
- for (int x = 0; x < xpp.getAttributeCount(); x++) {
- this.setChartFont(xpp.getAttributeName(x), xpp.getAttributeValue(x));
- }
- } else if (tnm.equals("ChartFontRec")) {
- String fName = "";
- int fontId = 0, fSize = 0, fWeight = 0, fColor = 0, fUnderline = 0;
- boolean bIsBold = false;
- for (int x = 0; x < xpp.getAttributeCount(); x++) {
- String attr = xpp.getAttributeName(x);
- String val = xpp.getAttributeValue(x);
- if (attr.equals("name")) {
- fName = val;
- } else if (attr.equals("id")) {
- fontId = Integer.parseInt(val);
- } else if (attr.equals("size")) {
- fSize = Font.PointsToFontHeight(Double.parseDouble(val));
- } else if (attr.equals("color")) {
- fColor = FormatHandle.HexStringToColorInt(val, FormatHandle.colorFONT);
- if (fColor == 0)
- fColor = 32767; // necessary?
- } else if (attr.equals("weight")) {
- fWeight = Integer.parseInt(val);
- } else if (attr.equals("bold")) {
- bIsBold = true;
- } else if (attr.equals("underline")) {
- fUnderline = Integer.parseInt(val);
- }
- }
- while (this.getWorkBook().getNumFonts() < fontId - 1) {
- this.getWorkBook().insertFont(new Font("Arial", FormatConstants.PLAIN, 10));
- }
- if (this.getWorkBook().getNumFonts() < fontId) {
- Font f = new Font(fName, fWeight, fSize);
- f.setColor(fColor);
- f.setBold(bIsBold);
- f.setUnderlineStyle((byte) fUnderline);
- this.getWorkBook().insertFont(f);
- } else { // TODO: this will screw up linked fonts, perhaps, so what to do?
- Font f = this.getWorkBook().getFont(fontId);
- f.setFontWeight(fWeight);
- f.setFontName(fName);
- f.setFontHeight(fSize);
- f.setColor(fColor);
- f.setBold(bIsBold);
- f.setUnderlineStyle((byte) fUnderline);
- }
- } else if (tnm.equals("FormatChartArea")) { // TODO: something!
- // ChartBorder
- // ChartProperties
- } else if (tnm.equals("Series")) { // series -->
- // Legend Range Category shape typex typey
- String legend = "", series = "", category = "", bubble = "";
- String dataTypeX = "", dataTypeY = "";
- String shape = "";
- for (int x = 0; x < xpp.getAttributeCount(); x++) {
- if (xpp.getAttributeName(x).equalsIgnoreCase("Legend"))
- legend = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Range"))
- series = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Category"))
- category = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Bubbles"))
- bubble = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("TypeX"))
- dataTypeX = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("TypeY"))
- dataTypeY = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Shape"))
- shape = xpp.getAttributeValue(x);
- }
- // 20070709 KSC: can't add until all cells are added
- // ch.addSeriesRange(legend, category, series);
- String[] s = { legend, series, category, bubble, dataTypeX, dataTypeY, shape };
- HashMap map = (HashMap) maps.get("chartseries");
- map.put(s, this);
- } else if (tnm.equals("ChartOptions")) { // handle chart-type-specific options such as legend
- // options
- // 20070716 KSC: handle chart-type-specific options in a very generic way ...
- for (int x = 0; x < xpp.getAttributeCount(); x++) {
- this.setChartOption(xpp.getAttributeName(x), xpp.getAttributeValue(x));
- }
- } else if (tnm.equals("ThreeD")) { // handle three-d options
- // handle threeD record options in a very generic way ...
- this.make3D(); // default chart - TODO; if mutliple charts, handle
- for (int x = 0; x < xpp.getAttributeCount(); x++) { // now add threed rec options
- this.setChartOption(xpp.getAttributeName(x), xpp.getAttributeValue(x));
- }
- } else if (tnm.endsWith("Axis")) { // handle axis specs (Label + options ...)
- // 20070720 KSC: handle Axis record options ...
- int type = 0;
- String axis = xpp.getName();
- if (axis.equalsIgnoreCase("XAxis"))
- type = XAXIS;
- else if (axis.equalsIgnoreCase("YAxis"))
- type = YAXIS;
- else if (axis.equalsIgnoreCase("ZAxis"))
- type = ZAXIS;
- if (xpp.getAttributeCount() > 0) { // then has axis options
- for (int x = 0; x < xpp.getAttributeCount(); x++) {
- this.setAxisOption(type, xpp.getAttributeName(x), xpp.getAttributeValue(x));
- }
- } else { // no axis options means no axis present; remove
- this.removeAxis(type);
- }
- } else if (tnm.equals("Series")) { // handle series data
- // Legend Range Category
- String legend = "", series = "", category = "", bubble = "";
- String dataTypeX = "", dataTypeY = "";
- String shape = "";
- for (int x = 0; x < xpp.getAttributeCount(); x++) {
- if (xpp.getAttributeName(x).equalsIgnoreCase("Legend"))
- legend = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Range"))
- series = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Category"))
- category = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Bubbles"))
- bubble = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("TypeX"))
- dataTypeX = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("TypeY"))
- dataTypeY = xpp.getAttributeValue(x);
- else if (xpp.getAttributeName(x).equalsIgnoreCase("Shape"))
- shape = xpp.getAttributeValue(x);
- }
- // 20070709 KSC: can't add until all cells are added
- // ch.addSeriesRange(legend, category, series);
- String[] s = { legend, series, category, bubble, dataTypeX, dataTypeY, shape };
- HashMap map = (HashMap) maps.get("chartseries");
- map.put(s, this);
- }
- } else if (eventType == XmlPullParser.END_TAG) {
- if (xpp.getName().equals("Chart"))
- break;
- }
- eventType = xpp.next();
- }
- } catch (Exception e) {
- Logger.logWarn("ChartHandle.parseXML <" + xpp.getName() + ">: " + e.toString());
- // TODO: propogate Exception???
- }
- }
-
- /**
- * returns an XML representation of this chart
- *
- * @return String XML
- */
- public String getXML() {
- StringBuffer sb = new StringBuffer(t(1) + "\n");
-
- // Chart Fonts
- sb.append(t(2) + "" + this.getChartFontRecsXML());
- sb.append("\n" + t(2) + " \n");
- sb.append(t(2) + "\n");
- sb.append(t(3) + " \n");
- // Source Data
- sb.append(t(2) + "\n");
- ChartSeriesHandle[] series = this.getAllChartSeriesHandles();
- for (int i = 0; i < series.length; i++) {
- sb.append(t(3) + " \n");
- // Chart Options
- sb.append(t(2) + "\n");
- sb.append(t(3) + " \n");
- // ThreeD rec opts
- if (this.isThreeD()) {
- sb.append(t(2) + "
- ArrayList chartEmbeds = thischart.getChartEmbeds();
- if (chartEmbeds != null) {
- int j = 0;
- for (int i = 0; i < chartEmbeds.size(); i++) {
- if (((String[]) chartEmbeds.get(i))[0].equals("userShape")) {
- j++;
- cooxml.append(" lastTag = new java.util.Stack(); // keep track of element hierarchy
-
- XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
- factory.setNamespaceAware(true);
- XmlPullParser xpp = factory.newPullParser();
-
- xpp.setInput(ii, null); // using XML 1.0 specification
- int eventType = xpp.getEventType();
- while (eventType != XmlPullParser.END_DOCUMENT) {
- if (eventType == XmlPullParser.START_TAG) {
- String tnm = xpp.getName(); // main entry= chartSpace, children: lang, chart
- lastTag.push(tnm); // keep track of element hierarchy
- if (tnm.equals("chart")) { // beginning of DrawingML for a single image or chart; children: title,
- // plotArea, legend,
- /**
- * 5
- * , serAx, valAx, catAx, dateAx, spPr,
- * dTable 13
- *
- */
- } else if (tnm.equals("lang")) {
- thischart.lang = xpp.getAttributeValue(0);
- } else if (tnm.equals("roundedCorners")) {
- thischart.roundedCorners = xpp.getAttributeValue(0).equals("1");
- } else if (tnm.equals("pivotSource")) { // has a pivot table
- hasPivotTableSource = true;
- } else if (tnm.equals("view3D")) {
- ThreeD.parseOOXML(xpp, lastTag, thischart);
- } else if (tnm.equals("layout")) {
- thischart.plotAreaLayout = (Layout) Layout.parseOOXML(xpp, lastTag).cloneElement();
- } else if (tnm.equals("legend")) {
- thischart.showLegend(true, false);
- thischart.ooxmlLegend = (io.starter.formats.OOXML.Legend) io.starter.formats.OOXML.Legend
- .parseOOXML(xpp, lastTag, this.wbh).cloneElement();
- thischart.ooxmlLegend.fill2003Legend(thischart.getLegend());
- // Parse actual CHART TYPE element (barChart, pieChart, etc.)
- } else if (tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.BARCHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.LINECHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.PIECHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.AREACHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.SCATTERCHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.RADARCHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.SURFACECHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.DOUGHNUTCHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.BUBBLECHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.OFPIECHART])
- || tnm.equals(OOXMLConstants.twoDchartTypes[ChartHandle.STOCKCHART])
- || tnm.equals(OOXMLConstants.threeDchartTypes[ChartHandle.BARCHART])
- || tnm.equals(OOXMLConstants.threeDchartTypes[ChartHandle.LINECHART])
- || tnm.equals(OOXMLConstants.threeDchartTypes[ChartHandle.PIECHART])
- || tnm.equals(OOXMLConstants.threeDchartTypes[ChartHandle.AREACHART])
- || tnm.equals(OOXMLConstants.threeDchartTypes[ChartHandle.SCATTERCHART])
- || tnm.equals(OOXMLConstants.threeDchartTypes[ChartHandle.SURFACECHART])) { // specific
- // chart type-
- ChartType.parseOOXML(xpp, this.wbh, mychart, drawingOrder++);
- lastTag.pop();
- } else if (tnm.equals("title")) {
- thischart.setOOXMLTitle((Title) Title.parseOOXML(xpp, lastTag, this.wbh).cloneElement(),
- this.wbh);
- this.setTitle(thischart.getOOXMLTitle().getTitle());
- } else if (tnm.equals("spPr")) { // shape properties -- can be for plot area or chart space
- String parent = lastTag.get(lastTag.size() - 2);
- if (parent.equals("plotArea")) {
- thischart.setSpPr(0, (SpPr) SpPr.parseOOXML(xpp, lastTag, this.wbh).cloneElement());
- } else if (parent.equals("chartSpace")) {
- thischart.setSpPr(1, (SpPr) SpPr.parseOOXML(xpp, lastTag, this.wbh).cloneElement());
- }
- } else if (tnm.equals("txPr")) { // text formatting
- thischart.setTxPr((TxPr) TxPr.parseOOXML(xpp, lastTag, this.wbh).cloneElement());
- } else if (tnm.equals("catAx")) { // child of plotArea
- mychart.getAxes().parseOOXML(XAXIS, xpp, tnm, lastTag, this.wbh);
- } else if (tnm.equals("valAx")) { // child of plotArea
- if (mychart.getAxes().hasAxis(ChartConstants.XAXIS)) // usual, have a catAx then a valAx
- mychart.getAxes().parseOOXML(ChartConstants.YAXIS, xpp, tnm, lastTag, this.wbh);
- else if (mychart.getAxes().hasAxis(ChartConstants.YAXIS)) // for bubble charts, has two valAxes
- // and no
- // catAx
- mychart.getAxes().parseOOXML(ChartConstants.XVALAXIS, xpp, tnm, lastTag, this.wbh);
- else // 2nd val axis is Y axis
- mychart.getAxes().parseOOXML(ChartConstants.YAXIS, xpp, tnm, lastTag, this.wbh);
- } else if (tnm.equals("serAx")) { // series axis - 3d charts
- mychart.getAxes().parseOOXML(ZAXIS, xpp, tnm, lastTag, this.wbh);
- } else if (tnm.equals("dateAx")) { // TODO: not finished: figure out!
- // ??
- }
-
- } else if (eventType == XmlPullParser.END_TAG) {
- lastTag.pop();
- String endTag = xpp.getName();
- if (endTag.equals("chartSpace")) {
- setDimensionsRecord();
- break; // done processing
- }
- }
- if (xpp.getEventType() != XmlPullParser.END_DOCUMENT)
- eventType = xpp.next();
- else
- eventType = XmlPullParser.END_DOCUMENT;
- }
- } catch (Exception e) {
- Logger.logErr("ChartHandle.parseChartOOXML: " + e.toString());
- }
- }
-
- /**
- * Specifies how to resize or move this Chart upon edit
- * Note: since most Chart Type Options are interdependent, there are several
- * makeXX methods that set the desired group of options e.g. makeStacked(); use
- * setChartOption with care
- *
- * Note that not all Chart Types will have every option available
- *
- * Possible Options:
- *
- * "Stacked" - true or false - set Chart Series to be Stacked
- * NOTE: all values must be in String form
- *
- * @see ChartHandle.getXML
- */
- public void setChartOption(String op, String val) {
- mychart.setChartOption(op, val);
- }
-
- /**
- * Method for setting Chart-Type-specific options in a generic fashion e.g.
- * charthandle.setChartOption("Stacked", "true");
- *
- * @param op
- * @param val
- * @param nChart
- * number and drawing order of the desired chart (default= 0 max=9
- * where 1-9 indicate an overlay chart)
- */
- private void setChartOption(String op, String val, int nChart) {
- mychart.setChartOption(op, val, nChart);
- }
-
- /**
- * @return true if Chart has 3D effects, false otherwise
- * @param nChart
- * number and drawing order of the desired chart (default= 0 max=9
- * where 1-9 indicate an overlay chart)
- */
- public boolean isThreeD(int nChart) {
- return mychart.isThreeD(nChart);
- }
-
- /**
- * @return true if Chart has 3D effects, false otherwise
- */
- public boolean isThreeD() {
- return mychart.isThreeD(0); // default chart
- }
-
- /**
- * @return boolean true if Chart contains Stacked Series, false otherwise
- */
- public boolean isStacked() {
- return mychart.isStacked(0); // default chart
- }
-
- /**
- * @return boolean true if Chart is of type 100% Stacked, false otherwise
- */
- public boolean is100PercentStacked() {
- return mychart.is100PercentStacked(0); // default chart
- }
-
- /**
- * @return boolean true if Chart contains Clustered Bars or Columns, false
- * otherwise
- */
- public boolean isClustered() {
- return mychart.isClustered(0); // default chart
- }
-
- /**
- * @return String ThreeD options in XML form
- */
- public String getThreeDXML() {
- return mychart.getThreeDXML(0); // 0 for default chart
- }
-
- /**
- * Make chart 3D if not already
- *
- * @param nChart
- * number and drawing order of the desired chart (default= 0 max=9
- * where 1-9 indicate an overlay chart)
- * @return ThreeD rec
- */
- private ThreeD initThreeD(int nChart) {
- return mychart.initThreeD(nChart, this.getChartType(nChart));
- }
-
- /**
- * @return String XML representation of the desired Axis
- * @param int
- * Axis - one of the Axis constants (XAXIS, YAXIS or ZAXIS)
- */
- private String getAxisOptionsXML(int Axis) {
- return mychart.getAxes().getAxisOptionsXML(Axis);
- }
-
- /**
- * Returns the Axis Label Placement or position as an int
- *
- * One of:
- * Possible options: possible String type values: " +
- * this.getChartFontRecsXML()); sb.append("\n" + t(2) + " \n");
- * sb.append(t(2) + " chartMetrics = mychart.getMetrics(wbh); // build or retrieve Chart Metrics -->
- // dimensions + series data ...
-
- StringBuffer svg = new StringBuffer();
- // required header
- // svg.append("\r\n"); // referneces
- // the DTD
- // svg.append("\r\n");
-
- // Define SVG Canvas:
- svg.append("\r\n");
- svg.append(""); // scale chart -default scale=1 == 100%
- // JavaScript hooks
- svg.append(getJavaScript());
-
- // Data Legend Box -- do before drawing plot area as legends box may change plot
- // area coordinates
- String legendSVG = getLegendSVG(chartMetrics); // but have to append it after because should overlap the
- // plotarea
-
- String bgclr = this.mychart.getPlotAreaBgColor();
- // setup gradients
- svg.append("");
- svg.append("");
- svg.append(" ");
- svg.append(" ");
-
- // PLOT AREA BG + RECT
- // rectangle around entire chart canvas
- if (!(mychart instanceof OOXMLChart) || !((OOXMLChart) mychart).roundedCorners)
- svg.append(" ");
- svg.append(" ");
- /*
- * //KSC: TESTING: REMOVE WHEN DONE if
- * (WorkBookFactory.PID==WorkBookFactory.E360) { // save svg for testing
- * purposes try { java.io.File f= new java.io.File(
- * "c:/eclipse/workspace/testfiles/io.starter.OpenXLS/output/charts/FromSheetster.svg"
- * ); java.io.FileOutputStream fos= new java.io.FileOutputStream(f);
- * fos.write(svg.toString().getBytes()); fos.flush(); fos.close(); } catch
- * (Exception e) {} }
- */
- return svg.toString();
- }
-
- private String getLegendSVG(HashMap chartMetrics) {
- try {
- return mychart.getLegend().getSVG(chartMetrics, mychart.getChartObject(), mychart.getChartSeries());
- } catch (NullPointerException ne) { // no legend??
- return null;
- }
- }
-
- /**
- * returns the svg for javascript for highlight and restore
- *
- * @return
- */
- protected String getJavaScript() {
- StringBuffer svg = new StringBuffer();
- svg.append("");
- return svg.toString();
- }
-
- /**
- * debugging utility remove when done
- */
- public void WriteMainChartRecs(String fName) {
- mychart.getChartObject().WriteMainChartRecs(fName);
- }
-}
diff --git a/src/main/java/io/starter/OpenXLS/ChartHandle.kt b/src/main/java/io/starter/OpenXLS/ChartHandle.kt
new file mode 100644
index 0000000..ea72834
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/ChartHandle.kt
@@ -0,0 +1,3927 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or
+ * modify
+ * it under the terms of the GNU Lesser General Public
+ * License as
+ * published by the Free Software Foundation, either version
+ * 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be
+ * useful,
+ * but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
+ * the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public
+ * License along with OpenXLS. If not, see
+ *
+ get() = mychart!!.getSeries(-1)
+
+ /**
+ * Returns an ordered array of strings representing all the category ranges in
+ * the chart.
+ get() = getCategories(-1)
+
+ /**
+ * Returns an array of ChartSeriesHandle Objects, one for each bar, line or
+ * wedge of data.
+ *
+ * @return ChartSeriesHandle[] Array of ChartSeriesHandle Objects representing
+ * Chart Series Data (Series and Categories)
+ * @see ChartSeriesHandle
+ */
+ // get ALL
+ val allChartSeriesHandles: Array
+ get() = getAllChartSeriesHandles(-1)
+
+ /**
+ * returns the Y axis Title
+ *
+ * @return String title
+ */
+ /**
+ * Sets the Y axis Title
+ *
+ * @param String yTitle - new Y Axis title
+ */
+ var yAxisLabel: String
+ get() = mychart!!.axes!!.getTitle(YAXIS)
+ set(yTitle) = mychart!!.axes!!.setTitle(YAXIS, yTitle)
+
+ /**
+ * returns the X axis Title
+ *
+ * @return String title
+ */
+ /**
+ * Sets the XAxisTitle
+ *
+ * @param String xTitle - new X Axis title
+ */
+ var xAxisLabel: String
+ get() = mychart!!.axes!!.getTitle(XAXIS)
+ set(xTitle) = mychart!!.axes!!.setTitle(XAXIS, xTitle)
+
+ /**
+ * returns the Z axis Title, if any
+ *
+ * @return String Title
+ */
+ /**
+ * set the Z AxisTitle
+ *
+ * @param String zTitle - new Z Axis Title
+ */
+ var zAxisLabel: String
+ get() = mychart!!.axes!!.getTitle(ZAXIS)
+ set(zTitle) = mychart!!.axes!!.setTitle(ZAXIS, zTitle)
+
+ /**
+ * Returns true if the Y Axis (Value axis) is set to automatic scale
+ *
+ *
+ * The default setting for charts is known as Automatic Scaling (ChartOptions::class.java))
+
+ /*
+ * NOT IMPLEMENTED YET adjust chart cell references upon row
+ * insertion or
+ * deletion NOTE: Assumes we're on the correct sheet NOT
+ * COMPLETELY IMPLEMENTED
+ * YEt
+ *
+ * @param rownum
+ *
+ * @param shiftamt +1= insert row, -1= delete row
+ *
+ * public void adjustCellRefs(int rownum, int shiftamt) {
+ * Vector v =
+ * mychart.getAllSeries(); boolean bSeriesRows= false;
+ * boolean bMod= false; for
+ * (int i=0;i 0) { //
+ * insert row i.e.
+ * shift ai location down if ((loc.length==2 &&
+ * loc[0]>=rownum) ||
+ * (loc[0]>=rownum || loc[2]>=rownum)) {
+ * adjustAiLocation(ai,
+ * p[0].getIntLocation(), shiftamt); bMod= true; } } else {
+ * if ((loc.length==2
+ * && loc[0]==rownum) || (loc[0]>=rownum && loc[2]<=rownum))
+ * { // remove it
+ * this.removeSeries(i); bMod= true; continue; } } }
+ * catch(Exception e) {
+ *
+ * } } catch (Exception e) {
+ *
+ * } try { // CATEGORY Ai ai= s.getCategoryValueAi(); Ptg[]
+ * p=ai.getCellRangePtgs(); try { int[] loc=
+ * p[0].getIntLocation(); if (shiftamt
+ * > 0) { // insert row i.e. shift ai location down if
+ * ((loc.length==2 &&
+ * loc[0]>=rownum) || (loc[0]>=rownum || loc[2]>=rownum)) {
+ * adjustAiLocation(ai,
+ * p[0].getIntLocation(), shiftamt); bMod= true; } } else {
+ * if ((loc.length==2
+ * && loc[0]==rownum) || (loc[0]>=rownum && loc[2]<=rownum))
+ * { // remove it ????
+ * this.removeSeries(i); bMod= true; } } } catch(Exception
+ * e) {
+ *
+ * } } catch (Exception e) {
+ *
+ * } try { // LEGEND Ai ai= s.getLegendAi(); Ptg[]
+ * p=ai.getCellRangePtgs();
+ * int[] loc= p[0].getIntLocation(); if (shiftamt > 0) { //
+ * insert row i.e.
+ * shift ai location down if ((loc.length==2 &&
+ * loc[0]>=rownum) ||
+ * (loc[0]>=rownum || loc[2]>=rownum)) {
+ * adjustAiLocation(ai,
+ * p[0].getIntLocation(), shiftamt); bMod= true; } } else {
+ * if ((loc.length==2
+ * && loc[0]==rownum) || (loc[0]>=rownum && loc[2]<=rownum))
+ * { // remove it
+ * this.removeSeries(i); bMod= true; } } } catch(Exception
+ * e) {
+ *
+ * } } if (bMod)// one or more series elements were modified
+ * setDimensionsRecord(); // update dimensions i.e. Data
+ * Range
+ *
+ * }
+ */
+
+ /*
+ * doesn't appear to be used right now move the ai location
+ * (row) according to
+ * shift amount
+ *
+ * @param ai
+ *
+ * @param loc
+ *
+ * @param shift
+ *
+ * private void adjustAiLocation(Ai ai, int[] loc, int
+ * shift) { String oldloc=
+ * ExcelTools.formatLocation(loc); if (loc.length>2) // get
+ * 2nd part of range
+ * oldloc += ":" + ExcelTools.formatLocation(new
+ * int[]{loc[2], loc[3]}); oldloc=
+ * this.getSheet().getSheetName() + "!" + oldloc; if
+ * (loc.length==2)// single
+ * cell loc[0]+=shift; else { // range loc[0]+=shift;
+ * loc[2]+=shift; } String
+ * newloc= ExcelTools.formatLocation(loc); if (loc.length>2)
+ * // get 2nd part of
+ * range newloc += ":" + ExcelTools.formatLocation(new
+ * int[]{loc[2], loc[3]});
+ * ai.changeAiLocation(oldloc, newloc); }
+ *
+ */
+
+ /**
+ * Get the Chart's bytes
+ *
+ *
+ * This is an internal method that is not useful to the end user.
+ */
+ val chartBytes: ByteArray?
+ get() = mychart!!.chartBytes
+
+ val serialBytes: ByteArray?
+ get() = mychart!!.serialBytes
+
+ /**
+ * get the chart-type-specific options in XML form
+ *
+ * @return String XML
+ */
+ private// 0 for default chart
+ val chartOptionsXML: String
+ get() = mychart!!.getChartOptionsXML(0)
+
+ /**
+ * returns an XML representation of this chart
+ *
+ * @return String XML
+ */
+ // Chart Name (=Title)
+ // Type
+ // Plot Area Background color 20080429 KSC
+ // Position
+ // Chart Fonts
+ // Format Chart Area
+ // KSC: TODO: BORDER
+ // TODO:
+ // Properties
+ // Source Data
+ // controls shape of complex datapoints such as pyramid,
+ // cylinder, cone +
+ // stacked 3d bars
+ // Chart Options
+ // Axis Options
+ // ThreeD rec opts
+ val xml: String
+ get() {
+ val sb = StringBuffer(t(1) + "\n")
+ sb.append(t(2) + "" + this.chartFontRecsXML)
+ sb.append("\n" + t(2) + " \n")
+ sb.append(t(2) + "\n")
+ sb.append(t(3) + " \n")
+ sb.append(t(2) + "\n")
+ val series = this.allChartSeriesHandles
+ for (i in series.indices) {
+ sb.append(t(3) + " \n")
+ sb.append(t(2) + "\n")
+ sb.append(t(3) + " \n")
+ if (this.isThreeD) {
+ sb.append(t(2) + "" +
+ * this.getChartFontRecsXML()); sb.append("\n" + t(2) +
+ * " \n");
+ * sb.append(t(2) + "(3)
+val chartObjectJSON = this.mychart!!.chartObject
+.getJSON(this.mychart!!.chartSeries, this.workBookHandle, jMinMax)
+var yMax = 1.0
+var yMin = 0.0
+var nSeries = 0
+try
+{
+theChart.put("Series", chartObjectJSON.getJSONArray("Series"))
+mychart!!.seriesJSON = chartObjectJSON.getJSONArray("Series")
+theChart.put("SeriesFills", chartObjectJSON
+.getJSONArray("SeriesFills"))
+}
+catch (e:Exception) {}
+
+theChart.put("type", chartObjectJSON.getJSONObject("type"))
+yMin = jMinMax[0].toDouble()
+yMax = jMinMax[1].toDouble()
+nSeries = jMinMax[2].toInt()
+try
+{
+theChart.put("y", mychart!!.axes!!
+.getJSON(YAXIS, this.workBookHandle, type, yMax, yMin, nSeries)
+.getJSONObject("y"))
+theChart.put("back_grid", mychart!!.axes!!
+.getJSON(YAXIS, this.workBookHandle, type, yMax, yMin, nSeries)
+.getJSONObject("back_grid"))
+}
+catch (e:Exception) {}
+
+try
+{
+theChart.put("x", mychart!!.axes!!
+.getJSON(XAXIS, this.workBookHandle, type, yMax, yMin, nSeries)
+.getJSONObject("x"))
+theChart.put("back_grid", mychart!!.axes!!
+.getJSON(ChartConstants.YAXIS, this.workBookHandle, type, yMax, yMin, nSeries)
+.getJSONObject("back_grid"))
+}
+catch (e:Exception) {}
+
+if (this.hasDataLegend())
+{
+val s = this.mychart!!.legend!!.legendPosition
+val legends = this.mychart!!.getLegends(-1)
+var l = ""
+for (i in legends.indices)
+l += legends[i] + ","
+if (l.length > 0)
+l = l.substring(0, l.length - 1)
+theChart.put("legend", JSONObject(
+"{position:" + s + ",labels:[" + l + "]}"))
+}
+
+}
+catch (e:JSONException) {
+Logger.logErr("Error getting Chart JSON: " + e)
+}
+
+return theChart.toString()
+}
+
+/**
+ * retrieves the saved Series JSON for comparisons (3)
+try
+{
+val chartObjectJSON = this.mychart!!.chartObject
+.getJSON(this.mychart!!.chartSeries, this.workBookHandle, jMinMax)
+
+try
+{
+retJSON.put("Series", chartObjectJSON.getJSONArray("Series"))
+}
+catch (e:Exception) {
+Logger.logWarn(("ChartHandle.getCurrentSeries problem:" + e.toString()))
+}
+
+var yMax = 0.0
+var yMin = 0.0
+var nSeries = 0
+yMin = jMinMax[0].toDouble()
+yMax = jMinMax[1].toDouble()
+nSeries = jMinMax[2].toInt()
+
+val type = this.chartType
+}
+catch (e:JSONException) {
+Logger.logErr(("ChartHandle.getCurrentSeries: Error getting Series JSON: " + e))
+}
+
+return retJSON
+}
+
+/**
+ * returns a JSON representation of all Series Data (Legend, Categogies, Series
+ * Values) for the chart {
+return mychart!!.getCategories(nChart)
+}
+
+/**
+ * Returns an array of ChartSeriesHandle Objects for the desired chart, one for
+ * each bar, line or wedge of data. {
+val v = mychart!!.getAllSeries(nChart)
+val csh = arrayOfNulls(v.size)
+for (i in v.indices)
+{
+val s = v.get(i) as Series
+csh[i] = ChartSeriesHandle(s, this.workBookHandle)
+}
+return csh
+}
+
+/**
+ * Get the ChartSeriesHandle representing Chart Series Data (Series and
+ * Categories) for the specified Series range
+ *
+ * @param String seriesRange - For example, "Sheet1!A12:A21"
+ * @return ChartSeriesHandle
+ * @see ChartSeriesHandle
+ */
+ fun getChartSeriesHandle(seriesRange:String):ChartSeriesHandle? {
+val series = this.allChartSeriesHandles
+for (i in series.indices)
+{
+val sr = series[i].seriesRange
+if (seriesRange.equals(sr, ignoreCase = true))
+{
+return series[i]
+}
+}
+return null
+}
+
+/**
+ * Get the ChartSeriesHandle representing Chart Series Data (Series and
+ * Categories) for the specified Series index
+ *
+ * @param int idx - the index (0 based) of the series
+ * @return ChartSeriesHandle
+ * @see ChartSeriesHandle
+ */
+ fun getChartSeriesHandle(idx:Int):ChartSeriesHandle? {
+val series = this.allChartSeriesHandles
+if (series.size >= idx)
+return series[idx]
+return null
+}
+
+/**
+ * Get the ChartSeriesHandle representing Chart Series Data (Series and
+ * Categories) for the Series specified by label (legend)
+ *
+ * @param String legend - label for the desired series
+ * @return ChartSeriesHandle
+ * @see ChartSeriesHandle
+ */
+ fun getChartSeriesHandleByName(legend:String):ChartSeriesHandle {
+val s = mychart!!.getSeries(legend, -1) // -1 is flag for all rather
+ // than for a specific chart
+ return ChartSeriesHandle(s, this.workBookHandle)
+}
+
+/**
+ * sets or removes the axis title
+ *
+ * @param axisType one of: XAXIS, YAXIS, ZAXIS
+ * @param ttl String new title or null to remove
+ */
+ fun setAxisTitle(axisType:Int, ttl:String) {
+mychart!!.axes!!.setTitle(axisType, ttl)
+}
+
+/**
+ * Sets the automatic scale option on or off for the desired Value axis
+ *
+ *
+ * The Value axis contains numbers rather than labels, and is normally the Y
+ * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
+ * well
+ *
+ *
+ * Automatic Scaling automatically sets the scale maximum, minimum and tick
+ * units upon data changes, and is the default setting for charts
+ *
+ * @param int axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
+ * ChartHandle.ZAXIS
+ * @param boolean b - true if set Automatic scaling on, false otherwise
+ * @see setAxisAutomaticScale
+ */
+ fun setAxisAutomaticScale(axisType:Int, b:Boolean) {
+mychart!!.axes!!.setAxisAutomaticScale(axisType, b)
+mychart!!.setDirtyFlag(true)
+}
+
+/**
+ * Returns the minimum scale value of the the desired Value axis
+ *
+ *
+ * The Value axis contains numbers rather than labels, and is normally the Y
+ * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
+ * well
+ *
+ * @param int axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
+ * ChartHandle.ZAXIS
+ * @return int Miminum Scale value for the desired axis
+ * @see getAxisMinScale
+ */
+ fun getAxisMinScale(axisType:Int):Double {
+val minmax = mychart!!.getMinMax(this.workBookHandle)
+return mychart!!.axes!!.getMinMax(minmax[0], minmax[1], axisType)[0]
+}
+
+/**
+ * Returns the maximum scale value of the desired Value axis
+ *
+ *
+ * The Value axis contains numbers rather than labels, and is normally the Y
+ * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
+ * well
+ *
+ * @param int axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
+ * ChartHandle.ZAXIS
+ * @return int - Maximum Scale value for the desired axis
+ * @see getAxisMaxScale
+ */
+ fun getAxisMaxScale(axisType:Int):Double {
+val minmax = mychart!!.getMinMax(this.workBookHandle) // -1 is flag for all
+ // rather than for a
+ // specific chart
+ return mychart!!.axes!!.getMinMax(minmax[0], minmax[1], axisType)[1]
+}
+
+/**
+ * Returns the major tick unit of the desired Value axis
+ *
+ *
+ * The Value axis contains numbers rather than labels, and is normally the Y
+ * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
+ * well
+ *
+ * @param int axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
+ * ChartHandle.ZAXIS
+ * @return int major tick unit
+ * @see getAxisMajorUnit
+ */
+ fun getAxisMajorUnit(axisType:Int):Int {
+return mychart!!.axes!!.getAxisMajorUnit(axisType)
+}
+
+/**
+ * Returns the minor tick unit of the desired Value axis
+ *
+ *
+ * The Value axis contains numbers rather than labels, and is normally the Y
+ * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
+ * well
+ *
+ * @param int axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS,
+ * ChartHandle.ZAXIS
+ * @return int - minor tick unit of the desired axis
+ * @see getAxisMinorUnit
+ */
+ fun getAxisMinorUnit(axisType:Int):Int {
+return mychart!!.axes!!.getAxisMinorUnit(axisType)
+}
+
+/**
+ * Sets the maximum scale value of the desired Value axis
+ *
+ *
+ * The Value axis contains numbers rather than labels, and is normally the Y
+ * axis, but Scatter and Bubble charts may have a value axis on the X Axis as
+ * well
+ *
+ *
+ * Note: The default scale setting for charts is known as Automatic Scaling
+ * Use these chart options when creating new charts 0 or more chart options (Such as Stacked, Exploded ...)
+ * @see ChartHandle.ChartOptions
+ */
+ fun setChartType(chartType:Int, nChart:Int, options:EnumSet) {
+mychart!!.setChartType(chartType, nChart, options)
+}
+
+/**
+ * Sets the basic chart type (no 3d, stacked...) for multiple or overlay Charts.
+ * (ChartOptions::class.java)) // no specific options
+}
+
+/**
+ * Return an int corresponding to this ChartHandle's Chart Type for the
+ * specified chart , legendCells:Array, bubbleSizeRanges:Array, categoryRange:String) {
+addAllSeries(valueRanges, legendCells, bubbleSizeRanges, categoryRange, 0) // do
+ // for
+ // default
+ // chart
+ }
+
+/**
+ * updates (replaces) every Chart Series (bar, line or wedge on the Chart) with
+ * the data from the array of values, legends, bubble sizes (optional) and
+ * category range For the desired chart (0=default 1-9=overlay charts) , legendCells:Array, bubbleSizeRanges:Array?, categoryRange:String, nChart:Int) {
+ // first, remove all existing series
+ val v = mychart!!.allSeries
+for (i in v.indices)
+{
+mychart!!.removeSeries(v.get(i) as Series)
+}
+try
+{
+val chartMetrics = mychart!!.getMetrics(workBookHandle) // build
+ // or
+ // retrieve
+ // Chart
+ // Metrics
+ // -->
+ // dimensions
+ // +
+ // series
+ // data
+ // ...
+ this.mychart!!.legend!!
+.resetPos(chartMetrics.get("y"), chartMetrics
+.get("h"), chartMetrics
+.get("canvash"), legendCells.size)
+}
+catch (e:Exception) {}
+
+setDimensionsRecord()
+ // now add series
+ val hasBubbles = (((bubbleSizeRanges != null && bubbleSizeRanges!!.size == valueRanges.size)))
+for (i in valueRanges.indices.reversed())
+{
+try
+{
+if (!hasBubbles)
+ // usual case
+ this.addSeriesRange(legendCells[i], categoryRange, valueRanges[i], null, nChart)
+else
+this.addSeriesRange(legendCells[i], categoryRange, valueRanges[i], bubbleSizeRanges!![i], nChart)
+}
+catch (e:Exception) {
+Logger.logErr("Error adding series: " + e.toString())
+}
+
+}
+}
+
+/**
+ * Appends a series one row below the last series in the chart for the desired
+ * chart
+ *
+ *
+ * This can be utilized when programmatically adding rows of data that should be
+ * reflected in the chart. (legend, series, category, bubble, dataTypeX, dataTypeY, shape)
+val map = maps
+.get("chartseries") as HashMap, ChartHandle>
+map.put(s, this)
+}
+else if (tnm == "ChartOptions")
+{ // handle
+ // chart-type-specific
+ // options such
+ // as legend
+ // options
+ // 20070716 KSC: handle chart-type-specific options in a
+ // very generic way ...
+ for (x in 0 until xpp.getAttributeCount())
+{
+this.setChartOption(xpp.getAttributeName(x), xpp
+.getAttributeValue(x))
+}
+}
+else if (tnm == "ThreeD")
+{ // handle three-d options
+ // handle threeD record options in a very generic way
+ // ...
+ this.make3D() // default chart - TODO; if mutliple
+ // charts, handle
+ for (x in 0 until xpp.getAttributeCount())
+{ // now
+ // add
+ // threed
+ // rec
+ // options
+ this.setChartOption(xpp.getAttributeName(x), xpp
+.getAttributeValue(x))
+}
+}
+else if (tnm.endsWith("Axis"))
+{ // handle axis specs
+ // (Label + options ...)
+ // 20070720 KSC: handle Axis record options ...
+ var type = 0
+val axis = xpp.getName()
+if (axis.equals("XAxis", ignoreCase = true))
+type = XAXIS
+else if (axis.equals("YAxis", ignoreCase = true))
+type = YAXIS
+else if (axis.equals("ZAxis", ignoreCase = true))
+type = ZAXIS
+if (xpp.getAttributeCount() > 0)
+{ // then has axis
+ // options
+ for (x in 0 until xpp.getAttributeCount())
+{
+this.setAxisOption(type, xpp
+.getAttributeName(x), xpp
+.getAttributeValue(x))
+}
+}
+else
+{ // no axis options means no axis present;
+ // remove
+ this.removeAxis(type)
+}
+}
+else if (tnm == "Series")
+{ // handle series data
+ // Legend Range Category
+ var legend = ""
+var series = ""
+var category = ""
+var bubble = ""
+var dataTypeX = ""
+var dataTypeY = ""
+var shape = ""
+for (x in 0 until xpp.getAttributeCount())
+{
+if (xpp.getAttributeName(x)
+.equals("Legend", ignoreCase = true))
+legend = xpp.getAttributeValue(x)
+else if (xpp.getAttributeName(x)
+.equals("Range", ignoreCase = true))
+series = xpp.getAttributeValue(x)
+else if (xpp.getAttributeName(x)
+.equals("Category", ignoreCase = true))
+category = xpp.getAttributeValue(x)
+else if (xpp.getAttributeName(x)
+.equals("Bubbles", ignoreCase = true))
+bubble = xpp.getAttributeValue(x)
+else if (xpp.getAttributeName(x)
+.equals("TypeX", ignoreCase = true))
+dataTypeX = xpp.getAttributeValue(x)
+else if (xpp.getAttributeName(x)
+.equals("TypeY", ignoreCase = true))
+dataTypeY = xpp.getAttributeValue(x)
+else if (xpp.getAttributeName(x)
+.equals("Shape", ignoreCase = true))
+shape = xpp.getAttributeValue(x)
+}
+ // 20070709 KSC: can't add until all cells are added
+ // ch.addSeriesRange(legend, category, series);
+ val s = arrayOf(legend, series, category, bubble, dataTypeX, dataTypeY, shape)
+val map = maps
+.get("chartseries") as HashMap, ChartHandle>
+map.put(s, this)
+}
+}
+else if (eventType == XmlPullParser.END_TAG)
+{
+if (xpp.getName() == "Chart")
+break
+}
+eventType = xpp.next()
+}
+}
+catch (e:Exception) {
+Logger.logWarn(("ChartHandle.parseXML <" + xpp.getName() + ">: "
++ e.toString()))
+ // TODO: propogate Exception???
+ }
+
+}
+
+/********************************************************************
+ * OOXML Generation Methods
+ */
+ /**
+ * Generates OOXML (chartML) for this chart object.
+ *
+ *
+ val chartEmbeds = thischart.chartEmbeds
+if (chartEmbeds != null)
+{
+var j = 0
+for (i in chartEmbeds!!.indices)
+{
+if ((chartEmbeds!!.get(i) as Array)[0] == "userShape")
+{
+j++
+cooxml.append("() // keep
+ // track
+ // of
+ // element
+ // hierarchy
+
+ val factory = XmlPullParserFactory.newInstance()
+factory.setNamespaceAware(true)
+val xpp = factory.newPullParser()
+
+xpp.setInput(ii, null) // using XML 1.0 specification
+var eventType = xpp.getEventType()
+while (eventType != XmlPullParser.END_DOCUMENT)
+{
+if (eventType == XmlPullParser.START_TAG)
+{
+val tnm = xpp.getName() // main entry= chartSpace,
+ // children: lang, chart
+ lastTag.push(tnm) // keep track of element hierarchy
+if (tnm == "chart")
+{ // beginning of DrawingML for a
+ // single image or chart;
+ // children: title,
+ // plotArea, legend,
+ /**
+ * 5
+ * , serAx, valAx, catAx, dateAx, spPr,
+ * dTable 13
+ *
+ */
+ }
+else if (tnm == "lang")
+{
+thischart!!.lang = xpp.getAttributeValue(0)
+}
+else if (tnm == "roundedCorners")
+{
+thischart!!.roundedCorners = xpp.getAttributeValue(0) == "1"
+}
+else if (tnm == "pivotSource")
+{ // has a pivot table
+hasPivotTableSource = true
+}
+else if (tnm == "view3D")
+{
+ThreeD.parseOOXML(xpp, lastTag, thischart!!)
+}
+else if (tnm == "layout")
+{
+thischart!!.plotAreaLayout = Layout
+.parseOOXML(xpp, lastTag).cloneElement() as Layout
+}
+else if (tnm == "legend")
+{
+thischart!!.showLegend(true, false)
+thischart!!.ooxmlLegend = io.starter.formats.OOXML.Legend
+.parseOOXML(xpp, lastTag, this.workBookHandle)
+.cloneElement() as io.starter.formats.OOXML.Legend
+thischart!!.ooxmlLegend!!
+.fill2003Legend(thischart!!.legend)
+ // Parse actual CHART TYPE element (barChart, pieChart,
+ // etc.)
+ }
+else if ((tnm == OOXMLConstants.twoDchartTypes[ChartHandle.BARCHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.LINECHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.PIECHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.AREACHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.SCATTERCHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.RADARCHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.SURFACECHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.DOUGHNUTCHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.BUBBLECHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.OFPIECHART]
+|| tnm == OOXMLConstants.twoDchartTypes[ChartHandle.STOCKCHART]
+|| tnm == OOXMLConstants.threeDchartTypes[ChartHandle.BARCHART]
+|| tnm == OOXMLConstants.threeDchartTypes[ChartHandle.LINECHART]
+|| tnm == OOXMLConstants.threeDchartTypes[ChartHandle.PIECHART]
+|| tnm == OOXMLConstants.threeDchartTypes[ChartHandle.AREACHART]
+|| tnm == OOXMLConstants.threeDchartTypes[ChartHandle.SCATTERCHART]
+|| tnm == OOXMLConstants.threeDchartTypes[ChartHandle.SURFACECHART]))
+{ // specific
+ // chart
+ // type-
+ ChartType
+.parseOOXML(xpp, this.workBookHandle, mychart, drawingOrder++)
+lastTag.pop()
+}
+else if (tnm == "title")
+{
+thischart!!.setOOXMLTitle(Title
+.parseOOXML(xpp, lastTag, this.workBookHandle)
+.cloneElement() as Title, this.workBookHandle)
+this.title = thischart!!.ooxmlTitle!!.title
+}
+else if (tnm == "spPr")
+{ // shape properties -- can
+ // be for plot area or
+ // chart space
+ val parent = lastTag.get(lastTag.size - 2)
+if (parent == "plotArea")
+{
+thischart!!.setSpPr(0, SpPr
+.parseOOXML(xpp, lastTag, this.workBookHandle)
+.cloneElement() as SpPr)
+}
+else if (parent == "chartSpace")
+{
+thischart!!.setSpPr(1, SpPr
+.parseOOXML(xpp, lastTag, this.workBookHandle)
+.cloneElement() as SpPr)
+}
+}
+else if (tnm == "txPr")
+{ // text formatting
+thischart!!.txPr = TxPr
+.parseOOXML(xpp, lastTag, this.workBookHandle)
+.cloneElement() as TxPr
+}
+else if (tnm == "catAx")
+{ // child of plotArea
+mychart!!.axes!!
+.parseOOXML(XAXIS, xpp, tnm, lastTag, this.workBookHandle)
+}
+else if (tnm == "valAx")
+{ // child of plotArea
+if (mychart!!.axes!!.hasAxis(ChartConstants.XAXIS))
+ // usual,
+ // have
+ // a
+ // catAx
+ // then
+ // a
+ // valAx
+ mychart!!.axes!!
+.parseOOXML(ChartConstants.YAXIS, xpp, tnm, lastTag, this.workBookHandle)
+else if (mychart!!.axes!!
+.hasAxis(ChartConstants.YAXIS))
+ // for bubble
+ // charts, has
+ // two valAxes
+ // and no
+ // catAx
+ mychart!!.axes!!
+.parseOOXML(ChartConstants.XVALAXIS, xpp, tnm, lastTag, this.workBookHandle)
+else
+ // 2nd val axis is Y axis
+ mychart!!.axes!!
+.parseOOXML(ChartConstants.YAXIS, xpp, tnm, lastTag, this.workBookHandle)
+}
+else if (tnm == "serAx")
+{ // series axis - 3d charts
+mychart!!.axes!!
+.parseOOXML(ZAXIS, xpp, tnm, lastTag, this.workBookHandle)
+}
+else if (tnm == "dateAx")
+{ // TODO: not finished:
+ // figure out!
+ // ??
+ }
+
+}
+else if (eventType == XmlPullParser.END_TAG)
+{
+lastTag.pop()
+val endTag = xpp.getName()
+if (endTag == "chartSpace")
+{
+setDimensionsRecord()
+break // done processing
+}
+}
+if (xpp.getEventType() != XmlPullParser.END_DOCUMENT)
+eventType = xpp.next()
+else
+eventType = XmlPullParser.END_DOCUMENT
+}
+}
+catch (e:Exception) {
+Logger.logErr("ChartHandle.parseChartOOXML: " + e.toString())
+}
+
+}
+
+/**
+ * Specifies how to resize or move this Chart upon edit ) {
+(mychart as OOXMLChart).addChartEmbed(ce)
+}
+
+/**
+ * set the chart DIMENSIONS record based on the series ranges in the chart
+ * APPEARS THAT for charts, the DIMENSIONS record merely notes the range of
+ * values: 0, #points in series, 0, #series
+ */
+ protected fun setDimensionsRecord() {
+val series = this.allChartSeriesHandles
+val nSeries = series.size
+var nPoints = 0
+for (i in series.indices)
+{
+try
+{
+val coords = ExcelTools
+.getRangeCoords(series[i].seriesRange)
+if (coords[3] > coords[1])
+nPoints = Math.max(nPoints, coords[3] - coords[1] + 1) // c1-c0
+else
+nPoints = Math.max(nPoints, coords[2] - coords[0] + 1) // r1-r0
+}
+catch (e:Exception) {}
+
+}
+mychart!!.setDimensionsRecord(0, nPoints, 0, nSeries)
+}
+
+/**
+ * Method for setting Chart-Type-specific options in a generic fashion e.g.
+ * charthandle.setChartOption("Stacked", "true");
+ *
+ *
+ * Note: since most Chart Type Options are interdependent, there are several
+ * makeXX methods that set the desired group of options e.g. makeStacked(); use
+ * setChartOption with care
+ *
+ *
+ * Note that not all Chart Types will have every option available
+ *
+ *
+ * Possible Options:
+ *
+ *
+ * "Stacked" - true or false - set Chart Series to be Stacked possible String type values: \r\n"))
+svg.append(("")) // scale
+ // chart
+ // -default
+ // scale=1
+ // == 100%
+ // JavaScript hooks
+ svg.append(javaScript)
+
+ // Data Legend Box -- do before drawing plot area as legends
+ // box may change plot
+ // area coordinates
+ val legendSVG = getLegendSVG(chartMetrics) // but have to append it
+ // after because should
+ // overlap the
+ // plotarea
+
+ val bgclr = this.mychart!!.plotAreaBgColor
+ // setup gradients
+ svg.append("")
+svg.append("")
+svg.append((" ")
+svg.append(" ")
+
+ // PLOT AREA BG + RECT
+ // rectangle around entire chart canvas
+ if ((!(mychart is OOXMLChart) || !(mychart as OOXMLChart).roundedCorners))
+svg.append((" ")
+svg.append(" ")
+ /*
+ * //KSC: TESTING: REMOVE WHEN DONE if
+ * (WorkBookFactory.PID==WorkBookFactory.E360) { // save svg
+ * for testing
+ * purposes try { java.io.File f= new java.io.File(
+ * "c:/eclipse/workspace/testfiles/io.starter.OpenXLS/output/charts/FromSheetster.svg"
+ * ); java.io.FileOutputStream fos= new
+ * java.io.FileOutputStream(f);
+ * fos.write(svg.toString().getBytes()); fos.flush();
+ * fos.close(); } catch
+ * (Exception e) {} }
+ */
+ return svg.toString()
+}
+
+private fun getLegendSVG(chartMetrics:HashMap):String? {
+try
+{
+return mychart!!.legend!!.getSVG(chartMetrics, mychart!!
+.chartObject, mychart!!.chartSeries)
+}
+catch (ne:NullPointerException) { // no legend??
+return null
+}
+
+}
+
+/**
+ * debugging utility remove when done
+ */
+ fun WriteMainChartRecs(fName:String) {
+mychart!!.chartObject.WriteMainChartRecs(fName)
+}
+
+ fun getAxis(type:Int):Axis? {
+ // TODO Auto-generated method stub
+ return null
+}
+
+companion object {
+ // 20080114 KSC: delegate so visible
+ val BARCHART = ChartConstants.BARCHART
+ val COLCHART = ChartConstants.COLCHART
+ val LINECHART = ChartConstants.LINECHART
+ val PIECHART = ChartConstants.PIECHART
+ val AREACHART = ChartConstants.AREACHART
+ val SCATTERCHART = ChartConstants.SCATTERCHART
+ val RADARCHART = ChartConstants.RADARCHART
+ val SURFACECHART = ChartConstants.SURFACECHART
+ val DOUGHNUTCHART = ChartConstants.DOUGHNUTCHART
+ val BUBBLECHART = ChartConstants.BUBBLECHART
+ val OFPIECHART = ChartConstants.OFPIECHART
+ val PYRAMIDCHART = ChartConstants.PYRAMIDCHART
+ val CYLINDERCHART = ChartConstants.CYLINDERCHART
+ val CONECHART = ChartConstants.CONECHART
+ val PYRAMIDBARCHART = ChartConstants.PYRAMIDBARCHART
+ val CYLINDERBARCHART = ChartConstants.CYLINDERBARCHART
+ val CONEBARCHART = ChartConstants.CONEBARCHART
+ val RADARAREACHART = ChartConstants.RADARAREACHART
+ val STOCKCHART = ChartConstants.STOCKCHART
+
+ // legacy
+ val BAR = BARCHART
+ val COL = COLCHART
+ val LINE = LINECHART
+ val PIE = PIECHART
+ val AREA = AREACHART
+ val SCATTER = SCATTERCHART
+ val RADAR = RADARCHART
+ val SURFACE = SURFACECHART
+ val DOUGHNUT = DOUGHNUTCHART
+ val BUBBLE = BUBBLECHART
+ val RADARAREA = RADARAREACHART
+ val PYRAMID = PYRAMIDCHART
+ val CYLINDER = CYLINDERCHART
+ val CONE = CONECHART
+ val PYRAMIDBAR = PYRAMIDBARCHART
+ val CYLINDERBAR = CYLINDERBARCHART
+ val CONEBAR = CONEBARCHART
+ // axis types
+ val XAXIS = ChartConstants.XAXIS
+ val YAXIS = ChartConstants.YAXIS
+ val ZAXIS = ChartConstants.ZAXIS
+ val XVALAXIS = ChartConstants.XVALAXIS // an
+ // X
+ // axis
+ // type
+ // but
+ // VAL
+ // records
+ // coordinates
+ val X = 0
+ val Y = 1
+ val WIDTH = 2
+ val HEIGHT = 3
+
+/**
+ * returns the encompassing range for this chart, or null if the chart data is
+ * too complex to represent
+ *
+ * @param jsonDataRange
+ * @return
+ */
+ fun getEncompassingDataRange(jsonDataRange:JSONObject):IntArray? {
+try
+{
+val catrange = jsonDataRange.get("c").toString()
+val sheet = catrange.substring(0, catrange.indexOf('!'))
+val retVals = ExcelTools.getRangeRowCol(catrange)
+val nSeries = jsonDataRange.getJSONArray("Series").length()
+for (i in 0 until nSeries)
+{
+val series = jsonDataRange
+.getJSONArray("Series").get(i) as JSONObject
+val serrange = series.get("v").toString()
+if (!serrange.startsWith(sheet))
+continue
+var locs = ExcelTools.getRangeRowCol(serrange)
+try
+{
+if (locs[0] < retVals[0])
+retVals[0] = locs[0]
+if (locs[1] < retVals[1])
+retVals[1] = locs[1]
+if (locs[2] > retVals[2])
+retVals[2] = locs[2]
+if (locs[3] > retVals[3])
+retVals[3] = locs[3]
+
+val legendrange = series.get("l").toString()
+locs = ExcelTools.getRowColFromString(legendrange)
+if (locs[0] < retVals[0])
+retVals[0] = locs[0]
+if (locs[1] < retVals[1])
+retVals[1] = locs[1]
+if (locs[0] > retVals[2])
+retVals[2] = locs[0]
+if (locs[1] > retVals[3])
+retVals[3] = locs[1]
+
+if (series.has("b"))
+{
+val bubblerange = series.get("b").toString()
+locs = ExcelTools.getRangeRowCol(serrange)
+if (locs[0] < retVals[0])
+retVals[0] = locs[0]
+if (locs[1] < retVals[1])
+retVals[1] = locs[1]
+if (locs[2] > retVals[2])
+retVals[2] = locs[2]
+if (locs[3] > retVals[3])
+retVals[3] = locs[3]
+}
+}
+catch (e:Exception) {
+ // just continue
+ }
+
+}
+return retVals
+}
+catch (e:Exception) {}
+
+return null
+ /*
+ * while (ptgs.hasNext()) { PtgRef pr= (PtgRef) ptgs.next();
+ * // PtgRef pr=
+ * (PtgRef)refs[i]; int[] locs = pr.getIntLocation(); for
+ * (int x=0;x<2;x++) {
+ * if((locs[x]retValues[x]))retValues[x]=locs[x]; } i++; }
+ */
+ }
+
+/**
+ * Static method to create a new chart on WorkSheet sheet of type chartType with
+ * chart Options options
+ * @return
+ * @see ChartHandle.ChartOptions
+ *
+ * @see setChartType
+ */
+ fun createNewChart(sheet:WorkSheetHandle, chartType:Int, options:EnumSet):ChartHandle {
+ // Create Initial Basic Chart
+ val cht = sheet.workBook!!.createChart("", sheet)
+ // Change Chart Type with Desired Options:
+ cht!!.setChartType(chartType, 0, options)
+return cht
+}
+}
+}/**
+ * Changes or adds a Series to the chart via Series Index. Each bar, line or
+ * wedge in a chart represents a Series.
- * IMPORTANT! In most cases, the category should be set to the same Cell Range for all Series in the chart.
- *
- get a handle to the Cells in a column
-
- Note: for a discussion of Column widths see:
- http://support.microsoft.com/?kbid=214123
-
- @see WorkBookHandle
- @see WorkSheetHandle
- @see FormulaHandle
-*/
-public class ColHandle {
-
- // TODO: read 1st font in file to set DEFAULT_ZERO_CHAR_WIDTH ... eventually ...
- public static final double DEFAULT_ZERO_CHAR_WIDTH= 7.0; // width of '0' char in default font + conversion 1.3
- public static final int COL_UNITS_TO_PIXELS =(int) (256/DEFAULT_ZERO_CHAR_WIDTH); // = 36.57
- public static final int DEFAULT_COLWIDTH = Colinfo.DEFAULT_COLWIDTH;
-
- private Colinfo myCol;
- private FormatHandle formatter;
- private WorkBook wbh;
- private WorkSheetHandle mySheet;
-
- /**
- * creates a new ColHandle from a Colinfo Object and reference to a worksheet (WorkSheetHandle Object)
- * @param c
- * @param sheet
- */
- protected ColHandle(Colinfo c, WorkSheetHandle sheet){
- myCol = c;
- wbh = sheet.getWorkBook();
- mySheet = sheet;
- }
-
- private int lastsz = 0; // the last checked col width
-
- /** resizes this column to fit the width of all displayed, non-wrapped text.
- * lastsz)
- this.setWidth(csz*factor);
- */
- }
- if (w==0)
- return; // keep original width ... that's what Excel does for blank columns ...
- // convert pixels to excel column units basically OpenXLS.COLUNITSTOPIXELS in double form
- this.setWidth((int)Math.floor((w/DEFAULT_ZERO_CHAR_WIDTH)*256.0));
- }
-
-
- /** sets the width of this Column in Characters or Excel units.
- * iAdjust= new ArrayList();
- ImageHandle[] images= myCol.getSheet().getImages();
- if(images!=null) {
- // for each image that falls over this column, trap index + original width -- to be reset after setting col width
- for (int z= 0; z < images.length; z++) {
- ImageHandle ih= images[z];
- int c0= ih.getCol();
- int c1= ih.getCol1();
- int col= myCol.getColFirst(); // should only be one, right?
- if (col>=c0 && col<=c1) {
- int w= ih.getWidth();
- iAdjust.add(new int[]{z,w});
- }
- }
- }
-
- myCol.setColWidthInChars(newWidth);
- for (int z= 0; z < iAdjust.size(); z++) {
- ImageHandle ih= images[((int[]) iAdjust.get(z))[0]];
- ih.setWidth(((int[]) iAdjust.get(z))[1]);
- }
- }
-
- /** sets the width of this Column in internal units, described as follows:
- * NOTE:
- The last Cell in the column having its width
- set will be the resulting width of the column
- @param int i - desired Column width in internal units
- */
- public void setWidth(int newWidth){
- /* if an image falls upon this column,
- * adjust image width so that it does not change
- */
- ArrayList iAdjust= new ArrayList();
- ImageHandle[] images= myCol.getSheet().getImages();
- if(images!=null) {
- // for each image that falls over this column, trap index + original width -- to be reset after setting col width
- for (int z= 0; z < images.length; z++) {
- ImageHandle ih= images[z];
- int c0= ih.getCol();
- int c1= ih.getCol1();
- int col= myCol.getColFirst(); // should only be one, right?
- if (col>=c0 && col<=c1) {
- int w= ih.getWidth();
- iAdjust.add(new int[]{z,w});
- }
- }
- }
- lastsz = newWidth;
- myCol.setColWidth(newWidth);
- // now adjust any of the images that we noted above
- for (int z= 0; z < iAdjust.size(); z++) {
- ImageHandle ih= images[((int[]) iAdjust.get(z))[0]];
- ih.setWidth(((int[]) iAdjust.get(z))[1]);
- }
- }
-
- /** returns the width of this Column in internal units
- defined as follows:
- *
+ * get a handle to the Cells in a column
+ *
+ *
+ * Note: for a discussion of Column widths see:
+ * http://support.microsoft.com/?kbid=214123
+ *
+ * @see WorkBookHandle
+ *
+ * @see WorkSheetHandle
+ *
+ * @see FormulaHandle
+ */
+class ColHandle
+/**
+ * creates a new ColHandle from a Colinfo Object and reference to a worksheet (WorkSheetHandle Object)
+ *
+ * @param c
+ * @param sheet
+ */
+(private val myCol: Colinfo, private val mySheet: WorkSheetHandle) {
+ private var formatter: FormatHandle? = null
+ private val wbh: WorkBook?
+
+ private var lastsz = 0 // the last checked col width
+
+ /**
+ * returns the width of this Column in internal units
+ * defined as follows:
+ * ()
+ val images = myCol.sheet!!.images
+ if (images != null) {
+ for (z in images.indices) {
+ val ih = images[z]
+ val c0 = ih.col
+ val c1 = ih.col1
+ val col = myCol.colFirst
+ if (col >= c0 && col <= c1) {
+ val w = ih.width.toInt()
+ iAdjust.add(intArrayOf(z, w))
+ }
+ }
+ }
+ lastsz = newWidth
+ myCol.colWidth = newWidth
+ for (z in iAdjust.indices) {
+ val ih = images!![iAdjust[z][0]]
+ ih.setWidth(iAdjust[z][1])
+ }
+ }
+
+
+ /**
+ * returns the width of this Column in Characters or regular Excel units
+ * ()
+ val images = myCol.sheet!!.images
+ if (images != null) {
+ for (z in images.indices) {
+ val ih = images[z]
+ val c0 = ih.col
+ val c1 = ih.col1
+ val col = myCol.colFirst
+ if (col >= c0 && col <= c1) {
+ val w = ih.width.toInt()
+ iAdjust.add(intArrayOf(z, w))
+ }
+ }
+ }
+
+ myCol.setColWidthInChars(newWidth.toDouble())
+ for (z in iAdjust.indices) {
+ val ih = images!![iAdjust[z][0]]
+ ih.setWidth(iAdjust[z][1])
+ }
+ }
+
+ /**
+ * returns the format ID (the index to the format record) for this Column
+ *
+ get() {
+ val mycells: List<*>
+ try {
+ mycells = this.mySheet.boundsheet!!.getCellsByCol(this.colFirst)
+ } catch (e: CellNotFoundException) {
+ return arrayOfNulls(0)
+ }
+
+ val ch = arrayOfNulls(mycells.size)
+ for (t in ch.indices) {
+ ch[t] = CellHandle(mycells[t] as BiffRec, null)
+ ch[t].workSheetHandle = null
+ }
+ return ch
+ }
+
+ /**
+ * Returns the Outline level (depth) of this Column
+ *
+ * @return int outline level
+ */
+ /**
+ * Set the Outline level (depth) of this Column
+ *
+ * @param int x - outline level
+ */
+ var outlineLevel: Int
+ get() = myCol.outlineLevel
+ set(x) {
+ this.myCol.outlineLevel = x
+ }
+
+ /**
+ * returns true if this Column is collapsed
+ *
+ * @return true if ths Column is collapsed, false otherwise
+ */
+ /**
+ * sets whether to collapse this Column
+ *
+ * @param boolean b - true to collapse this Column
+ */
+ var isCollapsed: Boolean
+ get() = myCol.isCollapsed
+ set(b) {
+ this.myCol.isCollapsed = b
+ }
+
+ /**
+ * returns true if this Column is hidden
+ *
+ * @return true if this Column is hidden, false if not
+ */
+ /**
+ * sets whether to hide or show this Column
+ *
+ * @param boolean b - true to hide this Column, false to show
+ */
+ var isHidden: Boolean
+ get() = myCol.isHidden
+ set(b) {
+ this.myCol.isHidden = b
+ }
+
+ init {
+ wbh = mySheet.workBook
+ }
+
+ /**
+ * resizes this column to fit the width of all displayed, non-wrapped text.
+ *
- * CommentHandle allows for manipulation of the Note or Comment feature of Excel
- *
- * In order to create CommentHandles programatically use the methods in WorkSheetHandle or CellHandle
- *
- *
- *
- */
-public class CommentHandle implements Handle {
-
- private Note note;
-
- /**
- * Creates a new CommentHandle object
- * The text may contain embedded formatting information as follows:
- * b - bold
- * "<f=\"Tahoma\";b;sz=\"16\">Note: <f=\"Cambria\";sz=\"12\">This is an important point"
- * To reset to the default font, input an empty format: <> e.g.:
- * "<b;i;sz=\"8\">Note:<>This is an important comment"
- * @param text - String text of Note
- */
- public void setCommentText(String text) {
- if (note!=null) {
- try {
- note.setText(text);
- } catch (IllegalArgumentException e) {
- Logger.logErr(e.toString());
- }
- }
- }
-
- /** returns the author of this Note (Comment) if set
- * @return String author
- */
- public String getAuthor() {
- if (note!=null)
- return note.getAuthor();
- return null;
- }
- /**
- * sets the author of this Note (Comment)
- * @param author
- */
- public void setAuthor(String author) {
- if (note!=null) note.setAuthor(author);
- }
-
- /**
- * Removes or deletes this Note (Comment) from the worksheet
- */
- public void remove() {
- note.getSheet().removeNote(note);
- note= null;
- }
-
- /**
- * Sets this Note (Comment) to always show, even when the attached cell loses focus
- */
- public void show() {
- if (note!=null) note.setHidden(false);
- }
-
- /**
- * Sets this Note (Comment) to be hidden until the attached cell has focus
- *
- * This is the default state of note records
- */
- public void hide() {
- if (note!=null) note.setHidden(true);
- }
-
- /**
- * Returns true if this Note (Comment) is hidden until focus
- * @return
- */
- public boolean getIsHidden() {
- if (note!=null)
- return note.getHidden();
- return false;
- }
-
- /**
- * Sets this Note (Comment) to be attached to a cell at [row, col]
- * @param row int row number (0-based)
- * @param col int column number (0-based)
- */
- public void setRowCol(int row, int col) {
- if (note!=null)
- note.setRowCol(row, col);
- }
-
- /**
- * Returns the address this Note (Comment) is attached to
- * @return String Cell Address
- */
- public String getAddress() {
- if (note!=null)
- return note.getCellAddressWithSheet();
- return null;
- }
-
- /**
- * return the String representation of this CommentHandle
- */
- public String toString() {
- if (note!=null)
- return note.toString();
- return "Not initialized";
- }
-
- /**
- * return the Row number (0-based) this Note is attached to
- * @return 0-based row number
- */
- public int getRowNum() {
- if (note!=null)
- return note.getRowNumber();
- return -1;
- }
-
- /**
- * return the Column this note is attached to
- * @return Column number as an integer e.g. A=0, B=1 ...
- */
- public int getColNum() {
- if (note!=null)
- return note.getColNumber();
- return -1;
- }
-
- /**
- * Sets the width and height of the bounding text box of the note
- * ");
- ooxml.append(note.getOOXML());
- ooxml.append(" ");
- return ooxml.toString();
- }
-
-}
-
diff --git a/src/main/java/io/starter/OpenXLS/CommentHandle.kt b/src/main/java/io/starter/OpenXLS/CommentHandle.kt
new file mode 100644
index 0000000..020e9e6
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/CommentHandle.kt
@@ -0,0 +1,256 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ *
+ * CommentHandle allows for manipulation of the Note or Comment feature of Excel
+ *
+ * In order to create CommentHandles programatically use the methods in WorkSheetHandle or CellHandle
+ *
+ *
+ */
+class CommentHandle
+/**
+ * Creates a new CommentHandle object
+ * ")
+ ooxml.append(internalNoteRec!!.ooxml)
+ ooxml.append(" ")
+ return ooxml.toString()
+ }
+
+}
+
diff --git a/src/main/java/io/starter/OpenXLS/ConditionalFormatHandle.java b/src/main/java/io/starter/OpenXLS/ConditionalFormatHandle.java
deleted file mode 100644
index 3de56ba..0000000
--- a/src/main/java/io/starter/OpenXLS/ConditionalFormatHandle.java
+++ /dev/null
@@ -1,268 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- *
- * ConditionalFormatHandle allows for manipulation of the ConditionalFormat cells in Excel
- *
- * Using the ConditionalFormatHandle, the affected range of ConditionalFormats can be modified,
- * along with the formatting applied to the cells when the condition is true.
- *
- * Each ConditionalFormatHandle represents a range of cells and can have a number
- * of formatting rules and formats (ConditionalFormatRule) applied.
- *
- * The ConditionalFormatHandle affected range can either be a contiguous range, or a series of cells and ranges.
- *
- * Each ConditionalFormatRule contains one rule and corresponding format data.
- *
- *
- * Many of these calls are very self-explanatory and can be found in the api.
- *
- *
- */
-public class ConditionalFormatHandle implements Handle {
-
-
- private Condfmt cndfmt = null;
- private WorkSheetHandle worksheet;
-
-
- /**
- * evaluates the criteria for this Conditional Format
- * cfs = this.cndfmt.getRules();
- ConditionalFormatRule[] rules = new ConditionalFormatRule[cfs.size()];
- for(int i=0;i" );
- if(rules[0].getFirstCondition()!=null) {
- xml.append("" );
- xml.append(rules[0].getFirstCondition());
- xml.append(" " );
- }
- if(rules[0].getSecondCondition()!=null) {
- xml.append("" );
- xml.append(rules[0].getSecondCondition());
- xml.append(" " );
- }
- xml.append("");
- return xml.toString();
- }
- /**
- * return a string representation of this Conditional Format
- *
- * This method is still incomplete as it only returns data for one rule, and only refers to one range
- */
- // TODO: more than one cf rule???
- public String toString(){
- ConditionalFormatRule[] rules = this.getRules();
- String ret= this.getEncompassingRange() + ": " + rules[0].getType() + " " + rules[0].getOperator(); // range, type + operator
- if (rules[0].getFormula1()!=null) // formulas
- ret+= " " + rules[0].getFormula1().getFormulaString().substring(1);
- if (rules[0].getFormula2()!=null)
- ret+= " and " + rules[0].getFormula2().getFormulaString().substring(1);
- // todo: add formats to this
- return ret;
- }
-
- /**
- * @return Returns the cndfmt.
- */
- protected Condfmt getCndfmt() {
- return cndfmt;
- }
-
- /**
- * @param cndfmt The cndfmt to set.
- */
- protected void setCndfmt(Condfmt cndfmt) {
- this.cndfmt = cndfmt;
- }
-
-
- /**
- * Add a cell to this conditional format record
- * @param cellHandle
- */
- public void addCell(CellHandle cellHandle) {
- if (this.contains(cellHandle))return;
- cndfmt.addLocation(cellHandle.getCellAddress());
- }
-
- /**
- * returns the formatting for each rule of this Contditional Format Handle
- * @return FormatHandle[]
- */
- public FormatHandle[] getFormats() {
- FormatHandle[] fmx = new FormatHandle[this.getCndfmt().getRules().size()];
- if (cndfmt.getFormatHandle()==null) {
- //cfm.initCells(this); // added!
- int cfxe= cndfmt.getCfxe();
- FormatHandle fz = new FormatHandle(cndfmt, worksheet.wbh, cfxe, null);
- }
- for (int t = 0; t < fmx.length; t++) {
- cndfmt.getFormatHandle().updateFromCF((Cf)this.getCndfmt().getRules().get(t), worksheet.wbh);
- fmx[t] = cndfmt.getFormatHandle();
- }
- return fmx;
- }
-
-}
diff --git a/src/main/java/io/starter/OpenXLS/ConditionalFormatHandle.kt b/src/main/java/io/starter/OpenXLS/ConditionalFormatHandle.kt
new file mode 100644
index 0000000..e88c2b9
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/ConditionalFormatHandle.kt
@@ -0,0 +1,270 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ *
+ * ConditionalFormatHandle allows for manipulation of the ConditionalFormat cells in Excel
+ *
+ * Using the ConditionalFormatHandle, the affected range of ConditionalFormats can be modified,
+ * along with the formatting applied to the cells when the condition is true.
+ *
+ * Each ConditionalFormatHandle represents a range of cells and can have a number
+ * of formatting rules and formats (ConditionalFormatRule) applied.
+ *
+ * The ConditionalFormatHandle affected range can either be a contiguous range, or a series of cells and ranges.
+ *
+ * Each ConditionalFormatRule contains one rule and corresponding format data.
+ *
+ *
+ * Many of these calls are very self-explanatory and can be found in the api.
+ *
+ */
+class ConditionalFormatHandle
+/**
+ * For internal use only. Creates a ConditionalFormat Handle based of the Condfmt passed in.
+ *
+ * @param workBookHandle
+ * @param Condfmt
+ */
+(c: Condfmt,
+ /**
+ * get the WorkSheetHandle for this ConditionalFormat
+ *
+ *
+ * ConditionalFormats are bound to a specific worksheet and cannot be
+ * applied to multiple worksheets
+ *
+ * @return the WorkSheetHandle for this ConditionalFormat
+ */
+ val workSheetHandle: WorkSheetHandle) : Handle {
+
+
+ /**
+ * @return Returns the cndfmt.
+ */
+ /**
+ * @param cndfmt The cndfmt to set.
+ */
+ var cndfmt: Condfmt? = null
+ protected set
+
+
+ /**
+ * Get all the rules assocated with this conditional format record
+ *
+ * @return
+ */
+ val rules: Array
+ get() {
+ val cfs = this.cndfmt!!.rules
+ val rules = arrayOfNulls(cfs.size)
+ for (i in cfs.indices) {
+ val cfr = ConditionalFormatRule(cfs[i] as Cf)
+ rules[i] = cfr
+ }
+ return rules
+ }
+
+
+ /**
+ * Return the range of data this ConditionalFormatHandle refers to as a string
+ * This location is the largest bounding rectangle that all cells utilized in this conditional
+ * format can be contained in.
+ *
+ * @return Encompassing range in the format "A2:B12"
+ */
+ val encompassingRange: String
+ get() {
+ val rowcols = cndfmt!!.encompassingRange
+ return ExcelTools.formatRangeRowCol(rowcols)
+ }
+
+
+ /**
+ * Return a string representing all ranges that this conditional format handle can affect
+ *
+ * @return range in the format "A2:B3";
+ */
+ val allAffectedRanges: Array
+ get() = cndfmt!!.allRanges
+
+
+ /**
+ * Return an xml representation of the ConditionalFormatHandle
+ *
+ * @return
+ */
+ // TODO: more than one cf rule???
+ val xml: String
+ get() {
+ val rules = this.rules
+ val xml = StringBuffer()
+ xml.append("")
+ if (rules[0].firstCondition != null) {
+ xml.append("")
+ xml.append(rules[0].firstCondition)
+ xml.append(" ")
+ }
+ if (rules[0].secondCondition != null) {
+ xml.append("")
+ xml.append(rules[0].secondCondition)
+ xml.append(" ")
+ }
+ xml.append("")
+ return xml.toString()
+ }
+
+ /**
+ * returns the formatting for each rule of this Contditional Format Handle
+ *
+ * @return FormatHandle[]
+ */
+ //cfm.initCells(this); // added!
+ val formats: Array
+ get() {
+ val fmx = arrayOfNulls(this.cndfmt!!.rules.size)
+ if (cndfmt!!.formatHandle == null) {
+ val cfxe = cndfmt!!.cfxe
+ val fz = FormatHandle(cndfmt!!, workSheetHandle.workBook!!, cfxe, null)
+ }
+ for (t in fmx.indices) {
+ cndfmt!!.formatHandle!!.updateFromCF(this.cndfmt!!.rules[t] as Cf, workSheetHandle.workBook)
+ fmx[t] = cndfmt!!.formatHandle
+ }
+ return fmx
+ }
+
+
+ /**
+ * evaluates the criteria for this Conditional Format
+ * ?
+ get() = currentCf!!.borderColors
+
+ /**
+ * returns the bottom border line color for the current Conditional Format
+ *
+ * @return int bottom border line color constant
+ * @see io.starter.formats.XLS.Cf.getBorderLineColorBottom
+ * @see FormatHandle.COLOR_* constants
+ */
+ /**
+ * @param borderLineColorBottom
+ * @see io.starter.formats.XLS.Cf.setBorderLineColorBottom
+ */
+ var borderLineColorBottom: Int
+ get() = currentCf!!.borderLineColorBottom
+ set(borderLineColorBottom) {
+ currentCf!!.borderLineColorBottom = borderLineColorBottom
+ }
+
+ /**
+ * returns the left border line color for the current Conditional Format
+ *
+ * @return int left border line color constant
+ * @see io.starter.formats.XLS.Cf.getBorderLineColorLeft
+ * @see FormatHandle.COLOR_* constants
+ */
+ /**
+ * @param borderLineColorLeft
+ * @see io.starter.formats.XLS.Cf.setBorderLineColorLeft
+ */
+ var borderLineColorLeft: Int
+ get() = currentCf!!.borderLineColorLeft
+ set(borderLineColorLeft) {
+ currentCf!!.borderLineColorLeft = borderLineColorLeft
+ }
+
+ /**
+ * returns the right border line color for the current Conditional Format
+ *
+ * @return int right border line color constant
+ * @see io.starter.formats.XLS.Cf.getBorderLineColorRight
+ * @see FormatHandle.COLOR_* constants
+ */
+ val borderLineColorRight: Int
+ get() = currentCf!!.borderLineColorRight
+
+ /**
+ * returns the top border line color for the current Conditional Format
+ *
+ * @return int top border line color constant
+ * @see io.starter.formats.XLS.Cf.getBorderLineColorTop
+ * @see FormatHandle.COLOR_* constants
+ */
+ /**
+ * @param borderLineColorTop
+ * @see io.starter.formats.XLS.Cf.setBorderLineColorTop
+ */
+ var borderLineColorTop: Int
+ get() = currentCf!!.borderLineColorTop
+ set(borderLineColorTop) {
+ currentCf!!.borderLineColorTop = borderLineColorTop
+ }
+
+ /**
+ * returns the bottom border line style for the current Conditional Format
+ *
+ * @return int bottom border line style constant
+ * @see io.starter.formats.XLS.Cf.getBorderLineStylesBottom
+ * @see FormatHandle.BORDER* line style constants
+ */
+ /**
+ * @param borderLineStylesBottom
+ * @see io.starter.formats.XLS.Cf.setBorderLineStylesBottom
+ */
+ var borderLineStylesBottom: Int
+ get() = currentCf!!.borderLineStylesBottom
+ set(borderLineStylesBottom) {
+ currentCf!!.borderLineStylesBottom = borderLineStylesBottom
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getBorderLineStylesLeft
+ */
+ /**
+ * @param borderLineStylesLeft
+ * @see io.starter.formats.XLS.Cf.setBorderLineStylesLeft
+ */
+ var borderLineStylesLeft: Int
+ get() = currentCf!!.borderLineStylesLeft
+ set(borderLineStylesLeft) {
+ currentCf!!.borderLineStylesLeft = borderLineStylesLeft
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getBorderLineStylesRight
+ */
+ /**
+ * @param borderLineStylesRight
+ * @see io.starter.formats.XLS.Cf.setBorderLineStylesRight
+ */
+ var borderLineStylesRight: Int
+ get() = currentCf!!.borderLineStylesRight
+ set(borderLineStylesRight) {
+ currentCf!!.borderLineStylesRight = borderLineStylesRight
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getBorderLineStylesTop
+ */
+ /**
+ * @param borderLineStylesTop
+ * @see io.starter.formats.XLS.Cf.setBorderLineStylesTop
+ */
+ var borderLineStylesTop: Int
+ get() = currentCf!!.borderLineStylesTop
+ set(borderLineStylesTop) {
+ currentCf!!.borderLineStylesTop = borderLineStylesTop
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getBorderSizes
+ */
+ val borderSizes: IntArray?
+ get() = currentCf!!.borderSizes
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getBorderStyles
+ */
+ val borderStyles: IntArray?
+ get() = currentCf!!.borderStyles
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFont
+ */
+ val font: Font?
+ get() = currentCf!!.font
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontColorIndex
+ */
+ /**
+ * @param fontColorIndex
+ * @see io.starter.formats.XLS.Cf.setFontColorIndex
+ */
+ var fontColorIndex: Int
+ get() = currentCf!!.fontColorIndex
+ set(fontColorIndex) {
+ currentCf!!.fontColorIndex = fontColorIndex
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontEscapement
+ */
+ /**
+ * @param fontEscapementFlag
+ * @see io.starter.formats.XLS.Cf.setFontEscapement
+ */
+ var fontEscapement: Int
+ get() = currentCf!!.fontEscapement
+ set(fontEscapementFlag) {
+ currentCf!!.fontEscapement = fontEscapementFlag
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontHeight
+ */
+ /**
+ * @param fontHeight
+ * @see io.starter.formats.XLS.Cf.setFontHeight
+ */
+ var fontHeight: Int
+ get() = currentCf!!.fontHeight
+ set(fontHeight) {
+ currentCf!!.fontHeight = fontHeight
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontOptsCancellation
+ */
+ /**
+ * @param fontOptsCancellation
+ * @see io.starter.formats.XLS.Cf.setFontOptsCancellation
+ */
+ var fontOptsCancellation: Int
+ get() = currentCf!!.fontOptsCancellation
+ set(fontOptsCancellation) {
+ currentCf!!.fontStriken = fontOptsCancellation == Cf.FONT_OPTIONS_CANCELLATION_ON
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontOptsPosture
+ */
+ /**
+ * @param fontOptsPosture
+ * @see io.starter.formats.XLS.Cf.setFontOptsPosture
+ */
+ var fontOptsPosture: Int
+ get() = currentCf!!.fontOptsPosture
+ set(fontOptsPosture) {
+ currentCf!!.fontOptsPosture = fontOptsPosture
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontUnderlineStyle
+ */
+ /**
+ * @param fontUnderlineStyle
+ * @see io.starter.formats.XLS.Cf.setFontUnderlineStyle
+ */
+ var fontUnderlineStyle: Int
+ get() = currentCf!!.fontUnderlineStyle
+ set(fontUnderlineStyle) {
+ currentCf!!.fontUnderlineStyle = fontUnderlineStyle
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFontWeight
+ */
+ /**
+ * @param fontWeight
+ * @see io.starter.formats.XLS.Cf.setFontWeight
+ */
+ var fontWeight: Int
+ get() = currentCf!!.fontWeight
+ set(fontWeight) {
+ currentCf!!.fontWeight = fontWeight
+ }
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getForegroundColor
+ */
+ val foregroundColor: Int
+ get() = currentCf!!.foregroundColor
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.XLSRecord.getFormatPattern
+ */
+ val formatPattern: String?
+ get() = currentCf!!.formatPattern
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFormula1
+ */
+ val formula1: Formula?
+ get() = currentCf!!.formula1
+
+ /**
+ * @return
+ * @see io.starter.formats.XLS.Cf.getFormula2
+ */
+ val formula2: Formula?
+ get() = currentCf!!.formula2
+
+ /**
+ * returns the operator for this Conditional Format Rule
- * Excel stores dates as the number of days since midnight on January 1, 1900.
- * Times are represented as fractional days. For example, 6:00 AM on February 2,
- * 1900 is represented as 33.25. Excel incorrectly treats 1900 as a leap year,
- * so serial dates after February 28, 1900 are one higher than they otherwise
- * should be and the value 60 is unmapped. It also interprets the value 0 as
- * January 0, 1900.
- *
- * Excel does not support negative serial date values, so it cannot handle dates
- * prior to 1900. It also does not currently accept date values with a year of
- * 10000 or greater. OpenXLS does not currently support negative date values,
- * but this feature is planned. If you wish to restrict the output to the subset
- * of values supported by Excel, you may enable input validation by calling
- * {@link #setValidate}.
- *
- * Due to the inherent inaccuracy of floating-point types, values from this
- * class can only be guaranteed to equal values generated by Excel to eight
- * decimal places. This provides accuracy to the unit milliseconds, the maximum
- * precision of Java's date classes. Accuracy outside the range supported by
- * Excel is not guaranteed and will degrade as the values get farther from zero.
- *
- */
-public class DateConverter {
- /** The number of milliseconds in a day. */
- private static final int MILLIS_DAY = 86400000;
-
- /** The extra day caused by the 1900 leap year bug. */
- private static final int EXTRA_DAY = 60;
-
- /** Calendar used for date calculation. */
- private static Calendar calendar = Calendar.getInstance();
-
- /** Whether to validate input dates for Excel compatibility. */
- private static boolean validate = false;
-
- /** The set of supported serial date encoding schemes. */
- public static enum DateFormat {
- /** 1900 epoch with negative value support as used in OOXML.
- *
- * Lower limit: -9999/01/01 00:00:00, value -4 346 018
- * Epoch date: 1899/12/31 00:00:00, value 0
- * In this system 1900 is (incorrectly) considered a leap year. Serial
- * dates after 1900/02/28 are one higher than they otherwise should be
- * and the value 60 is unmapped.
- */
- LEGACY_1900( 25568, 1, 2958465.9999884 ),
-
- /** 1904 epoch without negative value support as used by Excel for Mac.
- *
- * Epoch date: 1904/01/01 00:00:00, value 0 props = new HashMap();
-
- /** Handling for a streaming worksheet based workbook **/
- private boolean streamingSheets = false;
-
- /**
- * default constructor
- */
- public DocumentHandle() {
- super();
-
- }
-
- /**
- * Apr 5, 2011
- * @param urlx
- */
- public DocumentHandle(InputStream urlx) {
- super();
- // TODO Auto-generated constructor stub
- Logger.logErr("DocumentHandle InputStream Constructor Not Implemented");
- }
-
- /** Retrieves a property in the workbook property store.
- * This is not an Excel-compatible feature.
- *
- * @param name the name of the property to retrieve
- * @return the value of the requested property or null if it doesn't exist
- */
- public Object getProperty(String name) {
- return props.get(name);
- }
-
- /** Sets the value of a property in the workbook property store.
- * This is not an Excel-compatible feature.
- *
- * @param name the name of the property which should be updated
- * @param value the value to which the property should be set
- */
- public void addProperty(String name, Object val) {
- props.put(name,val);
- }
-
- /** Retrieves a Map containing the workbook properties store.
- * This is not an Excel-compatible feature.
- * @return an immutable Map containing the current workbook properties
- */
- public Map getProperties() {
- return Collections.unmodifiableMap( props );
- }
-
- /** Replaces the workbook properties with the values in a given Map.
- * This is not an Excel-compatible feature.
- *
- * @param properties the values that will replace the existing properties
- */
- public void setProperties(Map properties) {
- props = new HashMap();
- props.putAll( properties );
- }
-
- /** Gets the OpenXLS version number.
- */
- public static String getVersion() {
- return GetInfo.getVersion();
- }
-
- /** Sets the user-visible descriptive name or title of this document.
- * Some formats will persist this setting in the document itself.
- */
- public void setName(String nm) {
- name = nm;
- }
-
-
- /** Handling for streaming sheets. Currently this is in development and unsupported
- * @param streamSheets
- */
- public void setStreamingSheets(boolean streamSheets) {
- this.streamingSheets = streamSheets;
- }
-
- /** Sets the file name associated with this document.
- * @deprecated Use {@link #setFile(File)} instead.
- */
- public void setFileName (String name) {
- file = new File( name ).getAbsoluteFile();
- }
-
- /** Sets the file associated with this document.
- */
- public void setFile (File file) {
- this.file = file;
- }
-
- /** Gets the file associated with this document.
- * For documents read in from a file, this defaults to that file. If no
- * file is associated with this document, for example if the document was
- * parsed from a stream, this may return null.
- */
- public File getFile() {
- return file;
- }
-
- /** Looks for magic numbers in the given input data and attempts to parse
- * it with an appropriate DocumentHandle subclass. Detection
- * is performed on a best-effort basis and is not guaranteed to be accurate.
- * @throws IOException if an error occurs while reading from the stream
- * @throws WorkBookException if parsing fails
- */
- public static DocumentHandle getInstance (InputStream input)
- throws IOException {
- BufferedInputStream bufferedStream = new BufferedInputStream(input);
- // read in that start of the file for checking magic numbers
- byte[] headerBytes;
- int count;
- // make sure the file is long enough to get magic numbers
- bufferedStream.mark(1028);
- headerBytes = new byte[ 512 ];
- count = bufferedStream.read( headerBytes );
- bufferedStream.reset();
-
- // if it starts with the LEO magic number check the header
- if (LEOFile.checkIsLEO( headerBytes, count )) {
- LEOFile leo = new LEOFile( bufferedStream );
-
- if (leo.hasWorkBook()) return new WorkBookHandle( leo );
- else throw new WorkBookException(
- "input is LEO but no supported format detected", -1 );
- }
-
- String headerString;
- try {
- headerString = new String( headerBytes, 0, count, "UTF-8" );
- } catch (UnsupportedEncodingException e) {
- // UTF-8 support is required by the JLS
- throw new Error( "the JVM does not support UTF-8", e );
- }
-
- // if it's a ZIP archive, try parsing as OOXML
- if (headerString.startsWith( "PK" )) {
- return new WorkBookHandle( bufferedStream );
- }
-
- if((headerString.indexOf(",")>-1)
- &&(headerString.indexOf(",")>-1)){
- // init a blank workbook
- WorkBookHandle book = new WorkBookHandle();
-
-
- // map CSV into workbook
- try{
- WorkSheetHandle sheet = book.getWorkSheet( 0 );
- sheet.readCSV( new BufferedReader(
- new InputStreamReader( bufferedStream ) ) );
- return book;
- }catch(Exception e){
- throw new WorkBookException(
- "Error encountered importing CSV: " + e.toString(), WorkBookException.ILLEGAL_INIT_ERROR);
- }
- }
-
- else {
- throw new WorkBookException( "unknown file format", -1 );
- }
- }
-
- /** Gets the file name associated with this document.
- * For documents read in from a file, this defaults to that file. If no
- * file is associated with this document, for example if the document was
- * parsed from a stream, this may return null.
- * @deprecated Use {@link #getFile()} instead.
- */
- public String getFileName(){
- return file != null ? file.getPath() : "New Document.doc";
- }
-
- /** Sets the debugging output level.
- * Higher values will produce more output. Output at higher values will
- * generally only be of use to OpenXLS developers. Increased output incurs
- * a performance penalty, so it is recommended this be left at zero unless
- * you are reporting a bug.
- */
- public void setDebugLevel (int level) {
- DEBUGLEVEL = level;
- }
-
- public int getDebugLevel() { return DEBUGLEVEL; }
-
- /** Downloads the resource at the given URL to a temporary file.
- * @param u the URL representing the resource to be downloaded
- * @return the path to a temporary file containing the downloaded resource
- * or null if an error occurred
- * @deprecated The download should be handled outside OpenXLS.
- * There is no specific replacement for this method.
- */
- @Deprecated
- protected static File getFileFromURL(URL u) {
- try{
- File fx = TempFileManager.createTempFile("upload-"+System.currentTimeMillis(),".tmp");
-
- URLConnection uc = u.openConnection();
- String contentType = uc.getContentType();
- int contentLength = uc.getContentLength();
- if (contentType.startsWith("text/") || contentLength == -1) {
- throw new IOException("This is not a binary file.");
- }
- InputStream raw = uc.getInputStream();
- InputStream in = new BufferedInputStream(raw);
- byte[] data = new byte[contentLength];
- int bytesRead = 0;
- int offset = 0;
- while (offset < contentLength) {
- bytesRead = in.read(data, offset, data.length - offset);
- if (bytesRead == -1)
- break;
- offset += bytesRead;
- }
- in.close();
-
- if (offset != contentLength) {
- throw new IOException("Only read " + offset + " bytes; Expected " + contentLength + " bytes");
- }
-
- // String filename = u.getFile().substring(filename.lastIndexOf('/') + 1);
- FileOutputStream out = new FileOutputStream(fx);
- out.write(data);
- out.flush();
- out.close();
- return fx;
- }catch(Exception e){
- Logger.logErr("Could not load WorkBook from URL: " + e.toString());
- return null;
- }
- }
-
- /** Gets the user-visible descriptive name or title of this document.
- */
- public String getName(){
- if(name!=null)
- return name;
- else
- return "Untitled Document";
- }
-
- /** Resets the document state to what it was when it was loaded.
- * @throws UnsupportedOperationException if there is not sufficient data
- * available to perform the reversion
- */
- public abstract void reset();
-
- /** Gets the constant representing this document's native format.
- */
- public abstract int getFormat();
-
- /** Gets the file name extension for this document's native format.
- */
- public abstract String getFileExtension();
-
- /** Writes the document to the given stream in the requested format.
- * @param dest the stream to which the document should be written
- * @param format the constant representing the desired output format
- * @throws IllegalArgumentException if the given type code is invalid
- * @throws IOException if an error occurs while writing to the stream
- */
- public abstract void write (OutputStream dest, int format)
- throws IOException;
-
- /** Writes the document to the given stream in its native format.
- * @param dest the stream to which the document should be written
- * @throws IOException if an error occurs while writing to the stream
- */
- public void write (OutputStream dest)
- throws IOException {
- this.write( dest, FORMAT_NATIVE );
- }
-
- /** Writes the document to the given file in the requested format.
- * @param file the path to which the document should be written
- * @param format the constant representing the desired output format
- * @throws IllegalArgumentException if the given type code is invalid
- * @throws IOException if an error occurs while writing to the file
- */
- public void write (File file, int format)
- throws IOException {
- if (format > WorkBookHandle.FORMAT_XLS && this.file!=null)
- OOXMLAdapter.refreshPassThroughFiles((WorkBookHandle)this);
-
- if (file.exists()) file.delete(); // try this
- OutputStream stream = new BufferedOutputStream(new FileOutputStream( file ) );
- this.write( stream, format );
- this.file= file; // necesary for OOXML re-write ...
- stream.flush();
- stream.close();
- }
-
- /** Writes the document to the given file in its native format.
- * @param file the path to which the document should be written
- * @throws IOException if an error occurs while writing to the stream
- */
- public void write (File file)
- throws IOException {
- this.write( file, FORMAT_NATIVE );
- }
-
- /** Returns a string representation of the object.
- * This is currently equivalent to {@link #getName()}.
- */
- public String toString() {
- return getName();
- }
-}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/DocumentHandle.kt b/src/main/java/io/starter/OpenXLS/DocumentHandle.kt
new file mode 100644
index 0000000..063ccfb
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/DocumentHandle.kt
@@ -0,0 +1,419 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or
+ * modify
+ * it under the terms of the GNU Lesser General Public
+ * License as
+ * published by the Free Software Foundation, either version
+ * 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be
+ * useful,
+ * but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
+ * the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public
+ * License along with OpenXLS. If not, see
+ * = HashMap()
+
+ /**
+ * Handling for a streaming worksheet based workbook
+ */
+ private var streamingSheets = false
+
+ /**
+ * Retrieves a Map containing the workbook properties store.
+ * This is not an Excel-compatible feature.
+ *
+ * @return an immutable Map containing the current workbook properties
+ */
+ /**
+ * Replaces the workbook properties with the values in a given Map.
+ * This is not an Excel-compatible feature.
+ *
+ * @param properties the values that will replace the existing properties
+ */
+ var properties: Map
+ get() = Collections.unmodifiableMap(props)
+ set(properties) {
+ props = HashMap()
+ props.putAll(properties)
+ }
+
+ /**
+ * Gets the file name associated with this document.
+ * For documents read in from a file, this defaults to that file. If no
+ * file is associated with this document, for example if the document was
+ * parsed from a stream, this may return `null`.
+ *
+ */
+ /**
+ * Sets the file name associated with this document.
+ *
+ */
+ var fileName: String
+ @Deprecated("Use {@link #getFile()} instead.")
+ get() = if (file != null) file!!.path else "New Document.doc"
+ @Deprecated("Use {@link #setFile(File)} instead.")
+ set(name) {
+ file = File(name).absoluteFile
+ }
+
+ /**
+ * Gets the constant representing this document's native format.
+ */
+ abstract val format: Int
+
+ /**
+ * Gets the file name extension for this document's native format.
+ */
+ abstract val fileExtension: String
+
+ /**
+ * default constructor
+ */
+ constructor() : super() {
+
+ }
+
+ /**
+ * Apr 5, 2011
+ *
+ * @param urlx
+ */
+ constructor(urlx: InputStream) : super() {
+ // TODO Auto-generated constructor stub
+ Logger.logErr("DocumentHandle InputStream Constructor Not Implemented")
+ }
+
+ constructor(input: File) {
+ // TODO Auto-generated constructor stub
+ }
+
+ /**
+ * Retrieves a property in the workbook property store.
+ * This is not an Excel-compatible feature.
+ *
+ * @param name the name of the property to retrieve
+ * @return the value of the requested property or null if it doesn't exist
+ */
+ override fun getProperty(name: String): Any {
+ return props[name]
+ }
+
+ /**
+ * Sets the value of a property in the workbook property store.
+ * This is not an Excel-compatible feature.
+ *
+ * @param name the name of the property which should be updated
+ * @param value the value to which the property should be set
+ */
+ override fun addProperty(name: String, `val`: Any) {
+ props[name] = `val`
+ }
+
+ /**
+ * Sets the user-visible descriptive name or title of this document.
+ * Some formats will persist this setting in the document itself.
+ */
+ override fun setName(nm: String) {
+ name = nm
+ }
+
+ /**
+ * Handling for streaming sheets. Currently this is in development and unsupported
+ *
+ * @param streamSheets
+ */
+ fun setStreamingSheets(streamSheets: Boolean) {
+ this.streamingSheets = streamSheets
+ }
+
+ /**
+ * Sets the debugging output level.
+ * Higher values will produce more output. Output at higher values will
+ * generally only be of use to OpenXLS developers. Increased output incurs
+ * a performance penalty, so it is recommended this be left at zero unless
+ * you are reporting a bug.
+ */
+ override fun setDebugLevel(level: Int) {
+ DEBUGLEVEL = level
+ }
+
+ fun getDebugLevel(): Int {
+ return DEBUGLEVEL
+ }
+
+ /**
+ * Gets the user-visible descriptive name or title of this document.
+ */
+ override fun getName(): String {
+ return if (name != null)
+ name
+ else
+ "Untitled Document"
+ }
+
+ /**
+ * Resets the document state to what it was when it was loaded.
+ *
+ * @throws UnsupportedOperationException if there is not sufficient data
+ * available to perform the reversion
+ */
+ abstract override fun reset()
+
+ /**
+ * Writes the document to the given stream in the requested format.
+ *
+ * @param dest the stream to which the document should be written
+ * @param format the constant representing the desired output format
+ * @throws IllegalArgumentException if the given type code is invalid
+ * @throws IOException if an error occurs while writing to the stream
+ */
+ @Throws(IOException::class)
+ abstract override fun write(dest: OutputStream, format: Int)
+
+ /**
+ * Writes the document to the given stream in its native format.
+ *
+ * @param dest the stream to which the document should be written
+ * @throws IOException if an error occurs while writing to the stream
+ */
+ @Throws(IOException::class)
+ override fun write(dest: OutputStream) {
+ this.write(dest, FORMAT_NATIVE)
+ }
+
+ /**
+ * Writes the document to the given file in the requested format.
+ *
+ * @param file the path to which the document should be written
+ * @param format the constant representing the desired output format
+ * @throws IllegalArgumentException if the given type code is invalid
+ * @throws IOException if an error occurs while writing to the file
+ */
+ @Throws(IOException::class)
+ override fun write(file: File, format: Int) {
+ if (format > WorkBookHandle.FORMAT_XLS && this.file != null)
+ OOXMLAdapter.refreshPassThroughFiles(this as WorkBookHandle)
+
+ if (file.exists())
+ file.delete() // try this
+ val stream = BufferedOutputStream(
+ FileOutputStream(file))
+ this.write(stream, format)
+ this.file = file // necesary for OOXML re-write ...
+ stream.flush()
+ stream.close()
+ }
+
+ /**
+ * Writes the document to the given file in its native format.
+ *
+ * @param file the path to which the document should be written
+ * @throws IOException if an error occurs while writing to the stream
+ */
+ @Throws(IOException::class)
+ override fun write(file: File) {
+ this.write(file, FORMAT_NATIVE)
+ }
+
+ /**
+ * Returns a string representation of the object.
+ * This is currently equivalent to [.getName].
+ */
+ override fun toString(): String {
+ return getName()
+ }
+
+ companion object {
+
+ var workingdir = System.getProperty("user.dir") + "/tmp"
+
+ /**
+ * Format constant for the most appropriate format for this document.
+ * If the document was read in from a file, this is usually the format that
+ * was read in.
+ */
+ val FORMAT_NATIVE = 0
+
+ /**
+ * Gets the OpenXLS version number.
+ */
+ val version: String
+ get() = GetInfo.getVersion()
+
+ /**
+ * Looks for magic numbers in the given input data and attempts to parse
+ * it with an appropriate `DocumentHandle` subclass. Detection
+ * is performed on a best-effort basis and is not guaranteed to be accurate.
+ *
+ * @throws IOException if an error occurs while reading from the stream
+ * @throws WorkBookException if parsing fails
+ */
+ @Throws(IOException::class)
+ fun getInstance(input: InputStream): DocumentHandle {
+ val bufferedStream = BufferedInputStream(input)
+ // read in that start of the file for checking magic numbers
+ val headerBytes: ByteArray
+ val count: Int
+ // make sure the file is long enough to get magic numbers
+ bufferedStream.mark(1028)
+ headerBytes = ByteArray(512)
+ count = bufferedStream.read(headerBytes)
+ bufferedStream.reset()
+
+ // if it starts with the LEO magic number check the header
+ if (LEOFile.checkIsLEO(headerBytes, count)) {
+ val leo = LEOFile(bufferedStream)
+
+ return if (leo.hasWorkBook())
+ WorkBookHandle(leo)
+ else
+ throw WorkBookException(
+ "input is LEO but no supported format detected", -1)
+ }
+
+ val headerString: String
+ headerString = String(headerBytes, 0, count, StandardCharsets.UTF_8)
+
+ // if it's a ZIP archive, try parsing as OOXML
+ if (headerString.startsWith("PK")) {
+ return WorkBookHandle(bufferedStream)
+ }
+
+ if (headerString.indexOf(",") > -1 && headerString.indexOf(",") > -1) {
+ // init a blank workbook
+ val book = WorkBookHandle()
+
+ // map CSV into workbook
+ try {
+ val sheet = book.getWorkSheet(0)
+ sheet.readCSV(BufferedReader(
+ InputStreamReader(bufferedStream)))
+ return book
+ } catch (e: Exception) {
+ throw WorkBookException(
+ "Error encountered importing CSV: $e",
+ WorkBookException.ILLEGAL_INIT_ERROR)
+ }
+
+ } else {
+ throw WorkBookException("unknown file format", -1)
+ }
+ }
+
+ /**
+ * Downloads the resource at the given URL to a temporary file.
+ *
+ * @param u the URL representing the resource to be downloaded
+ * @return the path to a temporary file containing the downloaded resource
+ * or `null` if an error occurred
+ */
+ @Deprecated("The download should be handled outside OpenXLS.\n" +
+ " There is no specific replacement for this method.")
+ protected fun getFileFromURL(u: URL): File? {
+ try {
+ val fx = TempFileManager.createTempFile("upload-" + System.currentTimeMillis(), ".tmp")
+
+ val uc = u.openConnection()
+ val contentType = uc.contentType
+ val contentLength = uc.contentLength
+ if (contentType.startsWith("text/") || contentLength == -1) {
+ throw IOException("This is not a binary file.")
+ }
+ val raw = uc.getInputStream()
+ val `in` = BufferedInputStream(raw)
+ val data = ByteArray(contentLength)
+ var bytesRead = 0
+ var offset = 0
+ while (offset < contentLength) {
+ bytesRead = `in`.read(data, offset, data.size - offset)
+ if (bytesRead == -1)
+ break
+ offset += bytesRead
+ }
+ `in`.close()
+
+ if (offset != contentLength) {
+ throw IOException("Only read " + offset
+ + " bytes; Expected " + contentLength + " bytes")
+ }
+
+ // String filename =
+ // u.getFile().substring(filename.lastIndexOf('/') + 1);
+ val out = FileOutputStream(fx)
+ out.write(data)
+ out.flush()
+ out.close()
+ return fx
+ } catch (e: Exception) {
+ Logger.logErr("Could not load WorkBook from URL: $e")
+ return null
+ }
+
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/DocumentObjectNotFoundException.java b/src/main/java/io/starter/OpenXLS/DocumentObjectNotFoundException.java
deleted file mode 100644
index 06b2dad..0000000
--- a/src/main/java/io/starter/OpenXLS/DocumentObjectNotFoundException.java
+++ /dev/null
@@ -1,34 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- * ;;; */
- String[] pats= pattern.split(";"); // assign the correct pattern according to double or string value
-
- String tester= StringTool.convertPatternExtractBracketedExpression(pats[0]);
- if (tester.matches(".*(((y{1,4}|m{1,5}|d{1,4}|h{1,2}|s{1,2}).*)+).*")) {
- isDate= true;
- pats[0]= tester; // ignore locale and other info for dates ...
- }
- if (!isDate)
- {
- int idx= pats.length-1; // default with string
- try{
- double d = new Double(o.toString());
- isNumeric= true;
- if (d > 0) // 1st expression is for + numbers
- idx= 0;
- else if (pats.length > 1 && d < 0) // 2nd is for - numbers
- idx= 1;
- else if (pats.length > 2 && d==0) // 3rd for 0
- idx= 2;
- pattern= StringTool.convertPatternFromExcelToStringFormatter(pats[idx], d < 0); // get correct format for String.format formatter
- } catch (NumberFormatException e) { // 4th for text (non-numeric)
- if (pats.length > 3)
- idx= 3;
- isString= true;
- pattern= StringTool.convertPatternFromExcelToStringFormatter(pats[idx], false); // get correct format for String.format formatter
- }
- } else {
- pattern= pats[0];
- pattern= StringTool.convertDatePatternFromExcelToStringFormatter(pattern); // get correct format for SimpleDateFormat
- }
-
-
- if (isString) { // use string portion of format, if any
- try {
- return String.format(pattern, o);
- } catch (IllegalFormatConversionException e) {
- return o.toString();
- }
- }
- if (isNumeric) {
- try{
- double d = new Double(o.toString());
- if (!Double.isNaN(d)) {
- d= Math.abs(d); // negative number intricacies have been handled in convertPattern method
- // ugly, but has to be done ...
- if (pattern.indexOf("%%")!=-1) // convert to percent
- d*=100;
- // special case of "@" -- integers converted to doubles format incorrectly ...
- if (pattern.equals("%s")) {
- return o.toString();
- }
- return String.format(pattern, d);
- }
- } catch (Exception e) {
- }
- return o.toString();
- }
- if (isDate) {
- try{
- WorkBookHandle.simpledateformat.applyPattern(pattern);
- }catch(Exception ex) {
- return o.toString();
- }
- try {
- return WorkBookHandle.simpledateformat.format(DateConverter.getCalendarFromNumber(o).getTime());
-/*// KSC: TESTING
-Date d= DateConverter.getCalendarFromNumber(o).getTime();
-return WorkBookHandle.simpledateformat.format(d);*/
- } catch (NumberFormatException e) {
- try {
- return WorkBookHandle.simpledateformat.format(new Date(o.toString()).getTime());
- } catch (IllegalArgumentException i) {
- if (o instanceof Number)
- Logger.logWarn("Unable to format date in " + pattern);
- }
- } catch (IllegalArgumentException e) {
- if (o instanceof Number)
- Logger.logWarn("Unable to format date in " + pattern);
- }
- }
- // otherwise
- return o.toString();
- }
-
-
-
-
-
- /**
- * A FAIL FAST implementation for finding whether a cell string address
- * falls within a set of row/col range coordinates.
- *
- * Sep 21, 2010
- *
- * @param rng
- * the range you want to test
- * @param rowFirst
- * in the target range
- * @param rowLast
- * in the target range
- * @param colFirst
- * in the target range
- * @param colLast
- * in the target range
- * @return
- */
- public static boolean isInRange(String rng, int rowFirst, int rowLast,
- int colFirst, int colLast) {
- int[] sh = io.starter.OpenXLS.ExcelTools.getRowColFromString(rng);
-
- // the guantlet
- if (sh[1] < colFirst)
- return false;
- if (sh[1] > colLast)
- return false;
- if (sh[0] < rowFirst)
- return false;
- if (sh[0] > rowLast)
- return false;
-
- return true; // passes!
-
- }
-
- /**
- * returns true if range intersects with range2
- *
- * @param rng
- * @param rc
- * @return
- */
- public static boolean intersects(String rng, int[] rc) {
- int[] rc2 = ExcelTools.getRangeCoords(rng);
- if ((rc[0] >= rc2[0]) && (rc[2] <= rc2[2]) && (rc[1] >= rc2[1])
- && (rc[3] <= rc2[3]))
- return true;
- return false;
- }
-
- /**
- * returns true if address is before the range coordinates defined by rc
- *
- * @param rc
- * row col of address
- * @param rng
- * int[] coordinates as: row0, col0, row1, col1
- * @return true if address is before the range coordinates
- */
- public static boolean isBeforeRange(int[] rc, int[] rng) {
- if (rc[0] < rng[0] || (rc[0] == rng[0] && rc[1] < rng[1]))
- return true;
- return false;
- }
-
- /**
- * returns true if address is before the range coordinates defined by rc
- *
- * @param rc
- * row col of address
- * @param rng
- * int[] coordinates as: row0, col0, row1, col1
- * @return true if address is before the range coordinates
- */
- public static boolean isAfterRange(int[] rc, int[] rng) {
- if (rc[0] > rng[2] || (rc[0] == rng[2] && rc[1] > rng[3]))
- return true;
- return false;
- }
-
- /**
- * Takes an input Object and attempts to convert to numeric Objects of the
- * highest precision possible.
- *
- * This method is useful for avoiding the Excel warnings
- * "Number Stored As Text" when storing string data that contains numbers.
- *
- * NOTE: this method is useful for ensuring that Formula references contain
- * true numeric values as not all String numbers are properly interpreted in
- * Formula engines, and can silently fail.
- *
- * For this reason, always use numeric, non-string values to calculated
- * cells.
- *
- *
- * @param input
- * @return
- */
- public static Object getObject(Object in) {
- // do not record -- only called from other methods
- if (!(in instanceof String)) {
- return in;
- }
-
- String input = String.valueOf(in);
- Object ret = input; // default is the original string
-
- try {
- ret = new Double(input);
- return ret;
- } catch (NumberFormatException ex) {
- try {
- ret = new Float(input);
- return ret;
- } catch (NumberFormatException ex2) {
- try {
- ret = Integer.valueOf(input);
- return ret;
- } catch (NumberFormatException ex3) {
- // ret Is set outside of loop incase no match is ever found.
- }
- }
- }
-
- // list of formatting chars to check for
- String[][] fmtlist = { { "$", "," }, { ",", "," }, { "%", "," } };
-
- // strip the formatting
- for (int t = 0; t < fmtlist.length; t++) {
- if (input.indexOf(fmtlist[t][0]) > -1) { // contains!
- String converted = StringTool.replaceText(input, fmtlist[t][0],
- ""); // strip first token (ie: '$')
- converted = StringTool
- .replaceText(converted, fmtlist[t][1], ""); // strip
- // second
- // token
- // (ie: ',')
- try {
- ret = new Double(converted);
- return ret;
- } catch (NumberFormatException ex) {
- try {
- ret = new Float(converted);
- return ret;
- } catch (NumberFormatException ex2) {
- try {
- ret = Integer.valueOf(converted);
- return ret;
- } catch (NumberFormatException ex3) {
- // ret Is set outside of loop incase no match is
- // ever found.
- }
- }
- }
- }
-
- }
-
- return ret;
- }
-
- /**
- * convert twips to pixels
- *
- *
- * In addition to a calculated size unit derived from the average size of
- * the default characters 0-9, Excel uses the 'twips' measurement which is
- * defined as:
- *
- * 1 twip = 1/20 point or 20 twips = 1 point 1 twip = 1/567 centimeter or
- * 567 twips = 1 centimeter 1 twip = 1/1440 inch or 1440 twips = 1 inch
- *
- *
- * 1 pixel = 0.75 points 1 pixel * 1.3333 = 1 point 1 twip * 20 = 1 point
- *
- * @param pixels
- * @return twips
- */
- public static final float getPixels(float twips) {
- float points = twips / 20;
- float pixels = points * 1.3333333f; // good enuff precision
- return pixels;
- }
-
- /**
- * convert pixels to twips
- *
- *
- * In addition to a calculated size unit derived from the average size of
- * the default characters 0-9, Excel uses the 'twips' measurement which is
- * defined as:
- *
- * 1 pixel = 0.75 points 1 pixel * 1.3333 = 1 point 1 twip * 20 = 1 point
- *
- * @param pixels
- * @return twips
- */
- public static final float getTwips(float pixels) {
- float points = pixels * .75f;
- float twips = points * 20;
- return twips;
- }
-
- /**
- * get recordy byte def as a String
- *
- * public static String getRecordByteDef(XLSRecord rec){ byte[] b =
- * rec.read(); StringBuffer sb = new StringBuffer("byte[] rbytes = {");
- * for(int t = 0;t start time, last time,
- * start mem, last mem
- *
- * @param info
- * @param perfobj
- */
- public static void benchmark(String info, Object perfobj) {
- Runtime rt = Runtime.getRuntime();
- long[] p = null;
- long lasttime = 0l, lastmem = 0l;
- if (System.getProperties().get(perfobj.toString()) != null) {
- p = (long[]) System.getProperties().get(perfobj.toString());
- lasttime = p[1];
- lastmem = p[3];
- p[1] = System.currentTimeMillis();
- p[3] = rt.freeMemory();
- double elapsedsec = p[1] - lasttime;
- double usedmem = lastmem - p[3]; // - lastmem;
- if (usedmem < 0)
- usedmem *= -1;
- Logger.logInfo(getLogDate() + " " + info);
- Logger.logInfo(" time: " + elapsedsec + " millis");
- Logger.logInfo(" mem: " + usedmem + " bytes.");
- } else {
- p = new long[4];
- p[0] = System.currentTimeMillis();
- p[1] = System.currentTimeMillis();
- p[2] = rt.freeMemory();
- p[3] = rt.freeMemory();
- lasttime = p[1];
- lastmem = p[3];
- System.getProperties().put(perfobj.toString(), p);
- }
-
- }
-
- /**
- * get the bytes from a Vector of objects public byte[]
- * getBytesFrom(CompatibleVector objs){
- *
- * for(int t = 0;t 701) { // has 3rd digit
- int z = (i / 676) - 1; // -1 to account for 0-based
- if ((i % 676) < 26) { // then "leftover" is actually 2nd digit
- z--;
- leftover = 676;
- }
- ret = String.valueOf(ExcelTools.alpharr[z]);
- i = i % 676;
- i += leftover;
- }
- if (i > 25) { // has 2nd digit
- int z = (i / 26) - 1; // -1 to account for 0-based
- ret = ret + ExcelTools.alpharr[z];
- i = i % 26;
- }
-
- // bbennett: this raises AIOOB if i = -1. In this situation we don't
- // care about alpha because it will just be in the message of the
- // exception that flags cell as non existent.
- ret += i < 0 ? Integer.toString(i) : String.valueOf(ExcelTools.alpharr[(i)]);
-
- return ret;
- }
-
- /**
- * get the int value of the Excel-style Column alpha representation.
- *
- * @param String
- * column name
- * @return int the 0-based column number
- */
- public static int getIntVal(String c) {
- c = c.toUpperCase();
- if (c.length() > 3) // max col value= XFD in Excel 2007
- return -1;
- int i = c.length() - 1;
- int ret = 0;
- while (i >= 0) { // process least to most-sigificant dig
- int z = 0;
- char cc = c.charAt(i);
- while (z < alpharr.length && cc != alpharr[z++])
- ;
- z *= Math.pow(26, c.length() - i - 1); // 1-based col for computing
- ret += z;
- i--;
- }
- // make 0-based
- ret--;
- return ret;
- }
-
- /**
- * Parses an Excel cell address into row and column integers.
- *
- * @param address
- * the address to parse, either A1 or R1C1
- * @return int[2]: [0] row index, [1] column index
- * @throws IllegalArgumentException
- * if the argument is not a valid address
- */
- public static int[] getRowColFromString(String address) {
-
- if (address.indexOf("$") > -1) {
- address = StringTool.strip(address, "$");
- }
- if (address.indexOf("!") > -1) {
- address = address.substring(address.indexOf("!") + 1);
- }
- if (address.indexOf(":") > -1)
- return getRangeRowCol(address);
-
- char[] adrchars = address.toCharArray();
- int row = 0, col = 0;
- int charpos = -1, numpos = -1;
- boolean r1c1 = false;
- for (int i = 0; i < adrchars.length; i++) {
- if (Character.isDigit(adrchars[i])) {
- if (numpos == -1) // its a number
- numpos = i;
- } else if (charpos == -1) {
- charpos = i;
- if (numpos >= 0) { // we have already set number and we now have
- // a nondigit - R1C1 style
- r1c1 = true;
- // break, it's all over!
- break;
- }
- }
- }
-
- if (r1c1) { // it's a single cell ref
- try {
- // there's an R and a C, not adjacent
- if (address.toUpperCase().indexOf("R") == 0) { // startwith R
- String rx = address.substring(1, address.toUpperCase()
- .indexOf("C"));
- String cx = address.substring(address.toUpperCase()
- .indexOf("C") + 1);
- row = Integer.parseInt(rx);
- col = Integer.parseInt(cx);
- }
- } catch (NumberFormatException e) {
- throw new IllegalArgumentException("illegal R1C1 address '"
- + address + "'");
- }
- } else {
- row = 0; // -1 below
- col = -1;
- if (charpos == 0 && numpos > 0) {
- String colval = address.substring(0, numpos);
- col = getIntVal(colval);
- if (col < 0)
- throw new IllegalArgumentException("illegal column value '"
- + colval + "' in address '" + address + "'");
- }
- if (numpos >= 0) {
- row = Integer.parseInt(address.substring(numpos));
- if (row < 1)
- throw new IllegalArgumentException(
- "row may not be negative in address '" + address
- + "'");
- } else { // it's a wholecol ref
- col = getIntVal(address);
- if (col < 0)
- throw new IllegalArgumentException("illegal column value '"
- + address + "' in address '" + address + "'");
- }
- }
-
- int[] ret = { row - 1, col };
- return ret;
- }
-
- /**
- * Parses an Excel cell range and returns the addresses as an int array. The
- * range may not be qualified with sheet names. Strip them with
- * {@link #stripSheetNameFromRange} before calling this method. If the
- * argument is a single cell address it will be returned for both bounds.
- *
- * @param range
- * the range to parse
- * @return int[4]: [0] first row, [1] first column, [2] second row, [3]
- * second column
- * @throws IllegalArgumentException
- * if the addresses are invalid
- */
- public static int[] getRangeRowCol(String range) {
- int colon = range.indexOf(":");
-
- String firstloc;
- String lastloc;
-
- if (colon > -1) {
- firstloc = range.substring(0, colon);
- lastloc = range.substring(colon + 1);
- } else {
- firstloc = range;
- lastloc = range;
- }
-
- int[] result = new int[4];
- int[] temp;
-
- temp = getRowColFromString(firstloc);
- System.arraycopy(temp, 0, result, 0, 2);
-
- temp = getRowColFromString(lastloc);
- System.arraycopy(temp, 0, result, 2, 2);
-
- return result;
- }
-
- /**
- * Takes an int array representing a row and column and formats it as a cell
- * address.
- *
- * The index is zero-based.
- *
- * [0][0] is "A1" [1][1] is "B2" [2][2] is "C3"
- *
- * @param int[] the numeric range to convert
- * @return String the string representation of the range
- */
- public static String formatLocation(int[] rowCol) {
- StringBuffer sb = new StringBuffer(getAlphaVal(rowCol[1]));
- sb.append(String.valueOf(rowCol[0] + 1));
-
- // handle ranges
- if (rowCol.length > 3) {
- // 20090807: KSC: only a range if 1st is != 2nd cell :)
- if (rowCol[0] == rowCol[2] && rowCol[1] == rowCol[3]) // it's a single address
- return sb.toString();
- sb.append(":");
- sb.append(getAlphaVal(rowCol[3]));
- sb.append(String.valueOf(rowCol[2] + 1));
- }
-
- return sb.toString();
- }
-
- /**
- * Takes an int array representing a row and column and formats it as a cell
- * address, taking into account relative or absolute refs
- *
- * The index is zero-based.
- *
- * [0][0] is "A1", $A1, A$1 or $A$1 depending upon bRelRow or bRelCol [1][1]
- * is "B2", $B1, B$1 or B$1 depending upon bRelRow or bRelCol [2][2] is
- * "C3", $C1, C$1 or $C$1 depending upon bRelRow or bRelCol
- *
- * @param int[] the numeric range to convert
- * @param bRelRow
- * if true, no "$"s are added, relative row reference
- * @param bRelCol
- * if true, no "$"s are added, relative col reference
- * @return String the string representation of the range
- */
- public static String formatLocation(int[] s, boolean bRelRow,
- boolean bRelCol) {
- StringBuffer sb = new StringBuffer((bRelCol ? "" : "$"));
- if (s[1] > -1) // account for WholeRow/WholeCol references
- sb.append(getAlphaVal(s[1]));
-
- if (s[0] > -1) // account for WholeRow/WholeCol references
- sb.append((bRelRow ? "" : "$") + String.valueOf(s[0] + 1));
- // 20090906 KSC: handle ranges
- if (s.length > 3) {
- if (s[0] == s[2] && s[1] == s[3]) // it's a single address
- return sb.toString();
- sb.append(":");
- sb.append((bRelCol ? "" : "$"));
- sb.append(getAlphaVal(s[3]));
- sb.append((bRelRow ? "" : "$") + String.valueOf(s[2] + 1));
- }
-
- return sb.toString();
- }
-
- /**
- * Takes an array of four shorts and formats it as a cell range.
- *
- * IE [0][3][1][4] would be "A2:B3"
- *
- * @param int[] the numeric range to convert
- * @return String the string representation of the range
- */
- public static String formatRange(int[] s) {
- if (s.length != 4)
- return "incorrect array size in ExcelTools.formatLocation";
- int[] temp = new int[2];
- temp[0] = s[1];
- temp[1] = s[0];
- String firstcell = formatLocation(temp);
- temp[0] = s[3];
- temp[1] = s[2];
- String lastcell = formatLocation(temp);
- return firstcell + ":" + lastcell;
- }
-
- /**
- * format a range as a string, range in format of [r][c][r1][c1]
- *
- * @param s
- * @return String representation of the integers as a range, ie A1:B4
- */
- public static String formatRangeRowCol(int[] s) {
- if (s.length != 4)
- return "incorrect array size in ExcelTools.formatLocation";
- int[] temp = new int[2];
- temp[0] = s[0];
- temp[1] = s[1];
- String firstcell = formatLocation(temp);
- temp[0] = s[2];
- temp[1] = s[3];
- String lastcell = formatLocation(temp);
- return firstcell + ":" + lastcell;
- }
-
- /**
- * format a range as a string, range in format of [r][c][r1][c1] including
- * relative address state
- *
- *
- * @param s
- * @param bRelAddresses
- * contains relative row and col state for each rcr1c1
- * @return String representation of the integers as a range, ie A1:B4
- */
- public static String formatRangeRowCol(int[] s, boolean[] bRelAddresses) {
- if (s.length != 4)
- return "incorrect array size in ExcelTools.formatLocation";
- int[] temp = new int[2];
- temp[0] = s[0];
- temp[1] = s[1];
- String firstcell = formatLocation(temp, bRelAddresses[0],
- bRelAddresses[1]);
- temp[0] = s[2];
- temp[1] = s[3];
- String lastcell = formatLocation(temp, bRelAddresses[2],
- bRelAddresses[3]);
- // unfortunately, no formatLocation can do this. This is
- // formattingRANGERowCol
- // if (firstcell.equals(lastcell)) return firstcell; // 20090309 KSC:
- return firstcell + ":" + lastcell;
- }
-
- /**
- * Transforms a string to an array of ints for evaluation purposes. For
- * example, acdc == [0][2][3][2]
- */
- public static int[] transformStringToIntVals(String trans) {
- int[] intarr = new int[trans.length()];
- for (int i = 0; i < trans.length(); i++) {
- char c = trans.charAt(i);
- for (int x = 0; x < alpharr.length; x++) {
- if (String.valueOf(c).equalsIgnoreCase(
- String.valueOf(alpharr[x]))) {
- intarr[i] = x;
- }
- }
- }
- return intarr;
- }
-
- /**
- * Formats a string representation of a numeric value as a string in the
- * specified notation:
- *
- * @param int cells = new ArrayList();
- do {
- String element = (String) cellTokenizer.nextElement();
- if (element.indexOf(":") != -1) {
- CellRange aRange = new CellRange(sheet.getSheetName() + "!"
- + strRange, sheet.wbh, true);
- cells.addAll(aRange.getCellList());
- } else {
- CellHandle aCell = null;
- try {
- aCell = sheet.getCell(element);
- } catch (Exception ce) {
- aCell = sheet.add(null, element);
- }
- if (aCell != null)
- cells.add(aCell);
- }
- } while (cellTokenizer.hasMoreElements());
- retCells = new CellHandle[cells.size()];
- retCells = (CellHandle[]) cells.toArray(retCells);
- return retCells;
- }
-
- /**
- * Strip sheet name(s) from range string can be Sheet1!AB:Sheet!BC or
- * Sheet!AB:BC or AB:BC or Sheet1:Sheet2!A1:A2
- *
- * @param address
- * or range String
- * @return 1st sheetname
- *
- * Ok, this is a strange method. It returns a string array of the
- * following format 0 - sheetname1 1 - cell address or range (what
- * if there are 2?) 2 - sheetname2 3 - external link 1 ?? some ooxml
- * record 4 - external link 2
- */
- public static String[] stripSheetNameFromRange(String address) {
- String sheetname = null, sheetname2 = null;
- int m = address.indexOf('!');
- if (m > -1) {
- if (address.substring(0, m).indexOf(":") == -1)
- sheetname = address.substring(0, m);
- else {
- int z = address.indexOf(":");
- sheetname = address.substring(0, z);
- sheetname2 = address.substring(z + 1, m);
- }
- }
- address = address.substring(m + 1);
- int n = address.indexOf('!'); // see if 2nd sheet name exists
- if (n > -1 && !address.equals("#REF!")) {
- m = address.indexOf(':');
- sheetname2 = address.substring(m + 1, n);
- m = address.indexOf(':');
- address = address.substring(0, m + 1) + address.substring(n + 1);
- }
- // 20090323 KSC: handle external references (OOXML-Specific format of
- // [#]SheetName!Ref where # denotes ExternalLink workbook
- String exLink1 = null, exLink2 = null;
- if (sheetname != null && sheetname.indexOf('[') >= 0) { // External
- // OOXML
- // reference
- exLink1 = sheetname.substring(sheetname.indexOf('['));
- exLink1 = exLink1.substring(0, exLink1.indexOf(']') + 1);
- sheetname = StringTool.replaceText(sheetname, exLink1, "");
- if (sheetname.equals(""))
- sheetname = null; // possible to have address in form of =
- // [#]!Name or range
- }
- if (sheetname2 != null && sheetname2.indexOf('[') >= 0) { // External
- // OOXML
- // reference
- exLink2 = sheetname2.substring(sheetname2.indexOf('['));
- exLink2 = exLink2.substring(0, exLink2.indexOf(']') + 1);
- sheetname2 = StringTool.replaceText(sheetname2, exLink2, "");
- if (sheetname2.equals(""))
- sheetname2 = null; // possible to have address in form of =
- // [#]!Name or range
- }
- // return new String[]{sheetname, address, sheetname2};
- return new String[] { sheetname, address, sheetname2, exLink1, exLink2 }; // 20090323
- // KSC:
- // add
- // any
- // external
- // link
- // info
- }
-
- /**
- * return the first and last coords of a range in int form + the number of
- * cells in the range range is in the format of Sheet
- *
- */
- public static int[] getRangeCoords(String range) {
- int numrows = 0;
- int numcols = 0;
- int numcells = 0;
- int[] coords = new int[5];
- String temprange = range;
- // figure out the sheet bounds using the range string
- temprange = ExcelTools.stripSheetNameFromRange(temprange)[1];
- String startcell = "", endcell = "";
- int lastcolon = temprange.lastIndexOf(":");
- endcell = temprange.substring(lastcolon + 1);
- if (lastcolon == -1) // no range
- startcell = endcell;
- else
- startcell = temprange.substring(0, lastcolon);
- startcell = StringTool.strip(startcell, "$");
- endcell = StringTool.strip(endcell, "$");
-
- // get the first cell's coordinates
- int charct = startcell.length();
- while (charct > 0) {
- if (!Character.isDigit(startcell.charAt(--charct))) {
- charct++;
- break;
- }
- }
- String firstcellrowstr = startcell.substring(charct);
- int firstcellrow = -1;
- try {
- firstcellrow = Integer.parseInt(firstcellrowstr);
- } catch (NumberFormatException e) { // could be a whole-col-style ref
- }
- String firstcellcolstr = startcell.substring(0, charct).trim();
- int firstcellcol = ExcelTools.getIntVal(firstcellcolstr);
- // get the last cell's coordinates
- charct = endcell.length();
- while (charct > 0) {
- if (!Character.isDigit(endcell.charAt(--charct))) {
- charct++;
- break;
- }
- }
- String lastcellrowstr = endcell.substring(charct);
- int lastcellrow = -1;
- try {
- lastcellrow = Integer.parseInt(lastcellrowstr);
- } catch (NumberFormatException e) { // could be a whole-col-style ref
- }
- String lastcellcolstr = endcell.substring(0, charct);
- int lastcellcol = ExcelTools.getIntVal(lastcellcolstr);
- numrows = (lastcellrow - firstcellrow) + 1;
- numcols = (lastcellcol - firstcellcol) + 1;
- /*
- * if(numrows == 0)numrows =1; if(numcols == 0)numcols =1;
- */
- numcells = numrows * numcols;
- if (numcells < 0)
- numcells *= -1; // handle swapped cells ie: "B1:A1"
-
- coords[0] = firstcellrow;
- coords[1] = firstcellcol;
- coords[2] = lastcellrow;
- coords[3] = lastcellcol;
- coords[4] = numcells;
- // Trap errors in range
- // if (firstcellrow < 0 || lastcellrow < 0 || firstcellcol < 0 ||
- // lastcellcol < 0)
- // Logger.logErr("ExcelTools.getRangeCoords: Error in Range " + range);
- return coords;
- }
-}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/ExcelTools.kt b/src/main/java/io/starter/OpenXLS/ExcelTools.kt
new file mode 100644
index 0000000..945a4f2
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/ExcelTools.kt
@@ -0,0 +1,1210 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ * ;;; */
+ val pats = pattern.split(";".toRegex()).dropLastWhile({ it.isEmpty() }).toTypedArray() // assign the correct pattern according to double or string value
+
+ val tester = StringTool.convertPatternExtractBracketedExpression(pats[0])
+ if (tester.matches(".*(((y{1,4}|m{1,5}|d{1,4}|h{1,2}|s{1,2}).*)+).*".toRegex())) {
+ isDate = true
+ pats[0] = tester // ignore locale and other info for dates ...
+ }
+ if (!isDate) {
+ var idx = pats.size - 1 // default with string
+ try {
+ val d = Double(o.toString())
+ isNumeric = true
+ if (d > 0)
+ // 1st expression is for + numbers
+ idx = 0
+ else if (pats.size > 1 && d < 0)
+ // 2nd is for - numbers
+ idx = 1
+ else if (pats.size > 2 && d == 0.0)
+ // 3rd for 0
+ idx = 2
+ pattern = StringTool.convertPatternFromExcelToStringFormatter(pats[idx], d < 0) // get correct format for String.format formatter
+ } catch (e: NumberFormatException) { // 4th for text (non-numeric)
+ if (pats.size > 3)
+ idx = 3
+ isString = true
+ pattern = StringTool.convertPatternFromExcelToStringFormatter(pats[idx], false) // get correct format for String.format formatter
+ }
+
+ } else {
+ pattern = pats[0]
+ pattern = StringTool.convertDatePatternFromExcelToStringFormatter(pattern!!) // get correct format for SimpleDateFormat
+ }
+
+
+ if (isString) { // use string portion of format, if any
+ try {
+ return String.format(pattern!!, o)
+ } catch (e: IllegalFormatConversionException) {
+ return o.toString()
+ }
+
+ }
+ if (isNumeric) {
+ try {
+ var d = Double(o.toString())
+ if (!java.lang.Double.isNaN(d)) {
+ d = Math.abs(d) // negative number intricacies have been handled in convertPattern method
+ // ugly, but has to be done ...
+ if (pattern!!.indexOf("%%") != -1)
+ // convert to percent
+ d *= 100.0
+ // special case of "@" -- integers converted to doubles format incorrectly ...
+ return if (pattern == "%s") {
+ o.toString()
+ } else String.format(pattern, d)
+ }
+ } catch (e: Exception) {
+ }
+
+ return o.toString()
+ }
+ if (isDate) {
+ try {
+ WorkBookHandle.simpledateformat.applyPattern(pattern!!)
+ } catch (ex: Exception) {
+ return o.toString()
+ }
+
+ try {
+ return WorkBookHandle.simpledateformat.format(DateConverter.getCalendarFromNumber(o).time)
+ /*// KSC: TESTING
+Date d= DateConverter.getCalendarFromNumber(o).getTime();
+return WorkBookHandle.simpledateformat.format(d);*/
+ } catch (e: NumberFormatException) {
+ try {
+ return WorkBookHandle.simpledateformat.format(Date(o.toString()).time)
+ } catch (i: IllegalArgumentException) {
+ if (o is Number)
+ Logger.logWarn("Unable to format date in $pattern")
+ }
+
+ } catch (e: IllegalArgumentException) {
+ if (o is Number)
+ Logger.logWarn("Unable to format date in $pattern")
+ }
+
+ }
+ // otherwise
+ return o.toString()
+ }
+
+
+ /**
+ * A FAIL FAST implementation for finding whether a cell string address
+ * falls within a set of row/col range coordinates.
+ *
+ *
+ * Sep 21, 2010
+ *
+ * @param rng the range you want to test
+ * @param rowFirst in the target range
+ * @param rowLast in the target range
+ * @param colFirst in the target range
+ * @param colLast in the target range
+ * @return
+ */
+ fun isInRange(rng: String, rowFirst: Int, rowLast: Int,
+ colFirst: Int, colLast: Int): Boolean {
+ val sh = io.starter.OpenXLS.ExcelTools.getRowColFromString(rng)
+
+ // the guantlet
+ if (sh[1] < colFirst)
+ return false
+ if (sh[1] > colLast)
+ return false
+ return if (sh[0] < rowFirst) false else sh[0] <= rowLast
+// passes!
+
+ }
+
+ /**
+ * returns true if range intersects with range2
+ *
+ * @param rng
+ * @param rc
+ * @return
+ */
+ fun intersects(rng: String, rc: IntArray): Boolean {
+ val rc2 = ExcelTools.getRangeCoords(rng)
+ return (rc[0] >= rc2[0] && rc[2] <= rc2[2] && rc[1] >= rc2[1]
+ && rc[3] <= rc2[3])
+ }
+
+ /**
+ * returns true if address is before the range coordinates defined by rc
+ *
+ * @param rc row col of address
+ * @param rng int[] coordinates as: row0, col0, row1, col1
+ * @return true if address is before the range coordinates
+ */
+ fun isBeforeRange(rc: IntArray, rng: IntArray): Boolean {
+ return rc[0] < rng[0] || rc[0] == rng[0] && rc[1] < rng[1]
+ }
+
+ /**
+ * returns true if address is before the range coordinates defined by rc
+ *
+ * @param rc row col of address
+ * @param rng int[] coordinates as: row0, col0, row1, col1
+ * @return true if address is before the range coordinates
+ */
+ fun isAfterRange(rc: IntArray, rng: IntArray): Boolean {
+ return rc[0] > rng[2] || rc[0] == rng[2] && rc[1] > rng[3]
+ }
+
+ /**
+ * Takes an input Object and attempts to convert to numeric Objects of the
+ * highest precision possible.
+ *
+ *
+ * This method is useful for avoiding the Excel warnings
+ * "Number Stored As Text" when storing string data that contains numbers.
+ *
+ *
+ * NOTE: this method is useful for ensuring that Formula references contain
+ * true numeric values as not all String numbers are properly interpreted in
+ * Formula engines, and can silently fail.
+ *
+ *
+ * For this reason, always use numeric, non-string values to calculated
+ * cells.
+ *
+ * @param input
+ * @return
+ */
+ fun getObject(`in`: Any): Any {
+ // do not record -- only called from other methods
+ if (`in` !is String) {
+ return `in`
+ }
+
+ val input = `in`.toString()
+ var ret: Any = input // default is the original string
+
+ try {
+ ret = Double(input)
+ return ret
+ } catch (ex: NumberFormatException) {
+ try {
+ ret = Float(input)
+ return ret
+ } catch (ex2: NumberFormatException) {
+ try {
+ ret = Integer.valueOf(input)
+ return ret
+ } catch (ex3: NumberFormatException) {
+ // ret Is set outside of loop incase no match is ever found.
+ }
+
+ }
+
+ }
+
+ // list of formatting chars to check for
+ val fmtlist = arrayOf(arrayOf("$", ","), arrayOf(",", ","), arrayOf("%", ","))
+
+ // strip the formatting
+ for (t in fmtlist.indices) {
+ if (input.indexOf(fmtlist[t][0]) > -1) { // contains!
+ var converted = StringTool.replaceText(input, fmtlist[t][0],
+ "") // strip first token (ie: '$')
+ converted = StringTool
+ .replaceText(converted, fmtlist[t][1], "") // strip
+ // second
+ // token
+ // (ie: ',')
+ try {
+ ret = Double(converted)
+ return ret
+ } catch (ex: NumberFormatException) {
+ try {
+ ret = Float(converted)
+ return ret
+ } catch (ex2: NumberFormatException) {
+ try {
+ ret = Integer.valueOf(converted)
+ return ret
+ } catch (ex3: NumberFormatException) {
+ // ret Is set outside of loop incase no match is
+ // ever found.
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ return ret
+ }
+
+ /**
+ * convert twips to pixels
+ *
+ *
+ *
+ *
+ * In addition to a calculated size unit derived from the average size of
+ * the default characters 0-9, Excel uses the 'twips' measurement which is
+ * defined as:
+ *
+ *
+ * 1 twip = 1/20 point or 20 twips = 1 point 1 twip = 1/567 centimeter or
+ * 567 twips = 1 centimeter 1 twip = 1/1440 inch or 1440 twips = 1 inch
+ *
+ *
+ *
+ *
+ * 1 pixel = 0.75 points 1 pixel * 1.3333 = 1 point 1 twip * 20 = 1 point
+ *
+ * @param pixels
+ * @return twips
+ */
+ fun getPixels(twips: Float): Float {
+ val points = twips / 20
+ return points * 1.3333333f
+ }
+
+ /**
+ * convert pixels to twips
+ *
+ *
+ *
+ *
+ * In addition to a calculated size unit derived from the average size of
+ * the default characters 0-9, Excel uses the 'twips' measurement which is
+ * defined as:
+ *
+ *
+ * 1 pixel = 0.75 points 1 pixel * 1.3333 = 1 point 1 twip * 20 = 1 point
+ *
+ * @param pixels
+ * @return twips
+ */
+ fun getTwips(pixels: Float): Float {
+ val points = pixels * .75f
+ return points * 20
+ }
+
+ /**
+ * get recordy byte def as a String
+ *
+ *
+ * public static String getRecordByteDef(XLSRecord rec){ byte[] b =
+ * rec.read(); StringBuffer sb = new StringBuffer("byte[] rbytes = {");
+ * for(int t = 0;t(0)
+ // args[0] = outNumD;
+ val res = ResourceLoader.executeIfSupported(outNumD, args,
+ "toPlainString")
+ if (res != null) {
+ fullString = res.toString()
+ } else {
+ fullString = outNumD.toCompatibleString()
+ }
+ }
+ 1 // NOTATION_SCIENTIFIC
+ -> if (num.indexOf("E") != -1 && num.indexOf("+") == -1) {
+ fullString = num
+ } else if (num.indexOf("+") != -1) {
+ preString = num.substring(0, num.indexOf("+"))
+ postString = num.substring(num.indexOf("+") + 1)
+ return preString + postString
+ } else if (num.indexOf(".") != -1) {
+ val pos = num.indexOf(".")
+ preString = (num.substring(0, 1) + "."
+ + num.substring(1, num.indexOf(".")))
+ var d = CompatibleBigDecimal(num)
+ if (d.toDouble() < 1 && d.toDouble() != 0.0) {
+ // it is a very small value, ie 1.0E-10
+ var counter = 0
+ while (d.toDouble() < 1) {
+ d = CompatibleBigDecimal(d.movePointRight(1))
+ counter++
+ }
+ return d.toCompatibleString() + "E-" + counter
+ }
+ postString = num.substring(num.indexOf(".") + 1)
+ fullString = preString + postString
+ fullString = fullString + "E" + (pos - 1)
+ } else {
+ preString = num.substring(0, 1) + "."
+ if (num.length > 1) {
+ preString += num.substring(1)
+ } else {
+ preString += "0"
+ }
+ fullString = preString + "E" + (num.length - 1)
+ }
+ 2 // NOTATION_SCIENTIFIC_EXCEL
+ -> if (num.indexOf("E") != -1 && num.indexOf("+") != -1) {
+ fullString = num
+ } else if (num.indexOf("E") != -1) {
+ preString = num.substring(0, num.indexOf("E") + 1)
+ postString = "+" + num.substring(num.indexOf("E") + 1)
+ fullString = preString + postString
+ } else if (num.indexOf(".") != -1) {
+ val pos = num.indexOf(".")
+ var d = CompatibleBigDecimal(num)
+ if (d.toDouble() < 1 && d.toDouble() != 0.0) {
+ // it is a very small value, ie 1.0E-10
+ var counter = 0
+ while (d.toDouble() < 1) {
+ d = CompatibleBigDecimal(d.movePointRight(1))
+ counter++
+ }
+ return d.toCompatibleString() + "E-" + counter
+ }
+ preString = (num.substring(0, 1) + "."
+ + num.substring(1, num.indexOf(".")))
+ postString = num.substring(num.indexOf(".") + 1)
+ fullString = preString + postString
+ fullString = fullString + "E+" + (pos - 1)
+ } else {
+ preString = num.substring(0, 1) + "."
+ if (num.length > 1) {
+ preString += num.substring(1)
+ } else {
+ preString += "0"
+ }
+ fullString = preString + "E+" + (num.length - 1)
+ }
+ else -> return num
+ }
+ if (negative)
+ fullString = "-" + fullString!!
+ return fullString
+ }
+
+ /**
+ * Return an array of cell handles specified from the string passed in.
+ *
+ *
+ * Note that a CellHandle cannot exist for an empty cell, so the cells
+ * retrieved in this manner will be blank cells, not empty cells.
+ *
+ * @param cellstr - a comma delimited String representing cells and cell ranges,
+ * example "A1,A5,A6,B1:B5" would return cells A1, A5, A6, B1,
+ * B2, B3, B4, B5
+ * @param sheet the worksheet containing the cells.
+ * @return CellHandle[]
+ */
+ fun getCellHandlesFromSheet(strRange: String,
+ sheet: WorkSheetHandle): Array {
+ var retCells: Array
+ val cellTokenizer = StringTokenizer(strRange, ",")
+ val cells = ArrayList()
+ do {
+ val element = cellTokenizer.nextElement() as String
+ if (element.indexOf(":") != -1) {
+ val aRange = CellRange(sheet.sheetName + "!"
+ + strRange, sheet.workBook, true)
+ cells.addAll(aRange.cellList)
+ } else {
+ var aCell: CellHandle? = null
+ try {
+ aCell = sheet.getCell(element)
+ } catch (ce: Exception) {
+ aCell = sheet.add(null, element)
+ }
+
+ if (aCell != null)
+ cells.add(aCell)
+ }
+ } while (cellTokenizer.hasMoreElements())
+ retCells = arrayOfNulls(cells.size)
+ retCells = cells.toTypedArray()
+ return retCells
+ }
+
+ /**
+ * Strip sheet name(s) from range string can be Sheet1!AB:Sheet!BC or
+ * Sheet!AB:BC or AB:BC or Sheet1:Sheet2!A1:A2
+ *
+ * @param address or range String
+ * @return 1st sheetname
+ *
+ *
+ * Ok, this is a strange method. It returns a string array of the
+ * following format 0 - sheetname1 1 - cell address or range (what
+ * if there are 2?) 2 - sheetname2 3 - external link 1 ?? some ooxml
+ * record 4 - external link 2
+ */
+ fun stripSheetNameFromRange(address: String): Array {
+ var address = address
+ var sheetname: String? = null
+ var sheetname2: String? = null
+ var m = address.indexOf('!')
+ if (m > -1) {
+ if (address.substring(0, m).indexOf(":") == -1)
+ sheetname = address.substring(0, m)
+ else {
+ val z = address.indexOf(":")
+ sheetname = address.substring(0, z)
+ sheetname2 = address.substring(z + 1, m)
+ }
+ }
+ address = address.substring(m + 1)
+ val n = address.indexOf('!') // see if 2nd sheet name exists
+ if (n > -1 && address != "#REF!") {
+ m = address.indexOf(':')
+ sheetname2 = address.substring(m + 1, n)
+ m = address.indexOf(':')
+ address = address.substring(0, m + 1) + address.substring(n + 1)
+ }
+ // 20090323 KSC: handle external references (OOXML-Specific format of
+ // [#]SheetName!Ref where # denotes ExternalLink workbook
+ var exLink1: String? = null
+ var exLink2: String? = null
+ if (sheetname != null && sheetname.indexOf('[') >= 0) { // External
+ // OOXML
+ // reference
+ exLink1 = sheetname.substring(sheetname.indexOf('['))
+ exLink1 = exLink1!!.substring(0, exLink1.indexOf(']') + 1)
+ sheetname = StringTool.replaceText(sheetname, exLink1, "")
+ if (sheetname == "")
+ sheetname = null // possible to have address in form of =
+ // [#]!Name or range
+ }
+ if (sheetname2 != null && sheetname2.indexOf('[') >= 0) { // External
+ // OOXML
+ // reference
+ exLink2 = sheetname2.substring(sheetname2.indexOf('['))
+ exLink2 = exLink2!!.substring(0, exLink2.indexOf(']') + 1)
+ sheetname2 = StringTool.replaceText(sheetname2, exLink2, "")
+ if (sheetname2 == "")
+ sheetname2 = null // possible to have address in form of =
+ // [#]!Name or range
+ }
+ // return new String[]{sheetname, address, sheetname2};
+ return arrayOf(sheetname, address, sheetname2, exLink1, exLink2) // 20090323
+ // KSC:
+ // add
+ // any
+ // external
+ // link
+ // info
+ }
+
+ /**
+ * return the first and last coords of a range in int form + the number of
+ * cells in the range range is in the format of Sheet
+ */
+ fun getRangeCoords(range: String): IntArray {
+ var numrows = 0
+ var numcols = 0
+ var numcells = 0
+ val coords = IntArray(5)
+ var temprange = range
+ // figure out the sheet bounds using the range string
+ temprange = ExcelTools.stripSheetNameFromRange(temprange)[1]
+ var startcell = ""
+ var endcell = ""
+ val lastcolon = temprange.lastIndexOf(":")
+ endcell = temprange.substring(lastcolon + 1)
+ if (lastcolon == -1)
+ // no range
+ startcell = endcell
+ else
+ startcell = temprange.substring(0, lastcolon)
+ startcell = StringTool.strip(startcell, "$")
+ endcell = StringTool.strip(endcell, "$")
+
+ // get the first cell's coordinates
+ var charct = startcell.length
+ while (charct > 0) {
+ if (!Character.isDigit(startcell[--charct])) {
+ charct++
+ break
+ }
+ }
+ val firstcellrowstr = startcell.substring(charct)
+ var firstcellrow = -1
+ try {
+ firstcellrow = Integer.parseInt(firstcellrowstr)
+ } catch (e: NumberFormatException) { // could be a whole-col-style ref
+ }
+
+ val firstcellcolstr = startcell.substring(0, charct).trim({ it <= ' ' })
+ val firstcellcol = ExcelTools.getIntVal(firstcellcolstr)
+ // get the last cell's coordinates
+ charct = endcell.length
+ while (charct > 0) {
+ if (!Character.isDigit(endcell[--charct])) {
+ charct++
+ break
+ }
+ }
+ val lastcellrowstr = endcell.substring(charct)
+ var lastcellrow = -1
+ try {
+ lastcellrow = Integer.parseInt(lastcellrowstr)
+ } catch (e: NumberFormatException) { // could be a whole-col-style ref
+ }
+
+ val lastcellcolstr = endcell.substring(0, charct)
+ val lastcellcol = ExcelTools.getIntVal(lastcellcolstr)
+ numrows = lastcellrow - firstcellrow + 1
+ numcols = lastcellcol - firstcellcol + 1
+ /*
+ * if(numrows == 0)numrows =1; if(numcols == 0)numcols =1;
+ */
+ numcells = numrows * numcols
+ if (numcells < 0)
+ numcells *= -1 // handle swapped cells ie: "B1:A1"
+
+ coords[0] = firstcellrow
+ coords[1] = firstcellcol
+ coords[2] = lastcellrow
+ coords[3] = lastcellcol
+ coords[4] = numcells
+ // Trap errors in range
+ // if (firstcellrow < 0 || lastcellrow < 0 || firstcellcol < 0 ||
+ // lastcellcol < 0)
+ // Logger.logErr("ExcelTools.getRangeCoords: Error in Range " + range);
+ return coords
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/FormatCache.java b/src/main/java/io/starter/OpenXLS/FormatCache.java
deleted file mode 100644
index c85d711..0000000
--- a/src/main/java/io/starter/OpenXLS/FormatCache.java
+++ /dev/null
@@ -1,91 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- *
- * The mutator methods of a FormatHandle object directly and immediately change
- * the formatting of the cell(s) to which it is applied. Under no circumstances
- * will a FormatHandle alter the formatting of cells to which it is not applied.
- * The list of cells to which a FormatHandle applies may be queried with the
- * {@link #getCells} method. Additional cells may be added with {@link #addCell}
- * and related methods.
- *
- * A FormatHandle may also be obtained for a row or a column. In such a case the
- * FormatHandle sets the default formats for the row or column. The default
- * format for a row or column is the format which appears when no other formats
- * for the cell are specified, such as for newly created cells.
- *
- */
-public class FormatHandle implements Handle, FormatConstants {
-
- private CompatibleVector mycells = new CompatibleVector(); // all the Cells sharing this format e.g. CellRange
- private Xf myxf;
- private int xfe;
-// see Xf.usedCount instead private boolean canModify = false;
- private ColHandle mycol = null;
- private RowHandle myrow = null;
- private boolean writeImmediate = false;
- boolean underlined = false;
-
- private io.starter.formats.XLS.WorkBook wkbook;
- private io.starter.OpenXLS.WorkBook wbh;
-
- public static final Map numericFormatMap;
- public static final Map currencyFormatMap;
- public static final Map dateFormatMap;
-
- static {
- Map formats = new HashMap();
- for (String[] formatArr : FormatConstants.NUMERIC_FORMATS) {
- if (formatArr.length == 3) {
- formats.put(formatArr[0].toLowerCase(), formatArr[2]);
- }
- }
- numericFormatMap = Collections.unmodifiableMap(formats);
-
- formats = new HashMap();
- for (String[] formatArr : FormatConstants.CURRENCY_FORMATS) {
- if (formatArr.length == 3) {
- formats.put(formatArr[0].toLowerCase(), formatArr[2]);
- }
- }
- currencyFormatMap = Collections.unmodifiableMap(formats);
-
- formats = new HashMap();
- for (String[] formatArr : FormatConstants.DATE_FORMATS) {
- if (formatArr.length == 3) {
- formats.put(formatArr[0].toLowerCase(), formatArr[2]);
- } else {
- // only 2 elements in date format string array: pattern and hex id
- formats.put(formatArr[0].toLowerCase(), formatArr[0]);
- }
- }
- dateFormatMap = Collections.unmodifiableMap(formats);
- }
-
- /**
- * Nullary constructor for use in bean context. This is not part of the
- * public API and should not be called.
- */
- public FormatHandle() {
- }
-
- /**
- * Constructs a FormatHandle for the given WorkBook and format record.
- * This is not part of the public API and should not be called.
- */
- public FormatHandle(io.starter.OpenXLS.WorkBook book, Xf xfr) {
- myxf = xfr;
- xfe = myxf.getIdx();
- wbh = book;
- if (book != null) {
- wkbook = book.getWorkBook();
- } else {
- if (xfr.getWorkBook() != null) {
- wkbook = xfr.getWorkBook();
- } else {
- Logger.logErr("FormatHandle constructed with null WorkBook.");
- }
- }
- }
-
- /**
- * Constructs a FormatHandle for the given WorkBook's default format.
- */
- public FormatHandle(io.starter.OpenXLS.WorkBook book) {
- this(book, book.getWorkBook().getDefaultIxfe());
- }
-
- /** Constructs a FormatHandle for the given format ID and WorkBook.
- * This is useful for creating a FormatHandle with the same parameters as
- * a cell that does not refer to the cell. For example:
- *
- * CellHandle cell = <get cell here>;
- * FormatHandle format = new FormatHandle(
- * cell.getWorkBook(), cell.getFormatId() );
- *
- *
- * @param book the WorkBook from which the format should be retrieved
- * @param xfnum the ID of the format
- */
- public FormatHandle(io.starter.formats.XLS.WorkBook book, int xfnum) {
- wkbook = book;
- if (xfnum > -1 && xfnum < wkbook.getNumXfs()) {
- myxf = wkbook.getXf(xfnum);
- xfe = myxf.getIdx();
- }
- if (myxf == null) { // add new xf if necessary
- myxf = duplicateXf(null);
- }
- myxf.getFont(); // will set to default (0th) font if not already set
- }
-
- /** Constructs a FormatHandle for the given format ID and WorkBook.
- * This is useful for creating a FormatHandle with the same parameters as
- * a cell that does not refer to the cell. For example:
- *
- * CellHandle cell = <get cell here>;
- * FormatHandle format = new FormatHandle(
- * cell.getWorkBook(), cell.getFormatId() );
- *
- *
- * @param book
- * the WorkBook from which the format should be retrieved
- * @param xfnum
- * the ID of the format public FormatHandle(WorkBook book, int
- * xfnum ,int x) { this(book.getWorkBook(),xfnum); wbh = book; }
- */
-
- /**
- * Constructs a FormatHandle for the given format index and WorkBook.
- * This is not part of the public API and should not be called.
- */
- /*
- * This constructor is just used from XML parsing, due to some dedupe
- * errors. possibly errors in .xlsx too?
- */
- protected FormatHandle(io.starter.OpenXLS.WorkBook book, int xfnum,
- boolean dedupe) {
- this(book, xfnum);
- writeImmediate = dedupe;
- }
-
- /**
- * Constructs a dummy FormatHandle for the given conditional format. This
- * is not part of the public API and should not be called.
- *
- * This unique flavor of FormatHandle is only used to display the formatting
- * values of a Conditional format record.
- *
- * Creates a dummy Xf to store values, otherwise has no effect on the
- * WorkBook record stream which are manipulated through CellHandle.
- *
- * @param book
- * containing the conditional formats
- * @param the
- * index to the conditional format in the book collection
- */
- protected FormatHandle(Condfmt cx, io.starter.OpenXLS.WorkBook book,
- int xfnum, CellHandle c) {
- cx.setFormatHandle(this);
- xfe = xfnum;
- wbh = book;
- wkbook = book.getWorkBook();
- if (c == null) {
- // ok, this is a horrible hack, as its only correct if the top left
- // cell of the range has the same background format
- // as the cell a user is hitting. Lame, but i've been handed this at
- // the last moment and am patching things. weak effort guys.
- try {
- int[] rc = cx.getEncompassingRange();
- c = new CellHandle(cx.getSheet().getCell(rc[0], rc[1]),
- (WorkBookHandle) book);
- } catch (Exception e) {
- }
- ;
- }
- myxf = duplicateXf(book.getWorkBook().getXf(c.getFormatId()));
-
- // set the format from the cf
- List lx = cx.getRules();
- Iterator itx = lx.iterator();
- while (itx.hasNext()) {
- Cf format = (Cf) itx.next();
- this.updateFromCF(format, book);
- }
- }
-
- /**
- * updates this format handle via a Cf rule
- *
- * @param cf
- * Cf rule
- * @param book
- * workbook
- */
- protected void updateFromCF(Cf cf, io.starter.OpenXLS.WorkBook book) {
- // border colors
- Color[] clr = cf.getBorderColors();
- if (clr != null)
- setBorderColors(clr);
-
- // line style
- int[] xs = cf.getBorderStyles();
- if (xs != null)
- this.setBorderLineStyle(xs);
-
- /*
- * // cf.getBorderSizes() int[] b = cf.getBorderSizes(); if(b!=null)
- * setBorderLineStyle(b);
- */
- // cf.getFont()
- Font f = cf.getFont();
- if (f != null)
- setFont(f);
- else
- this.setFontHeight(180); // why????????
-
- if (cf.getFontItalic())
- this.setItalic(true);
-
- if (cf.getFontStriken())
- this.setStricken(true);
-
- int fsup = cf.getFontEscapement();
- // super/sub (0 = none, 1 = super, 2 = sub)
- if (fsup > -1)
- this.setScript(fsup);
-
- // handle underlines
- int us = cf.getFontUnderlineStyle();
-
- if (us > -1) {
- this.setUnderlineStyle(us);
- this.setUnderlined(true);
- }
-
- // number cf
- if (cf.getFormatPattern() != null)
- setFormatPattern(cf.getFormatPattern());
-
- if (cf.getFill() != null) {
- this.setFill(cf.getFill());
- } else {
- int fill = cf.getPatternFillStyle(); // Now -1 is a valid entry:
- if (fill > -1) {
- /* If the fill style is solid: When solid is specified, the
- foreground color (fgColor) is the only color rendered,
- even when a background color (bgColor) is also
- specified. */
- int bg = cf.getPatternFillColorBack();
- int fg = cf.getPatternFillColor();
- this.setFill(fill, fg, bg);
- } else {
- int fg = cf.getForegroundColor();
- if (fg > -1)
- setForegroundColor(fg);
- }
- }
- }
-
- /**
- * Creates a FormatHandle for the given cell. This is not part of the
- * public API and should not be called. Customers should use
- * {@link CellHandle#getFormatHandle()} instead.
- */
- public FormatHandle(CellHandle c) {
- wkbook = c.getCell().getWorkBook();
- if (c.getCell().getXfRec() != null) {
- myxf = c.getCell().getXfRec();
- xfe = myxf.getIdx(); // update the pointer - 20071010 KSC
- } else { // ?? create new
- // 20090512 KSC: Shigeo NPE error formaterror646694, create new
- // rather than outputting warning
- // Logger.logWarn("No XF for cell " + c.toString());
- myxf = wkbook.getXf(c.getCell().getIxfe());
- xfe = myxf.getIdx();
- }
- // 20101201 KSC: only add to cache when adding xf's addToCache();
- }
-
- /**
- * overrides the equals method to perform equality based on format
- * properties ------------------------------------------------------------
- *
- * @param Object
- * another - the FormatHandle to compare with this FormatHandle
- * @return true if this FormatHandle equals another
- */
- public boolean equals(Object another) {
- return another.toString().equals(toString());
- }
-
- /**
- * Locks the cell attached to this FormatHandle for editing (makes
- * read-only) lock cell and make read-only
- *
- *
- * @param boolean locked - true if cells should be locked for this
- * FormatHandle
- */
- public void setLocked(boolean locked) {
- Xf xf = cloneXf(myxf);
- xf.setLocked(locked);
- updateXf(xf);
- }
-
- /**
- * sets the cell attached to this FormatHandle to hide or show formula
- * strings;
- *
- * @param boolean b- true if formulas should be hidden for this FormatHandle
- */
- public void setFormulaHidden(boolean b) {
- Xf xf = cloneXf(myxf);
- xf.setFormulaHidden(b);
- updateXf(xf);
- }
-
- /**
- * returns whether this FormatHandle is set to hide formula strings
- *
- * @return true if the formula strings are hidden, false otherwise
- */
- public boolean isFormulaHidden() {
- return myxf.isFormulaHidden();
- }
-
- /**
- * returns whether this Format Handle specifies that cells are locked for
- * changing
- *
- * @return true if cells are locked
- */
- public boolean isLocked() {
- return myxf.isLocked();
- }
-
- /**
- * provides a mapping between Excel formats and Java formats http://java.sun.com/docs/books/tutorial/i18n/format
- * /decimalFormat.html
- *
- * Note there are slight Excel-specific differences in the format strings
- * returned. Several numeric and currency formats in excel have different
- * formatting for postive and negative numbers. In these cases, the java
- * format string is split by semicolons and may contain text [Red] which is
- * to specify the negative number should be displayed in red. Remove this
- * from the string before passing into the Format class;
- *
- *
- * G Era designator Text AD
- * y Year Year 1996; 96
- * M Month in year Month July; Jul; 07
- * w Week in year Number 27
- * W Week in month Number 2
- * D Day in year Number 189
- * d Day in month Number 10
- * F Day of week in month Number 2
- * E Day in week Text Tuesday; Tue
- * a Am/pm marker Text PM
- * H Hour in day (0-23) Number 0
- * k Hour in day (1-24) Number 24
- * K Hour in am/pm (0-11) Number 0
- * h Hour in am/pm (1-12) Number 12
- * m Minute in hour Number 30
- * s Second in minute Number 55
- * S Millisecond Number 978
- * z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
- * Z Time zone RFC 822 time zone -0800
- *
- *
- * @return String the formatting pattern for the cell
- */
- public String getJavaFormatString() {
- String pat = getFormatPattern();
- if (pat==null)return null;
-
- // toLowerCase is a simplistic way to implement the case insensitivity
- // of the pattern tokens. It could cause issues with string literals.
- Object patty = convertFormatString(pat.toLowerCase());
- if (patty != null)
- patty = StringTool.qualifyPatternString(patty.toString());
- if (myxf.isDatePattern()) {
- if (patty != null)
- return (String) patty;
- else
- return "M/d/yy h:mm";
- }
- if (patty != null)
- return (String) patty;
- /*
- * If we reached here, we don't have a mapping for this particular
- * format. Send a warning to the system then make sure the pattern we
- * are sending back is valid. Many excel patterns have 4 patterns
- * separated by semicolons. We only can pass 2 into the formatter
- * (positive and negative). This usually works out to be the first two
- * patterns in the string.
- */
- pat = StringTool.qualifyPatternString(pat.toString());
- int firstParens = pat.indexOf(";");
- if (firstParens != -1) {
- int secondParens = pat.indexOf(";", firstParens + 1);
- if (secondParens != -1) {
- pat = pat.substring(0, secondParens);
- } else { // yet another hackaround -jm
- pat = pat.substring(firstParens + 2, pat.length() - 1);
- }
- }
- return pat;
- }
-
- /**
- * converts an Excel-style format string to a Java Format string.
- *
- * @param String
- * pattern - Excel Format String
- * @return String that can be used with the Java Format classes.
- * @see getJavaFormatString
- */
- public static String convertFormatString(String pattern) {
- String ret = (String) numericFormatMap.get(pattern);
- if (ret != null)
- return ret;
- ret = (String) currencyFormatMap.get(pattern);
- if (ret != null)
- return ret;
- ret = (String) dateFormatMap.get(pattern);
- if (ret != null)
- return ret;
- return null;
- }
-
- /*
- * FIXME: Border Issues (marker)
- *
- * The methods to set individual border line styles do not follow a
- * consistent naming convention with the rest of the border methods.
- *
- * There are no methods for getting or setting the inside borders. I don't
- * know whether this is a problem or a design choice. It depends on whether
- * the inside borders are stored in the format record or as separate cell
- * formats.
- *
- * There are no methods to get the diagonal borders. There is a method to
- * set the diagonal border line style, but it affects both diagonals.
- */
-
- /**
- * sets the border color for all borders (top, left, bottom and right) from
- * a Color array
- *
- * NOTE: this setting will affect every cell which refers to this
- * FormatHandle
- *
- * @param java
- * .awt.Color array - 4-element array of desired border colors
- * [T, L, B, R]
- */
- public void setBorderColors(Color[] bordercolors) {
- Xf xf = cloneXf(myxf);
- if (bordercolors[0] != null)
- xf.setTopBorderColor(getColorInt(bordercolors[0]));
- if (bordercolors[1] != null)
- xf.setLeftBorderColor(getColorInt(bordercolors[1]));
- if (bordercolors[2] != null)
- xf.setBottomBorderColor(getColorInt(bordercolors[2]));
- if (bordercolors[3] != null)
- xf.setRightBorderColor(getColorInt(bordercolors[3]));
- updateXf(xf);
- }
-
- /**
- * remove borders for this format
- *
- */
- public void removeBorders() {
- Xf xf = cloneXf(myxf);
- xf.removeBorders();
- updateXf(xf);
- }
-
- /**
- * sets the border color for all borders (top, left, bottom and right) from
- * an int array containing color constants
- *
- *
- * NOTE: this setting will affect every cell which refers to this
- * FormatHandle
- *
- * @param int[] bordercolors - 4-element array of desired border color
- * constants [T, L, B, R]
- * @see FormatHandle.COLOR_* constants
- */
- public void setBorderColors(int[] bordercolors) {
- Xf xf = cloneXf(myxf);
- xf.setTopBorderColor(bordercolors[0]);
- xf.setLeftBorderColor(bordercolors[1]);
- xf.setBottomBorderColor(bordercolors[2]);
- xf.setRightBorderColor(bordercolors[3]);
- updateXf(xf);
-
- }
-
- /**
- * set the border color for all borders (top, left, bottom, and right) to
- * one color via color constant
- *
- *
- * NOTE: this setting will affect every cell which refers to this
- * FormatHandle
- *
- * @param int x - color constant which represents the color to set all
- * border sides
- * @see FormatHandle.COLOR_* constants
- */
- public void setBorderColor(int x) {
- Xf xf = cloneXf(myxf);
- xf.setRightBorderColor((short) x);
- xf.setLeftBorderColor((short) x);
- xf.setTopBorderColor((short) x);
- xf.setBottomBorderColor((short) x);
- updateXf(xf);
-
- }
-
- /**
- * set the border color for all borders (top, left, bottom, and right) to
- * one java.awt.Color
- *
- * NOTE: this setting will affect every cell which refers to this
- * FormatHandle
- *
- * @param Color
- * col - color to set all border sides
- */
- public void setBorderColor(Color col) {
- Xf xf = cloneXf(myxf);
- short x = (short) getColorInt(col);
- xf.setRightBorderColor(x);
- xf.setLeftBorderColor(x);
- xf.setTopBorderColor(x);
- xf.setBottomBorderColor(x);
- updateXf(xf);
-
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderRightColor(int x) {
- Xf xf = cloneXf(myxf);
- xf.setRightBorderColor((short) x);
- updateXf(xf);
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderRightColor(Color x) {
- Xf xf = cloneXf(myxf);
- xf.setRightBorderColor((short) getColorInt(x));
- updateXf(xf);
- }
-
- /**
- * Get the Right border color
- *
- * @return color constant
- */
- public Color getBorderRightColor() {
- if (myxf.getRightBorderLineStyle() == 0)
- return null;
- int x = myxf.getRightBorderColor();
- if (x < this.getWorkBook().colorTable.length)
- return this.getWorkBook().getColorTable()[x];
- else
- return this.getWorkBook().getColorTable()[0]; // black i'm afraid
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderLeftColor(int x) {
- Xf xf = cloneXf(myxf);
- xf.setLeftBorderColor((short) x);
- updateXf(xf);
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderLeftColor(Color x) {
- Xf xf = cloneXf(myxf);
- xf.setLeftBorderColor((short) getColorInt(x));
- updateXf(xf);
- }
-
- /**
- * returns Border Colors of Cell ie: top, left, bottom, right
- *
- * returns null or 1 color for each of 4 sides
- *
- * 1,1,1,1 represents a border all around the cell 1,1,0,0 represents on the
- * top left edge of the cell
- *
- * @return int array representing Cell borders
- */
- public Color[] getBorderColors() {
- Color[] colors = new Color[4];
- colors[0] = getBorderTopColor();
- colors[1] = getBorderLeftColor();
- colors[2] = getBorderBottomColor();
- colors[3] = getBorderRightColor();
- return colors;
- }
-
- /**
- * Get the Left border color
- *
- * @return color constant
- */
- public Color getBorderLeftColor() {
- if (myxf.getLeftBorderLineStyle() == 0)
- return null;
- return this.getWorkBook().getColorTable()[myxf.getLeftBorderColor()];
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderTopColor(int x) {
- Xf xf = cloneXf(myxf);
- xf.setTopBorderColor(x);
- updateXf(xf);
- }
-
- /**
- * Get the Top border color
- *
- * @return color constant
- */
- public Color getBorderTopColor() {
- if (myxf.getTopBorderLineStyle() == 0)
- return null;
- int xt = myxf.getTopBorderColor();
- if (xt > this.getWorkBook().getColorTable().length) // guards
- xt = 0;
- return this.getWorkBook().getColorTable()[xt];
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderTopColor(Color x) {
- Xf xf = cloneXf(myxf);
- xf.setTopBorderColor(getColorInt(x));
- updateXf(xf);
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderBottomColor(int x) {
- Xf xf = cloneXf(myxf);
- xf.setBottomBorderColor(x);
- updateXf(xf);
- }
-
- /**
- * Set the top border color
- *
- * @param color
- * constant
- */
- public void setBorderBottomColor(Color x) {
- Xf xf = cloneXf(myxf);
- xf.setBottomBorderColor(getColorInt(x));
- updateXf(xf);
- }
-
- /**
- * Returns true if the value should be red due to a combination of a format
- * pattern and a negative number
- *
- * @return
- */
- public boolean isRedWhenNegative() {
- String pattern = myxf.getFormatPattern();
- if (pattern.indexOf("Red") > -1)
- return true;
- return false;
- }
-
- /**
- * Get the Right border color
- *
- * @return color constant
- */
- public Color getBorderBottomColor() {
- if (myxf.getBottomBorderLineStyle() == 0)
- return null;
- int x = myxf.getBottomBorderColor();
- if (x < this.getWorkBook().getColorTable().length)
- return this.getWorkBook().getColorTable()[x];
- else
- return this.getWorkBook().getColorTable()[0]; // black i'm afraid
-
- }
-
- /**
- * Set the border line style
- *
- * @param line
- * style constant
- */
- public void setTopBorderLineStyle(int x) {
- Xf xf = cloneXf(myxf);
- xf.setTopBorderLineStyle((short) x);
- updateXf(xf);
- }
-
- /**
- * Get the border line style
- *
- * @return line style constant
- */
- public int getTopBorderLineStyle() {
- return myxf.getTopBorderLineStyle();
- }
-
- /**
- * Set the border line style
- *
- * @param line
- * style constant
- */
- public void setBottomBorderLineStyle(int x) {
- Xf xf = cloneXf(myxf);
- xf.setBottomBorderLineStyle((short) x);
- updateXf(xf);
- }
-
- /**
- * Get the border line style
- *
- * @return line style constant
- */
- public int getBottomBorderLineStyle() {
- return myxf.getBottomBorderLineStyle();
- }
-
- /**
- * Set the border line style
- *
- * @param line
- * style constant
- */
- public void setLeftBorderLineStyle(int x) {
- Xf xf = cloneXf(myxf);
- xf.setLeftBorderLineStyle((short) x);
- updateXf(xf);
- }
-
- /**
- * Get the border line style
- *
- * @return line style constant
- */
- public int getLeftBorderLineStyle() {
- return myxf.getLeftBorderLineStyle();
- }
-
- /**
- * Set the border line style
- *
- * @param line
- * style constant
- */
- public void setRightBorderLineStyle(int x) {
- Xf xf = cloneXf(myxf);
- xf.setRightBorderLineStyle((short) x);
- updateXf(xf);
- }
-
- /**
- * Get the border line style
- *
- * @return line style constant
- */
- public int getRightBorderLineStyle() {
- return myxf.getRightBorderLineStyle();
- }
-
- /**
- * Sets the border line style using static BORDER_ shorts within
- * FormatHandle
- *
- * @param line
- * style constant
- */
- public void setBorderLineStyle(int x) {
- Xf xf = cloneXf(myxf);
- xf.setBorderLineStyle((short) x);
- updateXf(xf);
- }
-
- /**
- * set border line styles via array of ints representing border styles
- * order= left, right, top, bottom, [diagonal]
- *
- *
- *
- * @param b
- * int[]
- */
- public void setBorderLineStyle(int[] b) {
- myxf.setAllBorderLineStyles(b);
- }
-
- /**
- * Set the border line style
- *
- * @param line
- * style constant
- */
- public void setBorderLineStyle(short x) {
- Xf xf = cloneXf(myxf);
- xf.setBorderLineStyle(x);
- updateXf(xf);
- }
-
- /**
- * return the 5 border lines styles (l, r, t, b, diag)
- *
- * @return
- */
- public int[] getAllBorderLineStyles() {
- int[] ret = new int[5];
- ret[0] = myxf.getLeftBorderLineStyle();
- ret[1] = myxf.getRightBorderLineStyle();
- ret[2] = myxf.getTopBorderLineStyle();
- ret[3] = myxf.getBottomBorderLineStyle();
- ret[4] = myxf.getDiagBorderLineStyle();
- return ret;
- }
-
- /**
- * return the 5 border line colors (l, r, t, b, diag)
- *
- * @return
- */
- public int[] getAllBorderColors() {
- int[] ret = new int[5];
- ret[0] = myxf.getLeftBorderColor();
- ret[1] = myxf.getRightBorderColor();
- ret[2] = myxf.getTopBorderColor();
- ret[3] = myxf.getBottomBorderColor();
- ret[4] = myxf.getDiagBorderColor();
- return ret;
- }
-
- /**
- * Set the border line style
- *
- * @param line
- * style constant
- */
- public void setBorderDiagonal(int x) {
- Xf xf = cloneXf(myxf);
- xf.setBorderDiag(x);
- updateXf(xf);
- }
-
- /**
- * Set a column handle on this format handle, so all changes applied to this
- * format will be applied to the entire column
- *
- * @param c
- */
- public void setColHandle(ColHandle c) {
- mycol = c;
- }
-
- /**
- * Set a row handle on this format handle, so all changes applied to this
- * format will be applied to the entire row
- *
- * @param c
- */
- public void setRowHandle(RowHandle c) {
- myrow = c;
- }
-
- /**
- * Create a copy of this FormatHandle with its own Xf
- *
- * @return the copied FormatHandle
- */
- public Object clone() {
- FormatHandle ret = null;
- if (wbh == null) { // who knew???
- wkbook = myxf.getWorkBook(); // Changed to myxf since myfont is no
- // longer
- ret = new FormatHandle();
- ret.myxf = myxf;
- ret.xfe = myxf.getIdx();
- ret.wkbook = wkbook;
- } else {
- ret = new FormatHandle(wbh, myxf); // no need to duplicate it - just
- // use all formatting of
- // original xf
- }
-
- return ret;
- }
-
- public String toString() {
- return myxf.toString();
- }
-
- public FormatHandle(io.starter.OpenXLS.WorkBook book, String fontname,
- int fontstyle, int fontsize) {
- this(book);
- setFont(fontname, fontstyle, fontsize);
- }
-
- /**
- * Jan 27, 2011
- *
- * @param workBook
- * @param i
- */
- public FormatHandle(io.starter.OpenXLS.WorkBook workBook, int i) {
- this(workBook.getWorkBook(), i);
- wbh = workBook;
- }
-
- /**
- * /** Set the weight of the font in 1/20 point units 100-1000 range. 400 is
- * normal, 700 is bold.
- *
- * @param wt
- */
- public void setFontWeight(int wt) {
- Font f = cloneFont(myxf.getFont());
- f.setFontWeight(wt);
- updateFont(f);
- }
-
- /**
- * Get the font weight the weight of the font is in 1/20 point units
- *
- * @return
- */
- public int getFontWeight() {
- return myxf.getFont().getFontWeight();
- }
-
- /**
- * Set the Font for this Format.
- *
- * As adding a new Font and format increases the file size, try using this
- * once for each distinct font used in the file, then use 'setFormatId' to
- * share this font with other Cells.
- *
- * Roughly matches the functionality of the java.awt.Font class. Currently
- * the style parameter is only useful for bold/normal weights. Italics,
- * underlines, etc must be modified elsewhere.
- *
- * Note that in order to maintain java.awt.Font compatibility for
- * bold/normal styles, defaults for weight/style have been mapped to 0 =
- * normal (excel 200 weight) and 1 = bold (excel 700 weight)
- *
- * @param String
- * font name
- * @param int font style
- * @param int font size
- */
- public void setFont(Font f) {
- setXFToFont(f);
- }
-
- /**
- * Set new font to XF, handling duplication and caching ...
- *
- * @param Font
- * f
- */
- private void setXFToFont(Font f) {
- int fti = addFontIfNecessary(f);
- if (myxf == null) { // shouldn't!!
- myxf = duplicateXf(null);
- myxf.setFont(fti);
- } else if (myxf.getIfnt() != fti) { // if not using font already,
- // duplicate xf and set to new font
- Xf xf = cloneXf(myxf);
- xf.setFont(fti);
- updateXf(xf);
- }
-
- }
-
- /**
- * Sets this format handle to a font
- * @param fn font name e.g. 'Arial'
- * @param stl font style either Font.PLAIN or Font.BOLD
- * @param sz font size or height in 1/20 point units
- *
- */
- public void setFont(String fn, int stl, double sz) {
- sz *= 20;
- if (stl == 0)
- stl = 200;
- if (stl == 1)
- stl = 700;
- Font f = new Font(fn, stl, (int) sz);
- setXFToFont(f);
- }
-
- /**
- * add font to record streamer if cant find exact font already in there
- * @param f
- * @return
- */
- private int addFontIfNecessary(Font f) {
- if (wkbook == null) {
- Logger.logErr("AddFontIfNecessary: workbook is null");
- return -1;
- }
- int fti = wkbook.getFontIdx(f);
- // don't use the built-ins.
- if (fti == 3)
- fti = 0; // use initial default font instead of last ...
- if (fti == -1) { // font doesn't exist yet, add to streamer
- f.setIdx(-1); // flag to insert
- fti = wkbook.insertFont(f) + 1;
- } else
- f.setIdx(fti);
- return fti;
- }
-
- /**
- * adds a font to the global font store only if exact font is not already
- * present
- *
- * @param f
- * Font
- * @param bk
- * WorkBookHandle
- */
- public static int addFont(Font f, WorkBookHandle bk) {
- if (bk == null) {
- Logger.logErr("addFont: workbook is null");
- }
- int fti = bk.getWorkBook().getFontIdx(f);
- // if (fti > 3) {// don't use the built-ins.
- if (fti == 3)
- fti = 0; // use initial default font instead of last ... 20070827
- // KSC
- if (fti == -1) { // font doesn't exist yet, add to streamer
- f.setIdx(-1); // flag to insert
- fti = bk.getWorkBook().insertFont(f) + 1;
- } else
- f.setIdx(fti);
- return fti;
- }
-
- /**
- * Adds a font internally to the workbook
- *
- * @param f
- *
- * private void addFont(Font f) {
- *
- * }
- */
-
- /**
- * Apply this Format to a Range of Cells
- *
- * @param CellRange
- * to apply the format to
- */
- public void addCellRange(CellRange cr) {
- CellHandle[] crcells = cr.getCells();
- for (int t = 0; t < crcells.length; t++) {
- addCell(crcells[t]);
- }
- }
-
- /**
- * Apply this Format to a Range of Cells
- *
- * @param CellHandle
- * array to apply the format to
- */
- public void addCellArray(CellHandle[] crcells) {
- for (int t = 0; t < crcells.length; t++) {
- addCell(crcells[t]);
- }
- }
-
- /**
- * add a Cell to this FormatHandle thus applying the Format to the Cell
- *
- * @param CellHandle
- * to apply the format to
- */
- public void addCell(CellHandle c) {
- c.setFormatHandle(this);
- }
-
- /**
- * Add a List of Cells to this FormatHandle
- *
- *
- * @param cx
- */
- public void addCells(List cx) {
- Iterator itx = cx.iterator();
- while (itx.hasNext()) {
- addCell((BiffRec) itx.next());
- mycells.add((BiffRec) itx.next());
- }
- }
-
- void addCell(BiffRec c) {
- if (myxf != null) {
- c.setXFRecord(myxf.getIdx());
- } else {
- Logger.logWarn("FormatHandle.addCell() - You MUST call setFont() to initialize the FormatHandle's font before adding Cells.");
- }
- mycells.add(c);
- }
-
- /**
- * Applies the format to a cell without establishing a relationship. The
- * format represented by this FormatHandle will be applied to
- * the cell but it will not be updated with any future changes. If you want
- * that behavior use {@link #addCell(CellHandle) addCell} instead.
- */
- public void stamp(CellHandle cell) {
- cell.setFormatId(xfe);
- }
-
- /** Applies the format to a cell range without establishing a relationship.
- * The format represented by this FormatHandle will be applied
- * to the cells but they will not be updated with any future changes. If you
- * want that behavior use {@link #addCell(CellHandle) addCell} instead.
- */
- public void stamp(CellRange range) {
- try {
- range.setFormatID(xfe);
- } catch (Exception e) {
- // This can't actually happen
- }
- }
-
- /**
- * set the Background Pattern for this Format
- *
- * @param int Excel color constant
- */
- public void setBackgroundPattern(int t) {
- Xf xf = cloneXf(myxf);
- // 20080103 KSC: handle solid (=filled) backgrounds, in which Excel
- // switches fg and bg colors (!!!)
- if (t != FormatConstants.PATTERN_FILLED)
- xf.setPattern(t);
- else {
- int bg = xf.getBackgroundColor();
- xf.setBackgroundSolid();
- xf.setForeColor(bg, null);
- }
- updateXf(xf);
- }
-
- /**
- * returns whether this Format is formatted as a Date
- *
- * @return boolean true if this Format is formatted as a Date
- */
- public boolean isDate() {
- if (myxf == null)
- return false;
- return myxf.isDatePattern();
- }
-
- /**
- * returns whether this Format is formatted as a Currency
- *
- * @return boolean true if this Format is formatted as a currency
- */
- public boolean isCurrency() {
- if (myxf == null)
- return false;
- return myxf.isCurrencyPattern();
- }
-
- /**
- * set the underline style for this font
- *
- * @param int u underline style one of the Font.STYLE_UNDERLINE constants
- *
- */
- public void setUnderlineStyle(int u) {
- Font f = cloneFont(myxf.getFont());
- f.setUnderlineStyle((byte) u);
- updateFont(f);
- }
-
- /**
- * super/sub (0 = none, 1 = super, 2 = sub)
- *
- * @param int script type for Format Font
- */
- public void setScript(int ss) {
- if (ss > 2)
- ss = 2; // deal with invalid numbers
- if (ss < 0)
- ss = 0; // deal with invalid numbers
- myxf.getFont().setScript(ss);
- }
-
- /**
- * set the Font Color for this Format via indexed color constant
- *
- * @param int Excel color constant
- */
- public void setFontColor(int t) {
- Font f = cloneFont(myxf.getFont());
- f.setColor(t);
- updateFont(f);
- }
-
- /**
- * set the Font Color for this Format
- *
- * @param AWT
- * Color color constant
- */
- public void setFontColor(Color colr) {
- Font f = cloneFont(myxf.getFont());
- f.setColor(colr);
- updateFont(f);
- }
-
- /**
- * sets the Font color for this Format via web Hex String
- * @param clr
- */
- public void setFontColor(String clr) {
- Font f = cloneFont(myxf.getFont());
- f.setColor(clr);
- updateFont(f);
- }
-
- /**
- * Get the Font foreground (text) color as a java.awt.Color
- *
- *
- * @return
- */
- public Color getFontColor() {
- return myxf.getFont().getColorAsColor();
- }
-
-
- public String getFontColorAsHex() {
- return myxf.getFont().getColorAsHex();
- }
-
-
- /**
- * set the Foreground Color for this Format NOTE: Foreground color = the
- * CELL BACKGROUND color color for all patterns and Background color= the
- * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
- * color=CELL BACKGROUND color and Background Color=64 (white).
- *
- * @param int Excel color constant
- */
- public void setForegroundColor(int t) {
- Xf xf = cloneXf(myxf);
- xf.setForeColor(t, null);
- updateXf(xf);
- }
-
- /**
- * set the foreground Color for this Format NOTE: Foreground color = the
- * CELL BACKGROUND color color for all patterns and Background color= the
- * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
- * color=CELL BACKGROUND color and Background Color=64 (white).
- *
- * @param AWT
- * Color constant
- */
- public void setForegroundColor(Color colr) {
- Xf xf = cloneXf(myxf);
- int clrz = getColorInt(colr);
- xf.setForeColor(clrz, colr);
- updateXf(xf);
- }
-
- /**
- * set the background color for this Format NOTE: Foreground color = the
- * CELL BACKGROUND color color for all patterns and Background color= the
- * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
- * color=CELL BACKGROUND color and Background Color=64 (white).
- *
- * @param t Excel color constant
- */
- public void setBackgroundColor(int t) {
- Xf xf = cloneXf(myxf);
- if (xf.getFillPattern() == Xf.PATTERN_SOLID)
- xf.setForeColor(t, null);
- else
- xf.setBackColor(t, null);
-
- updateXf(xf);
- }
-
- /**
- * set the Cell Background Color for this Format
- *
- * NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
- * and Background color= the PATTERN color for all patterns != Solid For
- * PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background
- * Color=64 (white).
- *
- * @param awt
- * Color color constant
- */
- public void setCellBackgroundColor(Color colr) {
- int clrz = getColorInt(colr);
- setCellBackgroundColor(clrz);
-
- }
-
- /**
- * makes the cell a solid pattern background if no pattern was already
- * present NOTE: Foreground color = the CELL BACKGROUND color color for all
- * patterns and Background color= the PATTERN color for all patterns !=
- * Solid For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and
- * Background Color=64 (white).
- *
- * @param int Excel color constant
- */
- public void setCellBackgroundColor(int t) {
- Xf xf = cloneXf(myxf);
-
- if (xf.getFillPattern() == 0)
- xf.setBackgroundSolid();
-
- if (xf.getFillPattern() == Xf.PATTERN_SOLID)
- xf.setForeColor(t, null);
- else
- xf.setBackColor(t, null);
- updateXf(xf);
- }
-
- /**
- * sets this fill pattern from an existing OOXML (2007v) fill element
- *
- * @param f
- */
- protected void setFill(Fill f) {
- Xf xf = cloneXf(myxf);
- xf.setFill(f);
- updateXf(xf);
- }
-
- /**
- * sets the fill for this format handle if fill==Xf.PATTERN_SOLID then fg is
- * the PATTERN color i.e the CELL BG COLOR
- *
- * @param fillpattern
- * @param fg
- * @param bg
- */
- public void setFill(int fillpattern, int fg, int bg) {
- Xf xf = cloneXf(myxf);
-
- xf.setPattern(fillpattern);
-
- /**
- * If the fill style is solid: When solid is specified, the foreground
- * color (fgColor) is the only color rendered, even when a background
- * color (bgColor) is also specified.
- */
- if (xf.getFillPattern() == Xf.PATTERN_SOLID) { // is reversed
- xf.setForeColor(bg, null);
- xf.setBackColor(64, null);
- } else {
- /**
- * or cell fills with patterns specified, then the cell fill color
- * is specified by the bgColor element
- */
- xf.setForeColor(fg, null);
- xf.setBackColor(bg, null);
- }
- updateXf(xf);
- }
-
- /**
- * Get the Pattern Background Color for this Format Pattern
- *
- * @return the Excel color constant
- */
- public int getBackgroundColor() {
- return myxf.getBackgroundColor();
- }
-
- /**
- * get the Pattern Background Color for this Format Pattern as a hex string
- *
- * @return Hex Color String
- *
- */
- public String getBackgroundColorAsHex() {
- return myxf.getBackgroundColorHEX();
- }
-
- /**
- * get the Pattern Background Color for this Format Pattern as an awt.Color
- *
- * @return background Color
- *
- */
- public java.awt.Color getBackgroundColorAsColor() {
- return HexStringToColor(this.getBackgroundColorAsHex());
- }
-
-
- /**
- * returns the foreground color setting regardless of format pattern (which
- * can switch fg and bg)
- *
- * @return
- */
- public int getTrueForegroundColor() {
- return myxf.getForegroundColor(); // 20080814 KSC: getForegroundColor() does the swapping so use base method
- }
-
- /**
- * get the Pattern Background Color for this Formatted Cell
- *
- * This method handles display of conditional formats for the cell
- *
- * checks for conditional format, then applies it if conditions are true.
- *
- * @return the Excel color constant
- */
- public int getCellBackgroundColor() {
- int fp = getFillPattern();
-
- if (fp == Xf.PATTERN_SOLID)
- return myxf.getForegroundColor(); // this.getForegroundColor() does
- // the swapping so use base
- // method
- else
- return myxf.getBackgroundColor();
- }
-
- /**
- * get the Pattern Background Color for this Format as a Hex Color String
- *
- * @return Hex Color String
- */
- public String getCellBackgroundColorAsHex() {
- int fp = getFillPattern();
-
- if (fp == Xf.PATTERN_SOLID)
- return myxf.getForegroundColorHEX(); // this.getForegroundColor() does
- else
- return myxf.getBackgroundColorHEX();
- }
-
- /**
- * get the Pattern Background Color for this Format as an awt.Color
- *
- * @return cell background color
- */
- public java.awt.Color getCellBackgroundColorAsColor() {
- return HexStringToColor(this.getCellBackgroundColorAsHex());
- }
-
- /**
- * get the Background Color for this Format NOTE: Foreground color = the
- * CELL BACKGROUND color color for all patterns and Background color= the
- * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
- * color=CELL BACKGROUND color and Background Color=64 (white).
- *
- * @return the Excel color constant
- */
- public int getForegroundColor() {
- // if it's SOLID pattern, fg/bg are swapped
- if (getFillPattern() == Xf.PATTERN_SOLID)
- return myxf.getBackgroundColor();
-
- return myxf.getForegroundColor();
- }
-
- /**
- * get the Background Color for this Format as a Hex Color String NOTE:
- * Foreground color = the CELL BACKGROUND color color for all patterns and
- * Background color= the PATTERN color for all patterns != Solid For
- * PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background
- * Color=64 (white).
- *
- * @return Hex Color String
- */
- public String getForegroundColorAsHex() {
- if (getFillPattern() == Xf.PATTERN_SOLID) // if it's SOLID pattern,
- return myxf.getBackgroundColorHEX();
-
- return myxf.getForegroundColorHEX();
- }
-
- /**
- * get the Background Color for this Format as a Color NOTE:
- * Foreground color = the CELL BACKGROUND color color for all patterns and
- * Background color= the PATTERN color for all patterns != Solid For
- * PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background
- * Color=64 (white).
- *
- * @return Hex Color String
- */
- public Color getForegroundColorAsColor() {
- return HexStringToColor(this.getForegroundColorAsHex());
- }
-
- /**
- * set the Background Color for this Format NOTE: Foreground color = the
- * CELL BACKGROUND color color for all patterns and Background color= the
- * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
- * color=CELL BACKGROUND color and Background Color=64 (white).
- *
- * @param awt
- * Color color constant
- */
- public void setBackgroundColor(Color colr) {
- Xf xf = cloneXf(myxf);
- int clrz = getColorInt(colr);
- xf.setBackColor(clrz, colr);
- updateXf(xf);
- }
-
- /**
- * Set the format handle to use standard bold text
- *
- * @param boolean isBold
- */
- public void setBold(boolean isBold) {
- Font f = cloneFont(myxf.getFont());
- f.setBold(isBold);
- updateFont(f);
- }
-
- /**
- * Get if this format is bold or not
- *
- * @return boolean whether the cell font format is bold
- */
- public boolean getIsBold() {
- return myxf.getFont().getIsBold();
- }
-
- /**
- * Return an int representing the underline style
- *
- * These map to the STYLE_UNDERLINE static integers *
- *
- * @return int underline style
- */
- public int getUnderlineStyle() {
- return myxf.getFont().getUnderlineStyle();
- }
-
- /**
- * Get the font height in points
- *
- * @return font height
- */
- public double getFontHeightInPoints() {
- return getFont().getFontHeightInPoints();
- }
-
- /**
- * Returns the Font's height in 1/20th point increment
- *
- * @return font height
- */
- public int getFontHeight() {
- return getFont().getFontHeight();
- }
-
- /**
- * Set the Font's height in 1/20th point increment
- *
- * @param new font height
- */
- public void setFontHeight(int fontHeight) {
- Font f = cloneFont(myxf.getFont());
- f.setFontHeight(fontHeight);
- updateFont(f);
- }
-
- /**
- * Returns the Font's name
- *
- * @return font name
- */
- public String getFontName() {
- return getFont().getFontName();
- }
-
- /**
- * Set the Font's name
- *
- * To be valid, this font name must be available on the client system.
- *
- * @param font
- * name
- */
- public void setFontName(String fontName) {
- Font f = cloneFont(myxf.getFont());
- f.setFontName(fontName);
- updateFont(f);
- }
-
- /**
- * Determine if the format handle refers to a font stricken out
- *
- * @return boolean representing if the FormatHandle is striking out a cell.
- */
- public boolean getStricken() {
- if (myxf.getFont() == null)
- return false;
- return myxf.getFont().getStricken();
- }
-
- /**
- * Set if the format handle is stricken out
- *
- * @param isStricken
- * boolean representing if the formatted cell should be stricken
- * out.
- */
- public void setStricken(boolean isStricken) {
- Font f = cloneFont(myxf.getFont());
- f.setStricken(isStricken);
- updateFont(f);
- }
-
- /**
- * Get if the font is italic
- *
- * @return boolean representing if the formatted cell is italic.
- */
- public boolean getItalic() {
- if (myxf.getFont() == null)
- return false;
- return myxf.getFont().getItalic();
- }
-
- /**
- * Set if the font is italic
- *
- * @param isItalic
- * boolean representing if the formatted cell should be italic.
- */
- public void setItalic(boolean isItalic) {
- Font f = cloneFont(myxf.getFont());
- f.setItalic(isItalic);
- updateFont(f);
- }
-
- /**
- * Get if the font is underlined
- *
- * @return boolean representing if the formatted cell is underlined.
- */
- public boolean getUnderlined() {
- if (myxf.getFont() == null)
- return underlined;
- return myxf.getFont().getUnderlined();
- }
-
- /**
- * Set underline attribute on the font
- *
- *
- * @param isUnderlined
- * boolean representing if the formatted cell should be
- * underlined
- */
- public void setUnderlined(boolean isUnderlined) {
- Font f = cloneFont(myxf.getFont());
- f.setUnderlined(isUnderlined);
- updateFont(f);
-
- }
-
- /**
- * Get if the font is bold
- *
- * @return boolean representing if the formatted cell is bold
- */
- public boolean getBold() {
- return myxf.getFont().getBold();
- }
-
- /**
- * returns the existing font record for this Format
- *
- * Font is an internal record and should not be accessed by end users
- *
- * @return the XLS Font record associated with this Format
- */
- public io.starter.formats.XLS.Font getFont() {
- // should this be a protected method?
- if (myxf != null) // shouldn't!
- return myxf.getFont();
- return null;
- }
-
- /**
- * Sets the number format pattern for this format. All Excel built-in number
- * formats are supported. Custom formats will not be applied by OpenXLS
- * (e.g. {@link CellHandle#getFormattedStringVal}) but they will be written
- * correctly to the output file. For more information on number format
- * patterns see Microsoft
- * KB264372 .
- *
- * @param pat
- * the Excel number format pattern to apply
- * @see FormatConstantsImpl#getBuiltinFormats
- */
- public void setFormatPattern(String pat) {
- Xf xf = cloneXf(myxf);
- xf.setFormatPattern(pat);
- updateXf(xf);
- }
-
- public void setPattern(int pat) {
- Xf xf = cloneXf(myxf);
- xf.setPattern(pat);
- updateXf(xf);
- }
-
- /**
- * The format ID allows setting of the format for a Cell without adding it
- * to the Format's Cell Collection.
- *
- * Use to decrease memory requirements when dealing with large collections
- * of cells.
- *
- * Usage:
- *
- * mycell.setFormatId(myformat.getFormatId());
- *
- * @return the format ID for this Format
- */
- public int getFormatId() {
- return xfe;
- }
-
- /**
- * Gets the number format pattern for this format, if set. For more
- * information on number format patterns see Microsoft KB264372 .
- *
- * @return the Excel number format pattern for this cell or
- * null if none is applied
- */
- public String getFormatPattern() {
- return myxf.getFormatPattern();
- }
-
- /**
- * get the fill pattern for this format
- *
- */
- public int getFillPattern() {
- return myxf.getFillPattern();
- }
-
- /**
- * returns the index of the Color within the Colortable
- *
- *
- * @param the
- * index of the color in the colortable
- * @return the color
- */
- public static Color getColor(int col) {
- if (col > -1 && col < FormatHandle.COLORTABLE.length)
- return FormatHandle.COLORTABLE[col];
- return FormatHandle.COLORTABLE[0];
- }
-
- /**
- * returns the index of the Color within the Colortable
- *
- * @param col
- * the color
- * @return the index of the color in the colortable
- */
- public static int getColorInt(Color col) {
- for (int i = 0; i < FormatHandle.COLORTABLE.length; i++) {
- if (col.equals(FormatHandle.COLORTABLE[i])) {
- return i;
- }
- }
- int R = col.getRed();
- int G = col.getGreen();
- int B = col.getBlue();
- int colorMatch = -1;
- double colorDiff = Integer.MAX_VALUE;
- for (int i = 0; i < FormatHandle.COLORTABLE.length; i++) {
- double curDif=
- Math.pow(R-FormatHandle.COLORTABLE[i].getRed(), 2)
- + Math.pow(G - FormatHandle.COLORTABLE[i].getGreen(), 2)
- + Math.pow(B - FormatHandle.COLORTABLE[i].getBlue(), 2);
- if (curDif < colorDiff) {
- colorDiff = curDif;
- colorMatch = i;
- }
- }
- return colorMatch;
- }
-
- /**
- * Sets the internal format to the FormatHandle. For internal use only, not
- * supported.
- */
- public void setXf(Xf xrec) {
- myxf = xrec;
- }
-
- /**
- * Set the horizontal alignment for this FormatHandle
- *
- * @param align
- * - an int representing the alignment. Please review the
- * FormatHandle.ALIGN*** static int's
- */
- public void setHorizontalAlignment(int align) {
- Xf xf = cloneXf(myxf);
- xf.setHorizontalAlignment(align);
- updateXf(xf);
- }
-
- /**
- * Returns an int representing the current horizontal alignment in this
- * FormatHandle. These values are mapped to the FormatHandle.ALIGN*** static
- * int's
- */
- public int getHorizontalAlignment() {
- return myxf.getHorizontalAlignment();
- }
-
- /**
- * set indent (1= 3 spaces)
- * @param indent
- */
- public void setIndent(int indent) {
- Xf xf = cloneXf(myxf);
- xf.setIndent(indent);
- updateXf(xf);
- }
-
- /**
- * increase or decrease the precision of this numeric or curerncy format pattern
- *
- JSONObject border = new JSONObject();
- if (getRightBorderLineStyle() != 0) {
- JSONObject rBorder = new JSONObject();
- rBorder.put("style",
- BORDER_STYLES_JSON[getRightBorderLineStyle()]);
- rBorder.put("color", colorToHexString(getBorderRightColor()));
- border.put("right", rBorder);
- }
- if (getBottomBorderLineStyle() != 0) {
- JSONObject bBorder = new JSONObject();
- bBorder.put("style",
- BORDER_STYLES_JSON[getBottomBorderLineStyle()]);
- bBorder.put("color", colorToHexString(getBorderBottomColor()));
- border.put("bottom", bBorder);
- }
- if (getLeftBorderLineStyle() != 0) {
- JSONObject lBorder = new JSONObject();
- lBorder.put("style",
- BORDER_STYLES_JSON[getLeftBorderLineStyle()]);
- lBorder.put("color", colorToHexString(getBorderLeftColor()));
- border.put("left", lBorder);
- }
- if (getTopBorderLineStyle() != 0) {
- JSONObject tBorder = new JSONObject();
- tBorder.put("style",
- BORDER_STYLES_JSON[getTopBorderLineStyle()]);
- tBorder.put("color", colorToHexString(getBorderTopColor()));
- border.put("top", tBorder);
- }
- theStyle.put("borders", border);
-
- //
- JSONObject alignment = new JSONObject();
- alignment.put("horizontal",
- HORIZONTAL_ALIGNMENTS[getHorizontalAlignment()]);
- alignment.put("vertical",
- VERTICAL_ALIGNMENTS[getVerticalAlignment()]);
- if (getWrapText()) {
- alignment.put("wrap", "1");
- }
- theStyle.put("alignment", alignment);
-
- if (getIndent() != 0) {
- theStyle.put("indent", getIndent());
- }
- // colors + background patterns
- if (getFillPattern() >= 0) { // KSC: added >= 0 as some conditional formats have patternFillStyle==0 even though they have a pattern block and
- JSONObject interior = new JSONObject();
- // weird black/white case
- if (myxf.getForegroundColor() == 65) {
- interior.put("color", "#FFFFFF");
- } else {
- // KSC: use color string if it exists; create if doesn't
- interior.put("color", myxf.getForegroundColorHEX());
- }
- interior.put("pattern", myxf.getFillPattern());
- interior.put("fg", myxf.getForegroundColor()); // Excel-2003 Color Table index
- interior.put("patterncolor", myxf.getBackgroundColorHEX());
- interior.put("bg", myxf.getBackgroundColor()); // Excel-2003 Color Table index
- theStyle.put("interior", interior);
- }
-
- if (myxf.getIfmt() != 0) { // only input user defined formats ...
- JSONObject nFormat = new JSONObject();
- String fmtpat = getFormatPattern();
- try {
- if (!fmtpat.equals("General")) {
- nFormat.put("format", fmtpat); // convertXMLChars?
- nFormat.put("formatid", myxf.getIfmt());
- if (isDate())
- nFormat.put("isdate", "1");
- if (isCurrency())
- nFormat.put("iscurrency", "1");
- if (isRedWhenNegative())
- nFormat.put("isrednegative", "1");
- }
-
- } catch (Exception e) { // it's possible that getFormatPattern
- // returns null
- }
- theStyle.put("numberformat", nFormat);
- }
- //
- JSONObject protection = new JSONObject();
- try {
- if (this.myxf.isLocked())
- protection.put("Protected", true);
- if (this.myxf.isFormulaHidden())
- protection.put("HideFormula", true);
- } catch (Exception e) {
- }
- theStyle.put("protection", protection);
-
- } catch (JSONException e) {
- Logger.logErr("Error getting cellRange JSON: " + e);
- }
- return theStyle;
- }
-
- /**
- * Returns an XML fragment representing the FormatHandle
- */
- public String getXML(int XFNum) {
- return getXML(XFNum, false);
- }
-
- /**
- * Returns an XML fragment representing the FormatHandle
- *
- * @param convertToUnicodeFont
- * if true, font family will be changed to ArialUnicodeMS
- * (standard unicode) for non-ascii fonts
- */
- public String getXML(int XFNum, boolean convertToUnicodeFont) {
- Font myf = getFont();
- // ");
- return sb.toString();
- }
-
- /**
- * Gets the Excel format ID for this format's number format pattern.
- *
- * @return the Excel format identifier number for the number format pattern
- */
- public int getFormatPatternId() {
- return myxf.getIfmt();
- }
-
- /**
- * Sets the number format pattern based on the format ID number. This method
- * is recommended for advanced users only. In most cases you should use
- * {@link #setFormatPattern(String)} instead.
- *
- * @param fmt
- * the format ID number for the desired number format pattern
- */
- public void setFormatPatternId(int fmt) {
- myxf.setFormat((short) fmt);
- }
-
- /**
- * Convert a java.awt.Color to a hex string.
- *
- * @return String representation of a Color
- */
- public static String colorToHexString(Color c) {
- int r = c.getRed();
- int g = c.getGreen();
- int b = c.getBlue();
- String rh = Integer.toHexString(r);
- if (rh.length() < 2) {
- rh = "0" + rh;
- }
- String gh = Integer.toHexString(g);
- if (gh.length() < 2) {
- gh = "0" + gh;
- }
- String bh = Integer.toHexString(b);
- if (bh.length() < 2) {
- bh = "0" + bh;
- }
- return ("#" + rh + gh + bh).toUpperCase();
- }
-
-
- public static short colorFONT = 0;
- public static short colorBACKGROUND = 1;
- public static short colorFOREGROUND = 2;
- public static short colorBORDER = 3;
-
- /**
- * convert hex string RGB to Excel colortable int format if an exact match
- * is not find, does color-matching to try and obtain closest match
- *
- * @param s
- * @param colorType
- * @return
- */
- public static int HexStringToColorInt(String s, short colorType) {
- if (s.length() > 7)
- s = "#" + s.substring(s.length() - 6);
- if (s.indexOf("#") == -1)
- s = "#" + s;
- if (s.length() == 7) {
- String rs = s.substring(1, 3);
- int r = Integer.parseInt(rs, 16);
- String gs = s.substring(3, 5);
- int g = Integer.parseInt(gs, 16);
- String bs = s.substring(5, 7);
- int b = Integer.parseInt(bs, 16);
- // Handle exceptions for black, white and color indexes 9 (see
- // FormatConstants for more info)
-
- if (r == 255 && r == g && r == b) {
- if (colorType == colorFONT)
- return 9;
- }
-
- Color c = new Color(r, g, b);
- return getColorInt(c);
- }
- return 0;
- }
-
- /**
- * convert hex string RGB to Excel colortable int format if no exact match
- * is found returns -1
- *
- * @param s
- * HTML color string (#XXXXXX) format or (#FFXXXXXX - OOXML-style
- * format)
- * @param colorType
- * @return index into color table or -1 if not found
- */
- public static int HexStringToColorIntExact(String s, short colorType) {
- if (s.length() > 7)
- s = "#" + s.substring(s.length() - 6);
- if (s.indexOf("#") == -1)
- s = "#" + s;
- if (s.length() == 7) {
- String rs = s.substring(1, 3);
- int r = Integer.parseInt(rs, 16);
- String gs = s.substring(3, 5);
- int g = Integer.parseInt(gs, 16);
- String bs = s.substring(5, 7);
- int b = Integer.parseInt(bs, 16);
-
- // Handle exceptions for black, white and color indexes 9 (see
- // FormatConstants for more info)
- if (r == 255 && r == g && r == b) {
- if (colorType == colorFONT)
- return 9;
- }
-
- Color c = new Color(r, g, b);
- for (int i = 0; i < FormatHandle.COLORTABLE.length; i++) {
- if (c.equals(FormatHandle.COLORTABLE[i])) {
- return i;
- }
- }
- }
- return -1; // match NOT FOUND
- }
-
- /**
- * convert hex string RGB to a Color
- *
- *
- * @param s web-style hex color string, including #, or OOXML-style color string, FFXXXXXX
- * @return Color
- * @see Color
- */
- public static Color HexStringToColor(String s) {
- if (s.length() > 7){ // transform OOXML-style color strings to Web-style
- s = "#" + s.substring(s.length() - 6);
- }
- Color c = null;
- if (s.length() == 7) {
- String rs = s.substring(1, 3);
- int r = Integer.parseInt(rs, 16);
- String gs = s.substring(3, 5);
- int g = Integer.parseInt(gs, 16);
- String bs = s.substring(5, 7);
- int b = Integer.parseInt(bs, 16);
- c = new Color(r, g, b);
- } else
- c = new Color(0, 0, 0); // default to black?
- return c;
- }
-
- /**
- * interpret color table special entries
- *
- * @param clr
- * color index in range of 0x41-0x4F (charts) 0x40 ...
- * @return index into color table
- */
- public static short interpretSpecialColorIndex(int clr) {
- switch (clr) {
- case 0x0041: // Default background color. This is the window background
- // color in the sheet display and is the default
- // background color for a cell.
- case 0x004E: // Default chart background color. This is the window
- // background color in the chart display.
- case 0x0050: // WHAT IS THIS ONE????????
- return FormatConstants.COLOR_WHITE;
- case 0x0040: // Default foreground color
- case 0x004F: // Chart neutral color which is black, an RGB value of
- // (0,0,0).
- case 0x004D: // Default chart foreground color. This is the window text
- // color in the chart display.
- case 0x0051: // ToolTip text color. This is the automatic font color for
- // comments.
- case 0x7FFF: // Font automatic color. This is the window text color
- return FormatConstants.COLOR_BLACK;
- default: // 67(=0x43) ???
- return FormatConstants.COLOR_WHITE;
- }
-
- /*
- * switch (icvFore) { case 0x40: // default fg color return
- * FormatConstants.COLOR_WHITE; case 0x41: // default bg color return
- * FormatConstants.COLOR_WHITE; case 0x4D: // default CHART fg color --
- * INDEX SPECIFIC! return -1; // flag to map via series (bar) color
- * defaults case 0x4E: // default CHART fg color return icvFore; case
- * 0x4F: // chart neutral color == black return
- * FormatConstants.COLOR_BLACK; }
- *
- * switch (icvBack) { case 0x40: // default fg color return
- * FormatConstants.COLOR_WHITE; case 0x41: // default bg color return
- * FormatConstants.COLOR_WHITE; case 0x4D: // default CHART fg color --
- * INDEX SPECIFIC! return -1; // flag to map via series (bar) color
- * defaults case 0x4E: // default CHART bg color //return
- * FormatConstants.COLOR_WHITE; // is this correct? return icvBack; case
- * 0x4F: // chart neutral color == black return
- * FormatConstants.COLOR_BLACK; }
- */
- }
-
- public static int BorderStringToInt(String s) {
- for (int i = 0; i < FormatConstants.BORDER_NAMES.length; i++) {
- if (FormatConstants.BORDER_NAMES[i].equals(s))
- return i;
- }
- return 0;
- }
-
- // 20060412 KSC: added for access
- public io.starter.formats.XLS.WorkBook getWorkBook() {
- return wkbook;
- }
-
- /**
- * return truth of "this Xf rec is a style xf"
- *
- * @return
- */
- public boolean isStyleXf() {
- return myxf.isStyleXf();
- }
-
- /**
- * creates a new font based on an existing one, adds to workbook recs
- */
- private Font createNewFont(Font f) {
- f.setIdx(-1); // flag to insert anew (see Font.setWorkBook)
- wkbook.insertFont(f);
- f.setWorkBook(wkbook);
- return f;
- }
-
- /**
- * create a new font based on existing font - does not add to workbook recs
- *
- * @param src
- * font
- * @return cloned font
- */
- private Font cloneFont(Font src) {
- Font f = new Font();
- f.setOpcode(io.starter.formats.XLS.XLSConstants.FONT);
- f.setData(src.getBytes()); // use default font as basis of new font
- f.setIdx(-2); // avoid adding to fonts array when call setW.b. below
- f.setWorkBook(this.getWorkBook());
- f.init();
- return f;
- }
-
- /**
- * update the font for this FormatHandle, including updating the xf if
- * necessary
- *
- * @param f
- */
- private void updateFont(Font f) {
- int idx = wkbook.getFontIdx(f);
- if (idx == -1) { // can't find it so add new
- f = createNewFont(f);
- } else
- f = wkbook.getFont(idx);
- if (f.getIdx()!=myxf.getIfnt()) { // then updated the font, must create new xf to link to
- Xf xf = cloneXf(myxf);
- xf.setFont(f.getIdx());
- updateXf(xf);
- }
- }
-
- /**
- * Create or Duplicate Xf rec so can alter (pattern, font, colrs ...)
- *
- * @param xf
- * xf to base off of, or null (will create new)
- * @return new Xf
- */
- private Xf duplicateXf(Xf xf) {
- int fidx = 0;
- if (xf != null)
- fidx = xf.getFont().getIdx();
- xf = Xf.updateXf(xf, fidx, wkbook); // clones/creates new based upon
- // original
- xfe = xf.getIdx(); // update the pointer
-// not used anymore canModify = true; // if duplicated, it's new and unlinked (thus far)
- return xf;
- }
-
- /**
- * adds all formatting represented by the sourceXf to this workbook, if not
- * already present
+ * G Era designator Text AD
+ * y Year Year 1996; 96
+ * M Month in year Month July; Jul; 07
+ * w Week in year Number 27
+ * W Week in month Number 2
+ * D Day in year Number 189
+ * d Day in month Number 10
+ * F Day of week in month Number 2
+ * E Day in week Text Tuesday; Tue
+ * a Am/pm marker Text PM
+ * H Hour in day (0-23) Number 0
+ * k Hour in day (1-24) Number 24
+ * K Hour in am/pm (0-11) Number 0
+ * h Hour in am/pm (1-12) Number 12
+ * m Minute in hour Number 30
+ * s Second in minute Number 55
+ * S Millisecond Number 978
+ * z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
+ * Z Time zone RFC 822 time zone -0800
+ *
+ *
+ * @return String the formatting pattern for the cell
+ */
+ // toLowerCase is a simplistic way to implement the case insensitivity
+ // of the pattern tokens. It could cause issues with string literals.
+ /*
+ * If we reached here, we don't have a mapping for this particular
+ * format. Send a warning to the system then make sure the pattern we
+ * are sending back is valid. Many excel patterns have 4 patterns
+ * separated by semicolons. We only can pass 2 into the formatter
+ * (positive and negative). This usually works out to be the first two
+ * patterns in the string.
+ */// yet another hackaround -jm
+ val javaFormatString: String?
+ get() {
+ var pat = formatPattern ?: return null
+ var patty: Any? = convertFormatString(pat!!.toLowerCase())
+ if (patty != null)
+ patty = StringTool.qualifyPatternString(patty.toString())
+ if (xf!!.isDatePattern) {
+ return if (patty != null)
+ patty as String?
+ else
+ "M/d/yy h:mm"
+ }
+ if (patty != null)
+ return patty as String?
+ pat = StringTool.qualifyPatternString(pat)
+ val firstParens = pat!!.indexOf(";")
+ if (firstParens != -1) {
+ val secondParens = pat!!.indexOf(";", firstParens + 1)
+ if (secondParens != -1) {
+ pat = pat!!.substring(0, secondParens)
+ } else {
+ pat = pat!!.substring(firstParens + 2, pat!!.length - 1)
+ }
+ }
+ return pat
+ }
+
+ /**
+ * Get the Right border color
+ *
+ * @return color constant
+ */
+ // black i'm afraid
+ val borderRightColor: Color?
+ get() {
+ if (xf!!.rightBorderLineStyle.toInt() == 0)
+ return null
+ val x = xf!!.rightBorderColor.toInt()
+ return if (x < this.workBook!!.colorTable.size)
+ this.workBook!!.colorTable[x]
+ else
+ this.workBook!!.colorTable[0]
+ }
+
+ /**
+ * returns Border Colors of Cell ie: top, left, bottom, right
+ *
+ *
+ * returns null or 1 color for each of 4 sides
+ *
+ *
+ * 1,1,1,1 represents a border all around the cell 1,1,0,0 represents on the
+ * top left edge of the cell
+ *
+ * @return int array representing Cell borders
+ */
+ /*
+ * FIXME: Border Issues (marker)
+ *
+ * The methods to set individual border line styles do not follow a
+ * consistent naming convention with the rest of the border methods.
+ *
+ * There are no methods for getting or setting the inside borders. I don't
+ * know whether this is a problem or a design choice. It depends on whether
+ * the inside borders are stored in the format record or as separate cell
+ * formats.
+ *
+ * There are no methods to get the diagonal borders. There is a method to
+ * set the diagonal border line style, but it affects both diagonals.
+ */
+
+ /**
+ * sets the border color for all borders (top, left, bottom and right) from
+ * a Color array
+ *
+ *
+ * NOTE: this setting will affect every cell which refers to this
+ * FormatHandle
+ *
+ * @param java .awt.Color array - 4-element array of desired border colors
+ * [T, L, B, R]
+ */
+ var borderColors: Array
+ get() {
+ val colors = arrayOfNulls(4)
+ colors[0] = borderTopColor
+ colors[1] = borderLeftColor
+ colors[2] = borderBottomColor
+ colors[3] = borderRightColor
+ return colors
+ }
+ set(bordercolors) {
+ val xf = cloneXf(this.xf!!)
+ if (bordercolors[0] != null)
+ xf.topBorderColor = getColorInt(bordercolors[0])
+ if (bordercolors[1] != null)
+ xf.leftBorderColor = getColorInt(bordercolors[1])
+ if (bordercolors[2] != null)
+ xf.bottomBorderColor = getColorInt(bordercolors[2])
+ if (bordercolors[3] != null)
+ xf.setRightBorderColor(getColorInt(bordercolors[3]))
+ updateXf(xf)
+ }
+
+ /**
+ * Get the Left border color
+ *
+ * @return color constant
+ */
+ val borderLeftColor: Color?
+ get() = if (xf!!.leftBorderLineStyle.toInt() == 0) null else this.workBook!!.colorTable[xf!!.leftBorderColor]
+
+ /**
+ * Get the Top border color
+ *
+ * @return color constant
+ */
+ // guards
+ val borderTopColor: Color?
+ get() {
+ if (xf!!.topBorderLineStyle.toInt() == 0)
+ return null
+ var xt = xf!!.topBorderColor
+ if (xt > this.workBook!!.colorTable.size)
+ xt = 0
+ return this.workBook!!.colorTable[xt]
+ }
+
+ /**
+ * Returns true if the value should be red due to a combination of a format
+ * pattern and a negative number
+ *
+ * @return
+ */
+ val isRedWhenNegative: Boolean
+ get() {
+ val pattern = xf!!.formatPattern
+ return pattern!!.indexOf("Red") > -1
+ }
+
+ /**
+ * Get the Right border color
+ *
+ * @return color constant
+ */
+ // black i'm afraid
+ val borderBottomColor: Color?
+ get() {
+ if (xf!!.bottomBorderLineStyle.toInt() == 0)
+ return null
+ val x = xf!!.bottomBorderColor
+ return if (x < this.workBook!!.colorTable.size)
+ this.workBook!!.colorTable[x]
+ else
+ this.workBook!!.colorTable[0]
+
+ }
+
+ /**
+ * Get the border line style
+ *
+ * @return line style constant
+ */
+ /**
+ * Set the border line style
+ *
+ * @param line style constant
+ */
+ var topBorderLineStyle: Int
+ get() = xf!!.topBorderLineStyle.toInt()
+ set(x) {
+ val xf = cloneXf(this.xf!!)
+ xf.topBorderLineStyle = x.toShort()
+ updateXf(xf)
+ }
+
+ /**
+ * Get the border line style
+ *
+ * @return line style constant
+ */
+ /**
+ * Set the border line style
+ *
+ * @param line style constant
+ */
+ var bottomBorderLineStyle: Int
+ get() = xf!!.bottomBorderLineStyle.toInt()
+ set(x) {
+ val xf = cloneXf(this.xf!!)
+ xf.bottomBorderLineStyle = x.toShort()
+ updateXf(xf)
+ }
+
+ /**
+ * Get the border line style
+ *
+ * @return line style constant
+ */
+ /**
+ * Set the border line style
+ *
+ * @param line style constant
+ */
+ var leftBorderLineStyle: Int
+ get() = xf!!.leftBorderLineStyle.toInt()
+ set(x) {
+ val xf = cloneXf(this.xf!!)
+ xf.leftBorderLineStyle = x.toShort()
+ updateXf(xf)
+ }
+
+ /**
+ * Get the border line style
+ *
+ * @return line style constant
+ */
+ /**
+ * Set the border line style
+ *
+ * @param line style constant
+ */
+ var rightBorderLineStyle: Int
+ get() = xf!!.rightBorderLineStyle.toInt()
+ set(x) {
+ val xf = cloneXf(this.xf!!)
+ xf.rightBorderLineStyle = x.toShort()
+ updateXf(xf)
+ }
+
+ /**
+ * return the 5 border lines styles (l, r, t, b, diag)
+ *
+ * @return
+ */
+ val allBorderLineStyles: IntArray
+ get() {
+ val ret = IntArray(5)
+ ret[0] = xf!!.leftBorderLineStyle.toInt()
+ ret[1] = xf!!.rightBorderLineStyle.toInt()
+ ret[2] = xf!!.topBorderLineStyle.toInt()
+ ret[3] = xf!!.bottomBorderLineStyle.toInt()
+ ret[4] = xf!!.diagBorderLineStyle.toInt()
+ return ret
+ }
+
+ /**
+ * return the 5 border line colors (l, r, t, b, diag)
+ *
+ * @return
+ */
+ val allBorderColors: IntArray
+ get() {
+ val ret = IntArray(5)
+ ret[0] = xf!!.leftBorderColor
+ ret[1] = xf!!.rightBorderColor.toInt()
+ ret[2] = xf!!.topBorderColor
+ ret[3] = xf!!.bottomBorderColor
+ ret[4] = xf!!.diagBorderColor.toInt()
+ return ret
+ }
+
+/**
+ * Get the font weight the weight of the font is in 1/20 point units
+ *
+ * @return
+ */
+/**
+ * /** Set the weight of the font in 1/20 point units 100-1000 range. 400 is
+ * normal, 700 is bold.
+ *
+ * @param wt
+*/
+var fontWeight:Int
+get() {
+return xf!!.font!!.fontWeight
+}
+set(wt) {
+val f = cloneFont(xf!!.font!!)
+f.fontWeight = wt
+updateFont(f)
+}
+
+/**
+ * returns whether this Format is formatted as a Date
+ *
+ * @return boolean true if this Format is formatted as a Date
+*/
+val isDate:Boolean
+get() {
+if (xf == null)
+return false
+return xf!!.isDatePattern
+}
+
+/**
+ * returns whether this Format is formatted as a Currency
+ *
+ * @return boolean true if this Format is formatted as a currency
+*/
+val isCurrency:Boolean
+get() {
+if (xf == null)
+return false
+return xf!!.isCurrencyPattern
+}
+
+/**
+ * Get the Font foreground (text) color as a java.awt.Color
+ *
+ * @return
+*/
+val fontColor:Color
+get() {
+return xf!!.font!!.colorAsColor
+}
+
+
+val fontColorAsHex:String
+get() {
+return xf!!.font!!.colorAsHex
+}
+
+/**
+ * Get the Pattern Background Color for this Format Pattern
+ *
+ * @return the Excel color constant
+*/
+/**
+ * set the background color for this Format NOTE: Foreground color = the
+ * CELL BACKGROUND color color for all patterns and Background color= the
+ * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
+ * color=CELL BACKGROUND color and Background Color=64 (white).
+ *
+ * @param t Excel color constant
+*/
+var backgroundColor:Int
+get() {
+return xf!!.backgroundColor.toInt()
+}
+set(t) {
+val xf = cloneXf(this.xf!!)
+if (xf.fillPattern == Xf.PATTERN_SOLID)
+xf.setForeColor(t, null)
+else
+xf.setBackColor(t, null)
+
+updateXf(xf)
+}
+
+/**
+ * get the Pattern Background Color for this Format Pattern as a hex string
+ *
+ * @return Hex Color String
+*/
+val backgroundColorAsHex:String?
+get() {
+return xf!!.backgroundColorHEX
+}
+
+/**
+ * get the Pattern Background Color for this Format Pattern as an awt.Color
+ *
+ * @return background Color
+*/
+val backgroundColorAsColor:java.awt.Color
+get() {
+return HexStringToColor(this.backgroundColorAsHex!!)
+}
+
+
+/**
+ * returns the foreground color setting regardless of format pattern (which
+ * can switch fg and bg)
+ *
+ * @return
+*/
+// 20080814 KSC: getForegroundColor() does the swapping so use base method
+val trueForegroundColor:Int
+get() {
+return xf!!.foregroundColor.toInt()
+}
+
+/**
+ * get the Pattern Background Color for this Formatted Cell
+ *
+ *
+ * This method handles display of conditional formats for the cell
+ *
+ *
+ * checks for conditional format, then applies it if conditions are true.
+ *
+ * @return the Excel color constant
+*/
+// this.getForegroundColor() does
+// the swapping so use base
+// method
+val cellBackgroundColor:Int
+get() {
+val fp = fillPattern
+
+if (fp == Xf.PATTERN_SOLID)
+return xf!!.foregroundColor.toInt()
+else
+return xf!!.backgroundColor.toInt()
+}
+
+/**
+ * get the Pattern Background Color for this Format as a Hex Color String
+ *
+ * @return Hex Color String
+*/
+// this.getForegroundColor() does
+val cellBackgroundColorAsHex:String?
+get() {
+val fp = fillPattern
+
+if (fp == Xf.PATTERN_SOLID)
+return xf!!.foregroundColorHEX
+else
+return xf!!.backgroundColorHEX
+}
+
+/**
+ * get the Pattern Background Color for this Format as an awt.Color
+ *
+ * @return cell background color
+*/
+val cellBackgroundColorAsColor:java.awt.Color
+get() {
+return HexStringToColor(this.cellBackgroundColorAsHex!!)
+}
+
+/**
+ * get the Background Color for this Format NOTE: Foreground color = the
+ * CELL BACKGROUND color color for all patterns and Background color= the
+ * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
+ * color=CELL BACKGROUND color and Background Color=64 (white).
+ *
+ * @return the Excel color constant
+*/
+/**
+ * set the Foreground Color for this Format NOTE: Foreground color = the
+ * CELL BACKGROUND color color for all patterns and Background color= the
+ * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
+ * color=CELL BACKGROUND color and Background Color=64 (white).
+ *
+ * @param int Excel color constant
+*/
+// if it's SOLID pattern, fg/bg are swapped
+var foregroundColor:Int
+get() {
+if (fillPattern == Xf.PATTERN_SOLID)
+return xf!!.backgroundColor.toInt()
+
+return xf!!.foregroundColor.toInt()
+}
+set(t) {
+val xf = cloneXf(this.xf!!)
+xf.setForeColor(t, null)
+updateXf(xf)
+}
+
+/**
+ * get the Background Color for this Format as a Hex Color String NOTE:
+ * Foreground color = the CELL BACKGROUND color color for all patterns and
+ * Background color= the PATTERN color for all patterns != Solid For
+ * PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background
+ * Color=64 (white).
+ *
+ * @return Hex Color String
+*/
+// if it's SOLID pattern,
+val foregroundColorAsHex:String?
+get() {
+if (fillPattern == Xf.PATTERN_SOLID)
+return xf!!.backgroundColorHEX
+
+return xf!!.foregroundColorHEX
+}
+
+/**
+ * get the Background Color for this Format as a Color NOTE:
+ * Foreground color = the CELL BACKGROUND color color for all patterns and
+ * Background color= the PATTERN color for all patterns != Solid For
+ * PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background
+ * Color=64 (white).
+ *
+ * @return Hex Color String
+*/
+val foregroundColorAsColor:Color
+get() {
+return HexStringToColor(this.foregroundColorAsHex!!)
+}
+
+/**
+ * Get if this format is bold or not
+ *
+ * @return boolean whether the cell font format is bold
+*/
+val isBold:Boolean
+get() {
+return xf!!.font!!.isBold
+}
+
+/**
+ * Return an int representing the underline style
+ *
+ *
+ * These map to the STYLE_UNDERLINE static integers *
+ *
+ * @return int underline style
+*/
+/**
+ * set the underline style for this font
+ *
+ * @param int u underline style one of the Font.STYLE_UNDERLINE constants
+*/
+var underlineStyle:Int
+get() {
+return xf!!.font!!.underlineStyle
+}
+set(u) {
+val f = cloneFont(xf!!.font!!)
+f.setUnderlineStyle(u.toByte())
+updateFont(f)
+}
+
+/**
+ * Get the font height in points
+ *
+ * @return font height
+*/
+val fontHeightInPoints:Double
+get() {
+return font!!.fontHeightInPoints
+}
+
+/**
+ * Returns the Font's height in 1/20th point increment
+ *
+ * @return font height
+*/
+/**
+ * Set the Font's height in 1/20th point increment
+ *
+ * @param new font height
+*/
+var fontHeight:Int
+get() {
+return font!!.fontHeight
+}
+set(fontHeight) {
+val f = cloneFont(xf!!.font!!)
+f.fontHeight = fontHeight
+updateFont(f)
+}
+
+/**
+ * Returns the Font's name
+ *
+ * @return font name
+*/
+/**
+ * Set the Font's name
+ *
+ *
+ * To be valid, this font name must be available on the client system.
+ *
+ * @param font name
+*/
+var fontName:String?
+get() {
+return font!!.getFontName()
+}
+set(fontName) {
+val f = cloneFont(xf!!.font!!)
+f.setFontName(fontName)
+updateFont(f)
+}
+
+/**
+ * Determine if the format handle refers to a font stricken out
+ *
+ * @return boolean representing if the FormatHandle is striking out a cell.
+*/
+/**
+ * Set if the format handle is stricken out
+ *
+ * @param isStricken boolean representing if the formatted cell should be stricken
+ * out.
+*/
+var stricken:Boolean
+get() {
+if (xf!!.font == null)
+return false
+return xf!!.font!!.stricken
+}
+set(isStricken) {
+val f = cloneFont(xf!!.font!!)
+f.stricken = isStricken
+updateFont(f)
+}
+
+/**
+ * Get if the font is italic
+ *
+ * @return boolean representing if the formatted cell is italic.
+*/
+/**
+ * Set if the font is italic
+ *
+ * @param isItalic boolean representing if the formatted cell should be italic.
+*/
+var italic:Boolean
+get() {
+if (xf!!.font == null)
+return false
+return xf!!.font!!.italic
+}
+set(isItalic) {
+val f = cloneFont(xf!!.font!!)
+f.italic = isItalic
+updateFont(f)
+}
+
+/**
+ * Get if the font is bold
+ *
+ * @return boolean representing if the formatted cell is bold
+*/
+/**
+ * Set the format handle to use standard bold text
+ *
+ * @param boolean isBold
+*/
+var bold:Boolean
+get() {
+return xf!!.font!!.bold
+}
+set(isBold) {
+val f = cloneFont(xf!!.font!!)
+f.bold = isBold
+updateFont(f)
+}
+
+/**
+ * returns the existing font record for this Format
+ *
+ *
+ * Font is an internal record and should not be accessed by end users
+ *
+ * @return the XLS Font record associated with this Format
+*/
+/**
+ * Set the Font for this Format.
+ *
+ *
+ * As adding a new Font and format increases the file size, try using this
+ * once for each distinct font used in the file, then use 'setFormatId' to
+ * share this font with other Cells.
+ *
+ *
+ * Roughly matches the functionality of the java.awt.Font class. Currently
+ * the style parameter is only useful for bold/normal weights. Italics,
+ * underlines, etc must be modified elsewhere.
+ *
+ *
+ * Note that in order to maintain java.awt.Font compatibility for
+ * bold/normal styles, defaults for weight/style have been mapped to 0 =
+ * normal (excel 200 weight) and 1 = bold (excel 700 weight)
+ *
+ * @param String font name
+ * @param int font style
+ * @param int font size
+*/
+// should this be a protected method?
+// shouldn't!
+var font:io.starter.formats.XLS.Font?
+get() {
+if (xf != null)
+return xf!!.font
+return null
+}
+set(f) {
+setXFToFont(f)
+}
+
+/**
+ * Gets the number format pattern for this format, if set. For more
+ * information on number format patterns see [Microsoft KB264372](http://support.microsoft.com/kb/264372).
+ *
+ * @return the Excel number format pattern for this cell or
+ * `null` if none is applied
+*/
+/**
+ * Sets the number format pattern for this format. All Excel built-in number
+ * formats are supported. Custom formats will not be applied by OpenXLS
+ * (e.g. [CellHandle.getFormattedStringVal]) but they will be written
+ * correctly to the output file. For more information on number format
+ * patterns see [Microsoft
+ * KB264372](http://support.microsoft.com/kb/264372).
+ *
+ * @param pat the Excel number format pattern to apply
+ * @see FormatConstantsImpl.getBuiltinFormats
+*/
+var formatPattern:String?
+get() {
+return xf!!.formatPattern
+}
+set(pat) {
+val xf = cloneXf(this.xf!!)
+xf.formatPattern = pat
+updateXf(xf)
+}
+
+/**
+ * get the fill pattern for this format
+*/
+val fillPattern:Int
+get() {
+return xf!!.fillPattern
+}
+
+/**
+ * Returns an int representing the current horizontal alignment in this
+ * FormatHandle. These values are mapped to the FormatHandle.ALIGN*** static
+ * int's
+*/
+/**
+ * Set the horizontal alignment for this FormatHandle
+ *
+ * @param align - an int representing the alignment. Please review the
+ * FormatHandle.ALIGN*** static int's
+*/
+var horizontalAlignment:Int
+get() {
+return xf!!.horizontalAlignment
+}
+set(align) {
+val xf = cloneXf(this.xf!!)
+xf.horizontalAlignment = align
+updateXf(xf)
+}
+
+/**
+ * return indent (1 = 3 spaces)
+ *
+ * @return
+*/
+/**
+ * set indent (1= 3 spaces)
+ *
+ * @param indent
+*/
+var indent:Int
+get() {
+return xf!!.indent
+}
+set(indent) {
+val xf = cloneXf(this.xf!!)
+xf.indent = indent
+updateXf(xf)
+}
+
+/**
+ * returns true if this style is set to Right-to-Left text direction
+ * (reading order)
+ *
+ * @return
+*/
+val rightToLetReadingOrder:Int
+get() {
+return xf!!.rightToLeftReadingOrder
+}
+
+/**
+ * Returns an int representing the current Vertical alignment in this
+ * FormatHandle. These values are mapped to the FormatHandle.ALIGN*** static
+ * int's
+*/
+/**
+ * Set the Vertical alignment for this FormatHandle
+ *
+ * @param align - an int representing the alignment. Please review the
+ * FormatHandle.ALIGN*** static int's
+*/
+var verticalAlignment:Int
+get() {
+return xf!!.verticalAlignment
+}
+set(align) {
+val xf = cloneXf(this.xf!!)
+xf.verticalAlignment = align
+updateXf(xf)
+}
+
+/**
+ * Get the cell wrapping behavior for this FormatHandle. Default is false
+*/
+/**
+ * Set the cell wrapping behavior for this FormatHandle. Default is false
+*/
+var wrapText:Boolean
+get() {
+return xf!!.wrapText
+}
+set(wrapit) {
+val xf = cloneXf(this.xf!!)
+xf.wrapText = wrapit
+updateXf(xf)
+}
+
+/**
+ * Get the rotation of the cell. Value 0 means no rotation (horizontal
+ * text). Values 1-90 mean rotation up (couter-clockwise) by 1-90 degrees.
+ * Values 91-180 mean rotation down (clockwise) by 1-90 degrees. Value 255
+ * means vertical text.
+*/
+/**
+ * Set the rotation of the cell in degrees. Values 0-90 represent rotation
+ * up, 0-90degrees. Values 91-180 represent rotation down, 0-90 degrees.
+ * Value 255 is vertical
+ *
+ * @param align - an int representing the rotation.
+*/
+var cellRotation:Int
+get() {
+return xf!!.rotation
+}
+set(align) {
+val xf = cloneXf(this.xf!!)
+xf.rotation = align
+updateXf(xf)
+}
+
+/**
+ * Gets the Excel format ID for this format's number format pattern.
+ *
+ * @return the Excel format identifier number for the number format pattern
+*/
+/**
+ * Sets the number format pattern based on the format ID number. This method
+ * is recommended for advanced users only. In most cases you should use
+ * [.setFormatPattern] instead.
+ *
+ * @param fmt the format ID number for the desired number format pattern
+*/
+var formatPatternId:Int
+get() {
+return xf!!.ifmt.toInt()
+}
+set(fmt) {
+xf!!.setFormat(fmt.toShort())
+}
+
+/**
+ * return truth of "this Xf rec is a style xf"
+ *
+ * @return
+*/
+val isStyleXf:Boolean
+get() {
+return xf!!.isStyleXf
+}
+
+/**
+ * Nullary constructor for use in bean context. **This is not part of the
+ * public API and should not be called.**
+*/
+constructor() {}
+
+/**
+ * Constructs a FormatHandle for the given WorkBook and format record.
+ * **This is not part of the public API and should not be called.**
+*/
+constructor(book:io.starter.OpenXLS.WorkBook?, xfr:Xf) {
+xf = xfr
+formatId = xf!!.idx
+wbh = book
+if (book != null)
+{
+workBook = book!!.workBook
+}
+else
+{
+if (xfr.workBook != null)
+{
+workBook = xfr.workBook
+}
+else
+{
+Logger.logErr("FormatHandle constructed with null WorkBook.")
+}
+}
+}
+
+/**
+ * Constructs a FormatHandle for the given WorkBook's default format.
+*/
+constructor(book:io.starter.OpenXLS.WorkBook) : this(book, book.workBook.defaultIxfe) {}
+
+/**
+ * Constructs a FormatHandle for the given format ID and WorkBook.
+ * This is useful for creating a FormatHandle with the same parameters as
+ * a cell that does not refer to the cell. For example:
+ *
+ * CellHandle cell = <get cell here>;
+ * FormatHandle format = new FormatHandle(
+ * cell.getWorkBook(), cell.getFormatId() );
+ *
+ *
+ * @param book the WorkBook from which the format should be retrieved
+ * @param xfnum the ID of the format
+*/
+constructor(book:io.starter.formats.XLS.WorkBook, xfnum:Int) {
+workBook = book
+if (xfnum > -1 && xfnum < workBook!!.numXfs)
+{
+xf = workBook!!.getXf(xfnum)
+formatId = xf!!.idx
+}
+if (xf == null)
+{ // add new xf if necessary
+xf = duplicateXf(null)
+}
+xf!!.font // will set to default (0th) font if not already set
+}
+
+/** Constructs a FormatHandle for the given format ID and WorkBook.
+ * This is useful for creating a FormatHandle with the same parameters as
+ * a cell that does not refer to the cell. For example:
+ *
+ * CellHandle cell = <get cell here>;
+ * FormatHandle format = new FormatHandle(
+ * cell.getWorkBook(), cell.getFormatId() );
+ *
+ *
+ * @param book
+ * the WorkBook from which the format should be retrieved
+ * @param xfnum
+ * the ID of the format public FormatHandle(WorkBook book, int
+ * xfnum ,int x) { this(book.getWorkBook(),xfnum); wbh = book; }
+*/
+
+/**
+ * Constructs a FormatHandle for the given format index and WorkBook.
+ * **This is not part of the public API and should not be called.**
+*/
+/*
+ * This constructor is just used from XML parsing, due to some dedupe
+ * errors. possibly errors in .xlsx too?
+*/
+protected constructor(book:io.starter.OpenXLS.WorkBook, xfnum:Int,
+dedupe:Boolean) : this(book, xfnum) {
+writeImmediate = dedupe
+}
+
+/**
+ * Constructs a dummy FormatHandle for the given conditional format. **This
+ * is not part of the public API and should not be called.**
+ *
+ *
+ * This unique flavor of FormatHandle is only used to display the formatting
+ * values of a Conditional format record.
+ *
+ *
+ * Creates a dummy Xf to store values, otherwise has no effect on the
+ * WorkBook record stream which are manipulated through CellHandle.
+ *
+ * @param book containing the conditional formats
+ * @param the index to the conditional format in the book collection
+*/
+constructor(cx:Condfmt, book:io.starter.OpenXLS.WorkBook,
+xfnum:Int, c:CellHandle?) {
+var c = c
+cx.formatHandle = this
+formatId = xfnum
+wbh = book
+workBook = book.workBook
+if (c == null)
+{
+// ok, this is a horrible hack, as its only correct if the top left
+// cell of the range has the same background format
+// as the cell a user is hitting. Lame, but i've been handed this at
+// the last moment and am patching things. weak effort guys.
+try
+{
+val rc = cx.encompassingRange
+c = CellHandle(cx.sheet!!.getCell(rc[0], rc[1]),
+book)
+}
+catch (e:Exception) {}
+
+}
+xf = duplicateXf(book.workBook.getXf(c!!.formatId))
+
+// set the format from the cf
+val lx = cx.rules
+val itx = lx.iterator()
+while (itx.hasNext())
+{
+val format = itx.next() as Cf
+this.updateFromCF(format, book)
+}
+}
+
+/**
+ * updates this format handle via a Cf rule
+ *
+ * @param cf Cf rule
+ * @param book workbook
+*/
+fun updateFromCF(cf:Cf, book:io.starter.OpenXLS.WorkBook) {
+// border colors
+val clr = cf.borderColors
+if (clr != null)
+borderColors = clr
+
+// line style
+val xs = cf.borderStyles
+if (xs != null)
+this.setBorderLineStyle(xs)
+
+/*
+ * // cf.getBorderSizes() int[] b = cf.getBorderSizes(); if(b!=null)
+ * setBorderLineStyle(b);
+*/
+// cf.getFont()
+val f = cf.getFont()
+if (f != null)
+font = f
+else
+this.fontHeight = 180 // why????????
+
+if (cf.fontItalic)
+this.italic = true
+
+if (cf.fontStriken)
+this.stricken = true
+
+val fsup = cf.fontEscapement
+// super/sub (0 = none, 1 = super, 2 = sub)
+if (fsup > -1)
+this.setScript(fsup)
+
+// handle underlines
+val us = cf.getFontUnderlineStyle()
+
+if (us > -1)
+{
+this.underlineStyle = us
+this.setUnderlined(true)
+}
+
+// number cf
+if (cf.formatPattern != null)
+formatPattern = cf.formatPattern
+
+if (cf.fill != null)
+{
+this.setFill(cf.fill)
+}
+else
+{
+val fill = cf.getPatternFillStyle() // Now -1 is a valid entry:
+if (fill > -1)
+{
+/* If the fill style is solid: When solid is specified, the
+foreground color (fgColor) is the only color rendered,
+even when a background color (bgColor) is also
+specified. */
+val bg = cf.getPatternFillColorBack()
+val fg = cf.getPatternFillColor()
+this.setFill(fill, fg, bg)
+}
+else
+{
+val fg = cf.foregroundColor
+if (fg > -1)
+foregroundColor = fg
+}
+}
+}
+
+/**
+ * Creates a FormatHandle for the given cell. **This is not part of the
+ * public API and should not be called.** Customers should use
+ * [CellHandle.getFormatHandle] instead.
+*/
+constructor(c:CellHandle) {
+workBook = c.cell!!.workBook
+if (c.cell!!.xfRec != null)
+{
+xf = c.cell!!.xfRec
+formatId = xf!!.idx // update the pointer - 20071010 KSC
+}
+else
+{ // ?? create new
+// 20090512 KSC: Shigeo NPE error formaterror646694, create new
+// rather than outputting warning
+// Logger.logWarn("No XF for cell " + c.toString());
+xf = workBook!!.getXf(c.cell!!.ixfe)
+formatId = xf!!.idx
+}
+// 20101201 KSC: only add to cache when adding xf's addToCache();
+}
+
+/**
+ * overrides the equals method to perform equality based on format
+ * properties ------------------------------------------------------------
+ *
+ * @param Object another - the FormatHandle to compare with this FormatHandle
+ * @return true if this FormatHandle equals another
+*/
+public override fun equals(another:Any?):Boolean {
+return another!!.toString() == toString()
+}
+
+/**
+ * remove borders for this format
+*/
+fun removeBorders() {
+val xf = cloneXf(this.xf!!)
+xf.removeBorders()
+updateXf(xf)
+}
+
+/**
+ * sets the border color for all borders (top, left, bottom and right) from
+ * an int array containing color constants
+ *
+ *
+ *
+ * NOTE: this setting will affect every cell which refers to this
+ * FormatHandle
+ *
+ * @param int[] bordercolors - 4-element array of desired border color
+ * constants [T, L, B, R]
+ * @see FormatHandle.COLOR_* constants
+*/
+fun setBorderColors(bordercolors:IntArray) {
+val xf = cloneXf(this.xf!!)
+xf.topBorderColor = bordercolors[0]
+xf.leftBorderColor = bordercolors[1]
+xf.bottomBorderColor = bordercolors[2]
+xf.setRightBorderColor(bordercolors[3])
+updateXf(xf)
+
+}
+
+/**
+ * set the border color for all borders (top, left, bottom, and right) to
+ * one color via color constant
+ *
+ *
+ *
+ * NOTE: this setting will affect every cell which refers to this
+ * FormatHandle
+ *
+ * @param int x - color constant which represents the color to set all
+ * border sides
+ * @see FormatHandle.COLOR_* constants
+*/
+fun setBorderColor(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.setRightBorderColor(x.toShort().toInt())
+xf.setLeftBorderColor(x.toShort())
+xf.topBorderColor = x.toShort()
+xf.bottomBorderColor = x.toShort()
+updateXf(xf)
+
+}
+
+/**
+ * set the border color for all borders (top, left, bottom, and right) to
+ * one java.awt.Color
+ *
+ *
+ * NOTE: this setting will affect every cell which refers to this
+ * FormatHandle
+ *
+ * @param Color col - color to set all border sides
+*/
+fun setBorderColor(col:Color) {
+val xf = cloneXf(this.xf!!)
+val x = getColorInt(col).toShort()
+xf.setRightBorderColor(x.toInt())
+xf.setLeftBorderColor(x)
+xf.topBorderColor = x
+xf.bottomBorderColor = x
+updateXf(xf)
+
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderRightColor(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.setRightBorderColor(x.toShort().toInt())
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderRightColor(x:Color) {
+val xf = cloneXf(this.xf!!)
+xf.setRightBorderColor(getColorInt(x).toShort().toInt())
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderLeftColor(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.setLeftBorderColor(x.toShort())
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderLeftColor(x:Color) {
+val xf = cloneXf(this.xf!!)
+xf.setLeftBorderColor(getColorInt(x).toShort())
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderTopColor(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.topBorderColor = x
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderTopColor(x:Color) {
+val xf = cloneXf(this.xf!!)
+xf.topBorderColor = getColorInt(x)
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderBottomColor(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.bottomBorderColor = x
+updateXf(xf)
+}
+
+/**
+ * Set the top border color
+ *
+ * @param color constant
+*/
+fun setBorderBottomColor(x:Color) {
+val xf = cloneXf(this.xf!!)
+xf.bottomBorderColor = getColorInt(x)
+updateXf(xf)
+}
+
+/**
+ * Sets the border line style using static BORDER_ shorts within
+ * FormatHandle
+ *
+ * @param line style constant
+*/
+fun setBorderLineStyle(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.setBorderLineStyle(x.toShort())
+updateXf(xf)
+}
+
+/**
+ * set border line styles via array of ints representing border styles
+ * order= left, right, top, bottom, [diagonal]
+ *
+ * @param b int[]
+*/
+fun setBorderLineStyle(b:IntArray) {
+xf!!.setAllBorderLineStyles(b)
+}
+
+/**
+ * Set the border line style
+ *
+ * @param line style constant
+*/
+fun setBorderLineStyle(x:Short) {
+val xf = cloneXf(this.xf!!)
+xf.setBorderLineStyle(x)
+updateXf(xf)
+}
+
+/**
+ * Set the border line style
+ *
+ * @param line style constant
+*/
+fun setBorderDiagonal(x:Int) {
+val xf = cloneXf(this.xf!!)
+xf.setBorderDiag(x)
+updateXf(xf)
+}
+
+/**
+ * Set a column handle on this format handle, so all changes applied to this
+ * format will be applied to the entire column
+ *
+ * @param c
+*/
+fun setColHandle(c:ColHandle) {
+mycol = c
+}
+
+/**
+ * Set a row handle on this format handle, so all changes applied to this
+ * format will be applied to the entire row
+ *
+ * @param c
+*/
+fun setRowHandle(c:RowHandle) {
+myrow = c
+}
+
+/**
+ * Create a copy of this FormatHandle with its own Xf
+ *
+ * @return the copied FormatHandle
+*/
+fun clone():Any {
+var ret:FormatHandle? = null
+if (wbh == null)
+{ // who knew???
+workBook = xf!!.workBook // Changed to myxf since myfont is no
+// longer
+ret = FormatHandle()
+ret!!.xf = xf
+ret!!.formatId = xf!!.idx
+ret!!.workBook = workBook
+}
+else
+{
+ret = FormatHandle(wbh, xf) // no need to duplicate it - just
+// use all formatting of
+// original xf
+}
+
+return ret
+}
+
+public override fun toString():String {
+return xf!!.toString()
+}
+
+constructor(book:io.starter.OpenXLS.WorkBook, fontname:String,
+fontstyle:Int, fontsize:Int) : this(book) {
+setFont(fontname, fontstyle, fontsize.toDouble())
+}
+
+/**
+ * Jan 27, 2011
+ *
+ * @param workBook
+ * @param i
+*/
+constructor(workBook:io.starter.OpenXLS.WorkBook, i:Int) : this(workBook.workBook, i) {
+wbh = workBook
+}
+
+/**
+ * Set new font to XF, handling duplication and caching ...
+ *
+ * @param Font f
+*/
+private fun setXFToFont(f:Font) {
+val fti = addFontIfNecessary(f)
+if (xf == null)
+{ // shouldn't!!
+xf = duplicateXf(null)
+xf!!.setFont(fti)
+}
+else if (xf!!.ifnt.toInt() != fti)
+{ // if not using font already,
+// duplicate xf and set to new font
+val xf = cloneXf(this.xf!!)
+xf.setFont(fti)
+updateXf(xf)
+}
+
+}
+
+/**
+ * Sets this format handle to a font
+ *
+ * @param fn font name e.g. 'Arial'
+ * @param stl font style either Font.PLAIN or Font.BOLD
+ * @param sz font size or height in 1/20 point units
+*/
+fun setFont(fn:String, stl:Int, sz:Double) {
+var stl = stl
+var sz = sz
+sz *= 20.0
+if (stl == 0)
+stl = 200
+if (stl == 1)
+stl = 700
+val f = Font(fn, stl, sz.toInt())
+setXFToFont(f)
+}
+
+/**
+ * add font to record streamer if cant find exact font already in there
+ *
+ * @param f
+ * @return
+*/
+private fun addFontIfNecessary(f:Font?):Int {
+if (workBook == null)
+{
+Logger.logErr("AddFontIfNecessary: workbook is null")
+return -1
+}
+var fti = workBook!!.getFontIdx(f)
+// don't use the built-ins.
+if (fti == 3)
+fti = 0 // use initial default font instead of last ...
+if (fti == -1)
+{ // font doesn't exist yet, add to streamer
+f!!.idx = -1 // flag to insert
+fti = workBook!!.insertFont(f) + 1
+}
+else
+f!!.idx = fti
+return fti
+}
+
+/**
+ * Adds a font internally to the workbook
+ *
+ * @param f
+ *
+ * private void addFont(Font f) {
+ *
+ * }
+*/
+
+/**
+ * Apply this Format to a Range of Cells
+ *
+ * @param CellRange to apply the format to
+*/
+fun addCellRange(cr:CellRange) {
+val crcells = cr.getCells()
+for (t in crcells!!.indices)
+{
+addCell(crcells!![t])
+}
+}
+
+/**
+ * Apply this Format to a Range of Cells
+ *
+ * @param CellHandle array to apply the format to
+*/
+fun addCellArray(crcells:Array) {
+for (t in crcells.indices)
+{
+addCell(crcells[t])
+}
+}
+
+/**
+ * add a Cell to this FormatHandle thus applying the Format to the Cell
+ *
+ * @param CellHandle to apply the format to
+*/
+fun addCell(c:CellHandle) {
+c.formatHandle = this
+}
+
+/**
+ * Add a List of Cells to this FormatHandle
+ *
+ * @param cx
+*/
+fun addCells(cx:List<*>) {
+val itx = cx.iterator()
+while (itx.hasNext())
+{
+addCell(itx.next() as BiffRec)
+mycells.add(itx.next())
+}
+}
+
+internal fun addCell(c:BiffRec) {
+if (xf != null)
+{
+c.setXFRecord(xf!!.idx)
+}
+else
+{
+Logger.logWarn("FormatHandle.addCell() - You MUST call setFont() to initialize the FormatHandle's font before adding Cells.")
+}
+mycells.add(c)
+}
+
+/**
+ * Applies the format to a cell without establishing a relationship. The
+ * format represented by this `FormatHandle` will be applied to
+ * the cell but it will not be updated with any future changes. If you want
+ * that behavior use [addCell][.addCell] instead.
+*/
+fun stamp(cell:CellHandle) {
+cell.formatId = formatId
+}
+
+/**
+ * Applies the format to a cell range without establishing a relationship.
+ * The format represented by this `FormatHandle` will be applied
+ * to the cells but they will not be updated with any future changes. If you
+ * want that behavior use [addCell][.addCell] instead.
+*/
+fun stamp(range:CellRange) {
+try
+{
+range.setFormatID(formatId)
+}
+catch (e:Exception) {
+// This can't actually happen
+}
+
+}
+
+/**
+ * set the Background Pattern for this Format
+ *
+ * @param int Excel color constant
+*/
+fun setBackgroundPattern(t:Int) {
+val xf = cloneXf(this.xf!!)
+// 20080103 KSC: handle solid (=filled) backgrounds, in which Excel
+// switches fg and bg colors (!!!)
+if (t != FormatConstants.PATTERN_FILLED)
+xf.setPattern(t)
+else
+{
+val bg = xf.backgroundColor.toInt()
+xf.setBackgroundSolid()
+xf.setForeColor(bg, null)
+}
+updateXf(xf)
+}
+
+/**
+ * super/sub (0 = none, 1 = super, 2 = sub)
+ *
+ * @param int script type for Format Font
+*/
+fun setScript(ss:Int) {
+var ss = ss
+if (ss > 2)
+ss = 2 // deal with invalid numbers
+if (ss < 0)
+ss = 0 // deal with invalid numbers
+xf!!.font!!.script = ss
+}
+
+/**
+ * set the Font Color for this Format via indexed color constant
+ *
+ * @param int Excel color constant
+*/
+fun setFontColor(t:Int) {
+val f = cloneFont(xf!!.font!!)
+f.color = t
+updateFont(f)
+}
+
+/**
+ * set the Font Color for this Format
+ *
+ * @param AWT Color color constant
+*/
+fun setFontColor(colr:Color) {
+val f = cloneFont(xf!!.font!!)
+f.setColor(colr)
+updateFont(f)
+}
+
+/**
+ * sets the Font color for this Format via web Hex String
+ *
+ * @param clr
+*/
+fun setFontColor(clr:String) {
+val f = cloneFont(xf!!.font!!)
+f.setColor(clr)
+updateFont(f)
+}
+
+/**
+ * set the foreground Color for this Format NOTE: Foreground color = the
+ * CELL BACKGROUND color color for all patterns and Background color= the
+ * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
+ * color=CELL BACKGROUND color and Background Color=64 (white).
+ *
+ * @param AWT Color constant
+*/
+fun setForegroundColor(colr:Color) {
+val xf = cloneXf(this.xf!!)
+val clrz = getColorInt(colr)
+xf.setForeColor(clrz, colr)
+updateXf(xf)
+}
+
+/**
+ * set the Cell Background Color for this Format
+ *
+ *
+ * NOTE: Foreground color = the CELL BACKGROUND color color for all patterns
+ * and Background color= the PATTERN color for all patterns != Solid For
+ * PATTERN_SOLID, Foreground color=CELL BACKGROUND color and Background
+ * Color=64 (white).
+ *
+ * @param awt Color color constant
+*/
+fun setCellBackgroundColor(colr:Color) {
+val clrz = getColorInt(colr)
+setCellBackgroundColor(clrz)
+
+}
+
+/**
+ * makes the cell a solid pattern background if no pattern was already
+ * present NOTE: Foreground color = the CELL BACKGROUND color color for all
+ * patterns and Background color= the PATTERN color for all patterns !=
+ * Solid For PATTERN_SOLID, Foreground color=CELL BACKGROUND color and
+ * Background Color=64 (white).
+ *
+ * @param int Excel color constant
+*/
+fun setCellBackgroundColor(t:Int) {
+val xf = cloneXf(this.xf!!)
+
+if (xf.fillPattern == 0)
+xf.setBackgroundSolid()
+
+if (xf.fillPattern == Xf.PATTERN_SOLID)
+xf.setForeColor(t, null)
+else
+xf.setBackColor(t, null)
+updateXf(xf)
+}
+
+/**
+ * sets this fill pattern from an existing OOXML (2007v) fill element
+ *
+ * @param f
+*/
+protected fun setFill(f:Fill?) {
+val xf = cloneXf(this.xf!!)
+xf.setFill(f!!)
+updateXf(xf)
+}
+
+/**
+ * sets the fill for this format handle if fill==Xf.PATTERN_SOLID then fg is
+ * the PATTERN color i.e the CELL BG COLOR
+ *
+ * @param fillpattern
+ * @param fg
+ * @param bg
+*/
+fun setFill(fillpattern:Int, fg:Int, bg:Int) {
+val xf = cloneXf(this.xf!!)
+
+xf.setPattern(fillpattern)
+
+/**
+ * If the fill style is solid: When solid is specified, the foreground
+ * color (fgColor) is the only color rendered, even when a background
+ * color (bgColor) is also specified.
+*/
+if (xf.fillPattern == Xf.PATTERN_SOLID)
+{ // is reversed
+xf.setForeColor(bg, null)
+xf.setBackColor(64, null)
+}
+else
+{
+/**
+ * or cell fills with patterns specified, then the cell fill color
+ * is specified by the bgColor element
+*/
+xf.setForeColor(fg, null)
+xf.setBackColor(bg, null)
+}
+updateXf(xf)
+}
+
+/**
+ * set the Background Color for this Format NOTE: Foreground color = the
+ * CELL BACKGROUND color color for all patterns and Background color= the
+ * PATTERN color for all patterns != Solid For PATTERN_SOLID, Foreground
+ * color=CELL BACKGROUND color and Background Color=64 (white).
+ *
+ * @param awt Color color constant
+*/
+fun setBackgroundColor(colr:Color) {
+val xf = cloneXf(this.xf!!)
+val clrz = getColorInt(colr)
+xf.setBackColor(clrz, colr)
+updateXf(xf)
+}
+
+/**
+ * Get if the font is underlined
+ *
+ * @return boolean representing if the formatted cell is underlined.
+*/
+fun getUnderlined():Boolean {
+if (xf!!.font == null)
+return underlined
+return xf!!.font!!.underlined
+}
+
+/**
+ * Set underline attribute on the font
+ *
+ * @param isUnderlined boolean representing if the formatted cell should be
+ * underlined
+*/
+fun setUnderlined(isUnderlined:Boolean) {
+val f = cloneFont(xf!!.font!!)
+f.underlined = isUnderlined
+updateFont(f)
+
+}
+
+fun setPattern(pat:Int) {
+val xf = cloneXf(this.xf!!)
+xf.setPattern(pat)
+updateXf(xf)
+}
+
+/**
+ * increase or decrease the precision of this numeric or curerncy format pattern
+ *
+val border = JSONObject()
+if (rightBorderLineStyle != 0)
+{
+val rBorder = JSONObject()
+rBorder.put("style",
+FormatConstants.BORDER_STYLES_JSON[rightBorderLineStyle])
+rBorder.put("color", colorToHexString(borderRightColor!!))
+border.put("right", rBorder)
+}
+if (bottomBorderLineStyle != 0)
+{
+val bBorder = JSONObject()
+bBorder.put("style",
+FormatConstants.BORDER_STYLES_JSON[bottomBorderLineStyle])
+bBorder.put("color", colorToHexString(borderBottomColor!!))
+border.put("bottom", bBorder)
+}
+if (leftBorderLineStyle != 0)
+{
+val lBorder = JSONObject()
+lBorder.put("style",
+FormatConstants.BORDER_STYLES_JSON[leftBorderLineStyle])
+lBorder.put("color", colorToHexString(borderLeftColor!!))
+border.put("left", lBorder)
+}
+if (topBorderLineStyle != 0)
+{
+val tBorder = JSONObject()
+tBorder.put("style",
+FormatConstants.BORDER_STYLES_JSON[topBorderLineStyle])
+tBorder.put("color", colorToHexString(borderTopColor!!))
+border.put("top", tBorder)
+}
+theStyle.put("borders", border)
+
+//
+val alignment = JSONObject()
+alignment.put("horizontal",
+FormatConstants.HORIZONTAL_ALIGNMENTS[horizontalAlignment])
+alignment.put("vertical",
+FormatConstants.VERTICAL_ALIGNMENTS[verticalAlignment])
+if (wrapText)
+{
+alignment.put("wrap", "1")
+}
+theStyle.put("alignment", alignment)
+
+if (indent != 0)
+{
+theStyle.put("indent", indent)
+}
+// colors + background patterns
+if (fillPattern >= 0)
+{ // KSC: added >= 0 as some conditional formats have patternFillStyle==0 even though they have a pattern block and
+val interior = JSONObject()
+// weird black/white case
+if (xf!!.foregroundColor.toInt() == 65)
+{
+interior.put("color", "#FFFFFF")
+}
+else
+{
+// KSC: use color string if it exists; create if doesn't
+interior.put("color", xf!!.foregroundColorHEX)
+}
+interior.put("pattern", xf!!.fillPattern)
+interior.put("fg", xf!!.foregroundColor.toInt()) // Excel-2003 Color Table index
+interior.put("patterncolor", xf!!.backgroundColorHEX)
+interior.put("bg", xf!!.backgroundColor.toInt()) // Excel-2003 Color Table index
+theStyle.put("interior", interior)
+}
+
+if (xf!!.ifmt.toInt() != 0)
+{ // only input user defined formats ...
+val nFormat = JSONObject()
+val fmtpat = formatPattern
+try
+{
+if (fmtpat != "General")
+{
+nFormat.put("format", fmtpat) // convertXMLChars?
+nFormat.put("formatid", xf!!.ifmt.toInt())
+if (isDate)
+nFormat.put("isdate", "1")
+if (isCurrency)
+nFormat.put("iscurrency", "1")
+if (isRedWhenNegative)
+nFormat.put("isrednegative", "1")
+}
+
+}
+catch (e:Exception) { // it's possible that getFormatPattern
+// returns null
+}
+
+theStyle.put("numberformat", nFormat)
+}
+//
+val protection = JSONObject()
+try
+{
+if (this.xf!!.isLocked)
+protection.put("Protected", true)
+if (this.xf!!.isFormulaHidden)
+protection.put("HideFormula", true)
+}
+catch (e:Exception) {}
+
+theStyle.put("protection", protection)
+
+}
+catch (e:JSONException) {
+Logger.logErr("Error getting cellRange JSON: " + e)
+}
+
+return theStyle
+}
+
+/**
+ * Returns an XML fragment representing the FormatHandle
+ *
+ * @param convertToUnicodeFont if true, font family will be changed to ArialUnicodeMS
+ * (standard unicode) for non-ascii fonts
+*/
+@JvmOverloads fun getXML(XFNum:Int, convertToUnicodeFont:Boolean = false):String {
+val myf = font
+// ")
+return sb.toString()
+}
+
+/**
+ * creates a new font based on an existing one, adds to workbook recs
+*/
+private fun createNewFont(f:Font):Font {
+f.idx = -1 // flag to insert anew (see Font.setWorkBook)
+workBook!!.insertFont(f)
+f.workBook = workBook
+return f
+}
+
+/**
+ * create a new font based on existing font - does not add to workbook recs
+ *
+ * @param src font
+ * @return cloned font
+*/
+private fun cloneFont(src:Font):Font {
+val f = Font()
+f.opcode = io.starter.formats.XLS.XLSConstants.FONT
+f.setData(src.bytes) // use default font as basis of new font
+f.idx = -2 // avoid adding to fonts array when call setW.b. below
+f.workBook = this.workBook
+f.init()
+return f
+}
+
+/**
+ * update the font for this FormatHandle, including updating the xf if
+ * necessary
+ *
+ * @param f
+*/
+private fun updateFont(f:Font) {
+var f = f
+val idx = workBook!!.getFontIdx(f)
+if (idx == -1)
+{ // can't find it so add new
+f = createNewFont(f)
+}
+else
+f = workBook!!.getFont(idx)
+if (f.idx != xf!!.ifnt.toInt())
+{ // then updated the font, must create new xf to link to
+val xf = cloneXf(this.xf!!)
+xf.setFont(f.idx)
+updateXf(xf)
+}
+}
+
+/**
+ * Create or Duplicate Xf rec so can alter (pattern, font, colrs ...)
+ *
+ * @param xf xf to base off of, or null (will create new)
+ * @return new Xf
+*/
+private fun duplicateXf(xf:Xf?):Xf {
+var xf = xf
+var fidx = 0
+if (xf != null)
+fidx = xf!!.font!!.idx
+xf = Xf.updateXf(xf, fidx, workBook) // clones/creates new based upon
+// original
+formatId = xf!!.idx // update the pointer
+// not used anymore canModify = true; // if duplicated, it's new and unlinked (thus far)
+return xf
+}
+
+/**
+ * adds all formatting represented by the sourceXf to this workbook, if not
+ * already present
+val currencyFormatMap:Map
+val dateFormatMap:Map
+
+init{
+val formats = HashMap()
+for (formatArr in FormatConstants.NUMERIC_FORMATS)
+{
+if (formatArr.size == 3)
+{
+formats.put(formatArr[0].toLowerCase(), formatArr[2])
+}
+}
+numericFormatMap = Collections.unmodifiableMap(formats)
+
+formats = HashMap()
+for (formatArr in FormatConstants.CURRENCY_FORMATS)
+{
+if (formatArr.size == 3)
+{
+formats.put(formatArr[0].toLowerCase(), formatArr[2])
+}
+}
+currencyFormatMap = Collections.unmodifiableMap(formats)
+
+formats = HashMap()
+for (formatArr in FormatConstants.DATE_FORMATS)
+{
+if (formatArr.size == 3)
+{
+formats.put(formatArr[0].toLowerCase(), formatArr[2])
+}
+else
+{
+// only 2 elements in date format string array: pattern and hex id
+formats.put(formatArr[0].toLowerCase(), formatArr[0])
+}
+}
+dateFormatMap = Collections.unmodifiableMap(formats)
+}
+
+/**
+ * converts an Excel-style format string to a Java Format string.
+ *
+ * @param String pattern - Excel Format String
+ * @return String that can be used with the Java Format classes.
+ * @see getJavaFormatString
+*/
+fun convertFormatString(pattern:String):String? {
+var ret:String? = numericFormatMap.get(pattern)
+if (ret != null)
+return ret
+ret = currencyFormatMap.get(pattern)
+if (ret != null)
+return ret
+ret = dateFormatMap.get(pattern)
+return ret
+}
+
+/**
+ * adds a font to the global font store only if exact font is not already
+ * present
+ *
+ * @param f Font
+ * @param bk WorkBookHandle
+*/
+fun addFont(f:Font, bk:WorkBookHandle?):Int {
+if (bk == null)
+{
+Logger.logErr("addFont: workbook is null")
+}
+var fti = bk!!.workBook!!.getFontIdx(f)
+// if (fti > 3) {// don't use the built-ins.
+if (fti == 3)
+fti = 0 // use initial default font instead of last ... 20070827
+// KSC
+if (fti == -1)
+{ // font doesn't exist yet, add to streamer
+f.idx = -1 // flag to insert
+fti = bk!!.workBook!!.insertFont(f) + 1
+}
+else
+f.idx = fti
+return fti
+}
+
+/**
+ * returns the index of the Color within the Colortable
+ *
+ * @param the index of the color in the colortable
+ * @return the color
+*/
+fun getColor(col:Int):Color {
+if (col > -1 && col < FormatHandle.COLORTABLE.size)
+return FormatHandle.COLORTABLE[col]
+return FormatHandle.COLORTABLE[0]
+}
+
+/**
+ * returns the index of the Color within the Colortable
+ *
+ * @param col the color
+ * @return the index of the color in the colortable
+*/
+fun getColorInt(col:Color):Int {
+for (i in FormatHandle.COLORTABLE.indices)
+{
+if (col == FormatHandle.COLORTABLE[i])
+{
+return i
+}
+}
+val R = col.getRed()
+val G = col.getGreen()
+val B = col.getBlue()
+var colorMatch = -1
+var colorDiff = Integer.MAX_VALUE.toDouble()
+for (i in FormatHandle.COLORTABLE.indices)
+{
+val curDif = (Math.pow((R - FormatHandle.COLORTABLE[i].getRed()).toDouble(), 2.0)
++ Math.pow((G - FormatHandle.COLORTABLE[i].getGreen()).toDouble(), 2.0)
++ Math.pow((B - FormatHandle.COLORTABLE[i].getBlue()).toDouble(), 2.0))
+if (curDif < colorDiff)
+{
+colorDiff = curDif
+colorMatch = i
+}
+}
+return colorMatch
+}
+
+/**
+ * Convert a java.awt.Color to a hex string.
+ *
+ * @return String representation of a Color
+*/
+fun colorToHexString(c:Color):String {
+val r = c.getRed()
+val g = c.getGreen()
+val b = c.getBlue()
+var rh = Integer.toHexString(r)
+if (rh.length < 2)
+{
+rh = "0" + rh
+}
+var gh = Integer.toHexString(g)
+if (gh.length < 2)
+{
+gh = "0" + gh
+}
+var bh = Integer.toHexString(b)
+if (bh.length < 2)
+{
+bh = "0" + bh
+}
+return ("#" + rh + gh + bh).toUpperCase()
+}
+
+
+var colorFONT:Short = 0
+var colorBACKGROUND:Short = 1
+var colorFOREGROUND:Short = 2
+var colorBORDER:Short = 3
+
+/**
+ * convert hex string RGB to Excel colortable int format if an exact match
+ * is not find, does color-matching to try and obtain closest match
+ *
+ * @param s
+ * @param colorType
+ * @return
+*/
+fun HexStringToColorInt(s:String, colorType:Short):Int {
+var s = s
+if (s.length > 7)
+s = "#" + s.substring(s.length - 6)
+if (s.indexOf("#") == -1)
+s = "#" + s
+if (s.length == 7)
+{
+val rs = s.substring(1, 3)
+val r = Integer.parseInt(rs, 16)
+val gs = s.substring(3, 5)
+val g = Integer.parseInt(gs, 16)
+val bs = s.substring(5, 7)
+val b = Integer.parseInt(bs, 16)
+// Handle exceptions for black, white and color indexes 9 (see
+// FormatConstants for more info)
+
+if (r == 255 && r == g && r == b)
+{
+if (colorType == colorFONT)
+return 9
+}
+
+val c = Color(r, g, b)
+return getColorInt(c)
+}
+return 0
+}
+
+/**
+ * convert hex string RGB to Excel colortable int format if no exact match
+ * is found returns -1
+ *
+ * @param s HTML color string (#XXXXXX) format or (#FFXXXXXX - OOXML-style
+ * format)
+ * @param colorType
+ * @return index into color table or -1 if not found
+*/
+fun HexStringToColorIntExact(s:String, colorType:Short):Int {
+var s = s
+if (s.length > 7)
+s = "#" + s.substring(s.length - 6)
+if (s.indexOf("#") == -1)
+s = "#" + s
+if (s.length == 7)
+{
+val rs = s.substring(1, 3)
+val r = Integer.parseInt(rs, 16)
+val gs = s.substring(3, 5)
+val g = Integer.parseInt(gs, 16)
+val bs = s.substring(5, 7)
+val b = Integer.parseInt(bs, 16)
+
+// Handle exceptions for black, white and color indexes 9 (see
+// FormatConstants for more info)
+if (r == 255 && r == g && r == b)
+{
+if (colorType == colorFONT)
+return 9
+}
+
+val c = Color(r, g, b)
+for (i in FormatHandle.COLORTABLE.indices)
+{
+if (c == FormatHandle.COLORTABLE[i])
+{
+return i
+}
+}
+}
+return -1 // match NOT FOUND
+}
+
+/**
+ * convert hex string RGB to a Color
+ *
+ * @param s web-style hex color string, including #, or OOXML-style color string, FFXXXXXX
+ * @return Color
+ * @see Color
+*/
+fun HexStringToColor(s:String):Color {
+var s = s
+if (s.length > 7)
+{ // transform OOXML-style color strings to Web-style
+s = "#" + s.substring(s.length - 6)
+}
+var c:Color? = null
+if (s.length == 7)
+{
+val rs = s.substring(1, 3)
+val r = Integer.parseInt(rs, 16)
+val gs = s.substring(3, 5)
+val g = Integer.parseInt(gs, 16)
+val bs = s.substring(5, 7)
+val b = Integer.parseInt(bs, 16)
+c = Color(r, g, b)
+}
+else
+c = Color(0, 0, 0) // default to black?
+return c
+}
+
+/**
+ * interpret color table special entries
+ *
+ * @param clr color index in range of 0x41-0x4F (charts) 0x40 ...
+ * @return index into color table
+*/
+fun interpretSpecialColorIndex(clr:Int):Short {
+when (clr) {
+0x0041 // Default background color. This is the window background
+,
+// color in the sheet display and is the default
+// background color for a cell.
+0x004E // Default chart background color. This is the window
+,
+// background color in the chart display.
+0x0050 // WHAT IS THIS ONE????????
+-> return FormatConstants.COLOR_WHITE.toShort()
+0x0040 // Default foreground color
+, 0x004F // Chart neutral color which is black, an RGB value of
+,
+// (0,0,0).
+0x004D // Default chart foreground color. This is the window text
+,
+// color in the chart display.
+0x0051 // ToolTip text color. This is the automatic font color for
+,
+// comments.
+0x7FFF // Font automatic color. This is the window text color
+-> return FormatConstants.COLOR_BLACK.toShort()
+else // 67(=0x43) ???
+-> return FormatConstants.COLOR_WHITE.toShort()
+}
+
+/*
+ * switch (icvFore) { case 0x40: // default fg color return
+ * FormatConstants.COLOR_WHITE; case 0x41: // default bg color return
+ * FormatConstants.COLOR_WHITE; case 0x4D: // default CHART fg color --
+ * INDEX SPECIFIC! return -1; // flag to map via series (bar) color
+ * defaults case 0x4E: // default CHART fg color return icvFore; case
+ * 0x4F: // chart neutral color == black return
+ * FormatConstants.COLOR_BLACK; }
+ *
+ * switch (icvBack) { case 0x40: // default fg color return
+ * FormatConstants.COLOR_WHITE; case 0x41: // default bg color return
+ * FormatConstants.COLOR_WHITE; case 0x4D: // default CHART fg color --
+ * INDEX SPECIFIC! return -1; // flag to map via series (bar) color
+ * defaults case 0x4E: // default CHART bg color //return
+ * FormatConstants.COLOR_WHITE; // is this correct? return icvBack; case
+ * 0x4F: // chart neutral color == black return
+ * FormatConstants.COLOR_BLACK; }
+*/
+}
+
+fun BorderStringToInt(s:String):Int {
+for (i in FormatConstants.BORDER_NAMES.indices)
+{
+if (FormatConstants.BORDER_NAMES[i] == s)
+return i
+}
+return 0
+}
+
+/**
+ * static version of cloneXf
+ *
+ * @param xf
+ * @param wkbook
+ * @return
+*/
+fun cloneXf(xf:Xf, wkbook:io.starter.formats.XLS.WorkBook):Xf {
+val clone = Xf(xf.font!!.idx, wkbook)
+val data = xf.getBytesAt(0, xf.length - 4)
+clone.setData(data)
+clone.init()
+return clone
+}
+
+/**
+ * static version of cloneXf
+ *
+ * @param xf
+ * @param wkbook
+ * @return
+*/
+fun cloneXf(xf:Xf, f:Font,
+wkbook:io.starter.formats.XLS.WorkBook):Xf {
+val clone = Xf(f, wkbook)
+val data = xf.getBytesAt(0, xf.length - 4)
+clone.setData(data)
+clone.setFont(f.idx) // font idx is overwritten by xf data; must reset
+clone.init()
+return clone
+}
+}
+}/**
+ * Returns an XML fragment representing the FormatHandle
+ */
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/FormulaHandle.java b/src/main/java/io/starter/OpenXLS/FormulaHandle.java
deleted file mode 100644
index 4a662f9..0000000
--- a/src/main/java/io/starter/OpenXLS/FormulaHandle.java
+++ /dev/null
@@ -1,532 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- * dx = form.getPtgsByLocation(formulaLoc);
- Iterator lx=dx.iterator();
- while(lx.hasNext()){
- try{
- Ptg thisptg = (Ptg)lx.next();
- ReferenceTracker.updateAddressPerPolicy(thisptg, newaddr);
- form.setCachedValue(null); // flag to recalculate
- return true;
- }catch(Exception e){
- Logger.logInfo("updating Formula reference failed:" + e.toString());
- return false;
- }
- }
- return true;
- }
-
- /** Changes a range in a formula to expand until it includes the
- cell address from CellHandle.
-
- Example:
-
- CellHandle cell = new Cellhandle("D4") Formula = SUM(A1:B2)
- addCellToRange("A1:B2",cell); would change the formula to look like"SUM(A1:D4)"
-
- Returns false if formula does not contain the formulaLoc range.
-
- @param String - the Cell Range as a String to add the Cell to
- @param CellHandle - the CellHandle to add to the range
- */
- public boolean addCellToRange(String formulaLoc, CellHandle handle)
- throws FormulaNotFoundException{
- List dx = form.getPtgsByLocation(formulaLoc);
- Iterator lx=dx.iterator();
- boolean b=false;
- while(lx.hasNext()){
- Ptg ptg = (Ptg)lx.next();
- if (ptg == null)return false;
- int[] formulaaddr = ExcelTools.getRangeRowCol(formulaLoc);
- String handleaddr = handle.getCellAddress();
- int[] celladdr = ExcelTools.getRowColFromString(handleaddr);
-
- // check existing range and set new range vals if the new Cell is outside
- if(celladdr[0] > formulaaddr[2])formulaaddr[2] = celladdr[0];
- if(celladdr[0] < formulaaddr[0])formulaaddr[0] = celladdr[0];
- if(celladdr[1] > formulaaddr[3])formulaaddr[3] = celladdr[1];
- if(celladdr[1] < formulaaddr[1])formulaaddr[1] = celladdr[1];
- String newaddr = ExcelTools.formatRange(formulaaddr);
- b = this.changeFormulaLocation(formulaLoc, newaddr);
-
- }
- return b;
- }
-
- /** Copy the formula references with offsets
- *
- * @param int[row,col] offsets to move the references
- * @return
- *
- */
- public static void moveCellRefs(FormulaHandle fmh, int[] offsets) throws FormulaNotFoundException {
- // get the current offsets from the FMH references
- String [] celladdys = fmh.getRanges();
-
- // iterate
- for(int x=0;x-1) { // separate out addresses within a range
- secondAddress= range.substring(rangeIdx+1);
- range= range.substring(0, rangeIdx);
- }
- int[] orig = ExcelTools.getRowColFromString(range);
- boolean relCol= !(range.startsWith("$")); // 20100603 KSC: handle relative refs
- boolean relRow= !(range.length()>0 && range.substring(1).indexOf('$')>-1);
- if (relRow) // only move if relative ref
- orig[0] += offsets[0]; //row
- if (relCol)// only move if relative ref
- orig[1]+= offsets[1]; //col
- String newAddress= ExcelTools.formatLocation(orig, relRow, relCol);
- if(orig[0]<0||orig[1]<0)newAddress="#REF!";
- if (secondAddress!=null) {
- orig = ExcelTools.getRowColFromString(secondAddress);
- relCol= !(secondAddress.startsWith("$")); // handle relative refs
- relRow= !(secondAddress.length()>0 && secondAddress.substring(1).indexOf('$')>-1);
- if (orig[0]>=0) {
- if (relRow) // only move if relative ref
- orig[0] += offsets[0]; //row
- }
- if (orig[1]>=0) { //if not wholerow/wholecol ref
- if (relCol)// only move if relative ref
- orig[1]+= offsets[1]; //col
- }
- String newAddress1 = ExcelTools.formatLocation(orig, relRow, relCol);
- newAddress= newAddress + ":" + newAddress1;
- }
- if (sh!=null) // TODO: handle refs with multiple sheets
- newAddress= sh + "!" + newAddress;
- if(! fmh.changeFormulaLocation(celladdys[x], newAddress)){
- Logger.logErr("Could not change Formula Reference: " + celladdys[x] +" to: " + newAddress);
- }
- }
- return;
- }
-
-
- public String toString()
- {
- return this.form.getCellAddress() + ":" + this.form.getFormulaString();
- }
-
- /**
- * return truth of "this formula is shared"
- * @return boolean
- */
- public boolean isSharedFormula() { return this.form.isSharedFormula(); }
-
- public boolean isArrayFormula() { return form.isArrayFormula(); }
- // 20090120 KSC: should be detected auto public void setIsArrayFormula(boolean b) { form.setIsArrayFormula(b); }
-
- /**
- * returns the low-level formula rec for this Formulahandle
- *
- *
- * @return
- */
- public Formula getFormulaRec() {
- return form;
- }
-
- /**
- * Utility method to determine if the calculation works out to an error value.
- *
- * The excel values that will cause this to be true are
- * #VALUE!, #N/A, #REF!, #DIV/0!, #NUM!, #NAME?, #NULL!
-
- *
- * @return
- */
- public boolean isErrorValue() {
- return (form.calculateFormula() instanceof CalculationException);
- }
-
- /**
- * return the "Calculate Always" setting for this formula
- * used for formulas that always need calculating such as TODAY
- * @return
- */
- public boolean getCalcAlways() {
- return form.getCalcAlways();
- }
-
- /**
- * set the "Calculate Always setting for this formula
- * used for formulas that always need calculating such as TODAY
- * @param fAlwaysCalc
- */
- public void setCalcAlways(boolean fAlwaysCalc) {
- form.setCalcAlways(fAlwaysCalc);
- }
-
- /**
- * generate the OOXML necessary to describe this formula
- * OOXML element
- * @return
- */
- // TODO: Deal with External References ... dataTables
- // common possible attributes:
- // aca= always calculate array, bx=name to assign formula to, ca=calculate cell, r1=data table cell1,
- // t=formula type shared, array, dataTable or normal=default
- public String getOOXML() {
- StringBuffer ooxml= new StringBuffer();
- // must have type of formula result
- Object val;
- try {
- val= this.getVal();
- if (val==null) {// means cache was cleared (in all cases???) MUST recalc
- if(this.form.getWorkBook().getCalcMode() != WorkBookHandle.CALCULATE_EXPLICIT) {
- this.calculate();
- val= this.getVal();
- } else {
- val = new CalculationException(CalculationException.VALUE );
- }
- } else if (val instanceof String && ((String) val).startsWith("#"))
- val= new CalculationException(CalculationException.getErrorCode((String)val));
- } catch (Exception e) {
- val = new CalculationException(CalculationException.VALUE );
- }
- if (val==null) {
- Logger.logErr("FormulaHandle.getOOXML: unexpected null encountered when calculating formula: " + this.getCellAddress());
- }
- // Handle attributes for special cached values
- if (val instanceof String) {
- ooxml.append(" t=\"str\"");
- val= OOXMLAdapter.stripNonAscii((String) val); // TODO: how can we strip non-ascii? What about Japanese cell text? ans: has to be XML-compliant is all ...
- } else if (val instanceof Boolean) {
- ooxml.append(" t=\"b\"");
- if (((Boolean)val).booleanValue()) val= "1";
- else val= "0";
- } else if (val instanceof Double) {
- ooxml.append(" t=\"n\"");
- } else if (val instanceof CalculationException) {
- ooxml.append(" t=\"e\"");
- }
-
- String fs= "=";
- try {
- fs= this.getFormulaString();
- } catch (Exception e) {
- Logger.logErr("FormulaHandle.getOOXML: error obtaining formula string: " + e.toString());
- }
- fs= OOXMLAdapter.stripNonAscii(fs).toString(); // handle non-standard xml chars -- ummm what about Japanese? -- it's all ok
- if (!this.isArrayFormula()) {
- ooxml.append(">"); // only output value info
- }
- }
- if (this.isSharedFormula()) {
- // TODO: FINISH 00XML SHARED FORMULAS
- // TODO: need si= shared formula index; when referencing (after shared formula is defined) don't need to include "fs" just the si= ****
- try {
- // 20091022 KSC: Shared Formulas do not work 2003->2007
- //ooxml.append(" t=\"shared\" ref=\"" + this.getFormulaRec().getSharedFormula().getCellRange() + "\"");
- } catch (Exception e) { }
- }
- if (this.getCalcAlways()) ooxml.append(" ca=\"1\"");
- if (fs!=null) // can happen if not a parent array formula
- ooxml.append(">" + fs + " ");
- ooxml.append("" + val + " ");
- return ooxml.toString();
- }
-}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/FormulaHandle.kt b/src/main/java/io/starter/OpenXLS/FormulaHandle.kt
new file mode 100644
index 0000000..a8d656a
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/FormulaHandle.kt
@@ -0,0 +1,569 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ *
+ @Throws(FormulaNotFoundException::class)
+ get() {
+ val locptgs = formulaRec!!.cellRangePtgs
+ val ret = arrayOfNulls(locptgs.size)
+ for (x in locptgs.indices) {
+ try {
+ ret[x] = (locptgs[x] as PtgRef).locationWithSheet
+ } catch (e: Exception) {
+ if (locptgs[x] is PtgName) {
+ ret[x] = locptgs[x].location
+ } else
+ ret[x] = locptgs[x].textString
+ }
+
+ }
+ return ret
+ }
+
+ /**
+ * Initialize CellRanges referenced by this formula
+ *
+ * @return
+ * @throws FormulaNotFoundException
+ */
+ //
+ val cellRanges: Array
+ @Throws(FormulaNotFoundException::class)
+ get() {
+ val crstrs = this.ranges
+ val crs = arrayOfNulls(crstrs.size)
+ for (x in crs.indices) {
+ crs[x] = CellRange(crstrs[x], bk, true)
+ try {
+ crs[x].init()
+ } catch (e: Exception) {
+ }
+
+ }
+ return crs
+ }
+
+ /**
+ * return truth of "this formula is shared"
+ *
+ * @return boolean
+ */
+ val isSharedFormula: Boolean
+ get() = this.formulaRec!!.isSharedFormula
+
+ val isArrayFormula: Boolean
+ get() = formulaRec!!.isArrayFormula
+
+ /**
+ * Utility method to determine if the calculation works out to an error value.
+ *
+ *
+ * The excel values that will cause this to be true are
+ * #VALUE!, #N/A, #REF!, #DIV/0!, #NUM!, #NAME?, #NULL!
+ *
+ * @return
+ */
+ val isErrorValue: Boolean
+ get() = formulaRec!!.calculateFormula() is CalculationException
+
+ /**
+ * return the "Calculate Always" setting for this formula
+ * used for formulas that always need calculating such as TODAY
+ *
+ * @return
+ */
+ /**
+ * set the "Calculate Always setting for this formula
+ * used for formulas that always need calculating such as TODAY
+ *
+ * @param fAlwaysCalc
+ */
+ var calcAlways: Boolean
+ get() = formulaRec!!.calcAlways
+ set(fAlwaysCalc) {
+ formulaRec!!.calcAlways = fAlwaysCalc
+ }
+
+ /**
+ * generate the OOXML necessary to describe this formula
+ * OOXML element
+ *
+ * @return
+ */
+ // TODO: Deal with External References ... dataTables
+ // common possible attributes:
+ // aca= always calculate array, bx=name to assign formula to, ca=calculate cell, r1=data table cell1,
+ // t=formula type shared, array, dataTable or normal=default
+ // must have type of formula result
+ // means cache was cleared (in all cases???) MUST recalc
+ // Handle attributes for special cached values
+ // TODO: how can we strip non-ascii? What about Japanese cell text? ans: has to be XML-compliant is all ...
+ // handle non-standard xml chars -- ummm what about Japanese? -- it's all ok
+ // ignore =
+ // array formulas
+ // it's the parent
+ // remove "{= }"
+ // it's part of a multi-cell array formula therefore DO NOT add array info here
+ // only output value info
+ // TODO: FINISH 00XML SHARED FORMULAS
+ // TODO: need si= shared formula index; when referencing (after shared formula is defined) don't need to include "fs" just the si= ****
+ // 20091022 KSC: Shared Formulas do not work 2003->2007
+ //ooxml.append(" t=\"shared\" ref=\"" + this.getFormulaRec().getSharedFormula().getCellRange() + "\"");
+ // can happen if not a parent array formula
+ val ooxml: String
+ get() {
+ val ooxml = StringBuffer()
+ var `val`: Any?
+ try {
+ `val` = this.`val`
+ if (`val` == null) {
+ if (this.formulaRec!!.workBook!!.calcMode != WorkBookHandle.CALCULATE_EXPLICIT) {
+ this.calculate()
+ `val` = this.`val`
+ } else {
+ `val` = CalculationException(CalculationException.VALUE)
+ }
+ } else if (`val` is String && `val`.startsWith("#"))
+ `val` = CalculationException(CalculationException.getErrorCode(`val` as String?))
+ } catch (e: Exception) {
+ `val` = CalculationException(CalculationException.VALUE)
+ }
+
+ if (`val` == null) {
+ Logger.logErr("FormulaHandle.getOOXML: unexpected null encountered when calculating formula: " + this.cellAddress)
+ }
+ if (`val` is String) {
+ ooxml.append(" t=\"str\"")
+ `val` = OOXMLAdapter.stripNonAscii(`val` as String?)
+ } else if (`val` is Boolean) {
+ ooxml.append(" t=\"b\"")
+ if (`val`.booleanValue())
+ `val` = "1"
+ else
+ `val` = "0"
+ } else if (`val` is Double) {
+ ooxml.append(" t=\"n\"")
+ } else if (`val` is CalculationException) {
+ ooxml.append(" t=\"e\"")
+ }
+
+ var fs: String? = "="
+ try {
+ fs = this.formulaString
+ } catch (e: Exception) {
+ Logger.logErr("FormulaHandle.getOOXML: error obtaining formula string: $e")
+ }
+
+ fs = OOXMLAdapter.stripNonAscii(fs).toString()
+ if (!this.isArrayFormula) {
+ ooxml.append(">")
+ }
+ }
+ if (this.isSharedFormula) {
+ try {
+ } catch (e: Exception) {
+ }
+
+ }
+ if (this.calcAlways) ooxml.append(" ca=\"1\"")
+ if (fs != null)
+ ooxml.append(">$fs")
+ ooxml.append("$`val` ")
+ return ooxml.toString()
+ }
+
+ /**
+ * Sets the location lock on the Cell Reference at the
+ * specified location
+ *
+ *
+ * Used to prevent updating of the Cell Reference when
+ * Cells are moved.
+ *
+ * @param location of the Cell Reference to be locked/unlocked
+ * @param lock status setting
+ * @return boolean whether the Cell Reference was found and modified
+ */
+ fun setLocationLocked(loc: String, l: Boolean): Boolean {
+ var x = Ptg.PTG_LOCATION_POLICY_UNLOCKED
+ if (l) x = Ptg.PTG_LOCATION_POLICY_LOCKED
+ return formulaRec!!.setLocationPolicy(loc, x)
+ }
+
+ /**
+ * Sets the location lock on the Cell Reference at the
+ * specified location
+ *
+ *
+ * Used to prevent updating of the Cell Reference when
+ * Cells are moved.
+ *
+ * @param location of the Cell Reference to be locked/unlocked
+ * @param lock status setting
+ * @return boolean whether the Cell Reference was found and modified
+ */
+ fun setLocationPolicy(loc: String, l: Int): Boolean {
+ return formulaRec!!.setLocationPolicy(loc, l)
+ }
+
+ init {
+ formulaRec = f
+ }
+
+ /** Return the cached value of the Formula.
+ *
+ * This method returns the value as cached by OpenXLS or Excel of the formula. Please note
+ * that cases could exist where a cached value does not exist. In this case getCachedVal will not try and calculate
+ * the formula, it will return null.
+ *
+ * @return Object - cached value of the Formula as a String or a Double dependent on data type.
+ *
+ * public Object getCachedVal() {
+ * return form.getCachedVal();
+ * }
+ */
+
+
+ /**
+ * Calculate the value of the formula and return it as an object
+ *
+ *
+ * Calling calculate will ignore the WorkBook formula calculation flags
+ * and forces calculation of the entire formula stack
+ */
+ @Throws(FunctionNotSupportedException::class)
+ fun calculate(): Any? {
+ formulaRec!!.clearCachedValue()
+
+ return sanitizeValue(formulaRec!!.calculate())
+ }
+
+
+ /**
+ * Sets the formula to a string passed in excel formula format.
+ *
+ * @param formulaString - String formatted as an excel formula, like Sum(A3+4)
+ */
+
+ @Throws(FunctionNotSupportedException::class)
+ fun setFormula(formulaString: String) {
+ formulaRec = FormulaParser.setFormula(formulaRec, formulaString, intArrayOf(formulaRec!!.rowNumber, formulaRec!!.colNumber.toInt()))
+ }
+
+ /**
+ * If the Formula evaluates to a String, there
+ * will be a Stringrec attached to the Formula
+ * which contains the latest value.
+ *
+ * @return boolean whether this Formula evaluates to a String
+ */
+ fun evaluatesToString(): Boolean {
+ return formulaRec!!.calculateFormula() is String
+ }
+
+ /**
+ * Takes a string as a current formula location, and changes
+ * that pointer in the formula to the new string that is sent.
+ * This can take single cells"A5" and cell ranges,"A3:d4"
+ * Returns true if the cell range specified in formulaLoc exists & can be changed
+ * else false. This also cannot change a cell pointer to a cell range or vice
+ * versa.
+ *
+ * @param String - range of Cells within Formula to modify
+ * @param String - new range of Cells within Formula
+ */
+ @Throws(FormulaNotFoundException::class)
+ fun changeFormulaLocation(formulaLoc: String, newaddr: String): Boolean {
+ val dx = formulaRec!!.getPtgsByLocation(formulaLoc)
+ val lx = dx.iterator()
+ while (lx.hasNext()) {
+ try {
+ val thisptg = lx.next() as Ptg
+ ReferenceTracker.updateAddressPerPolicy(thisptg, newaddr)
+ formulaRec!!.setCachedValue(null) // flag to recalculate
+ return true
+ } catch (e: Exception) {
+ Logger.logInfo("updating Formula reference failed:$e")
+ return false
+ }
+
+ }
+ return true
+ }
+
+ /**
+ * Changes a range in a formula to expand until it includes the
+ * cell address from CellHandle.
+ *
+ *
+ * Example:
+ *
+ *
+ * CellHandle cell = new Cellhandle("D4") Formula = SUM(A1:B2)
+ * addCellToRange("A1:B2",cell); would change the formula to look like"SUM(A1:D4)"
+ *
+ *
+ * Returns false if formula does not contain the formulaLoc range.
+ *
+ * @param String - the Cell Range as a String to add the Cell to
+ * @param CellHandle - the CellHandle to add to the range
+ */
+ @Throws(FormulaNotFoundException::class)
+ fun addCellToRange(formulaLoc: String, handle: CellHandle): Boolean {
+ val dx = formulaRec!!.getPtgsByLocation(formulaLoc)
+ val lx = dx.iterator()
+ var b = false
+ while (lx.hasNext()) {
+ val ptg = lx.next() as Ptg ?: return false
+ val formulaaddr = ExcelTools.getRangeRowCol(formulaLoc)
+ val handleaddr = handle.cellAddress
+ val celladdr = ExcelTools.getRowColFromString(handleaddr)
+
+ // check existing range and set new range vals if the new Cell is outside
+ if (celladdr[0] > formulaaddr[2]) formulaaddr[2] = celladdr[0]
+ if (celladdr[0] < formulaaddr[0]) formulaaddr[0] = celladdr[0]
+ if (celladdr[1] > formulaaddr[3]) formulaaddr[3] = celladdr[1]
+ if (celladdr[1] < formulaaddr[1]) formulaaddr[1] = celladdr[1]
+ val newaddr = ExcelTools.formatRange(formulaaddr)
+ b = this.changeFormulaLocation(formulaLoc, newaddr)
+
+ }
+ return b
+ }
+
+
+ override fun toString(): String {
+ return this.formulaRec!!.cellAddress + ":" + this.formulaRec!!.formulaString
+ }
+
+ companion object {
+ val supportedFunctions: Array>
+ get() = FunctionConstants.recArr
+
+ /**
+ * Converts a cell value to a form suitable for the public API.
+ * Currently this converts cached errors ([CalculationException]s)
+ * to the corresponding error string.
+ */
+ internal fun sanitizeValue(`val`: Any?): Any? {
+ return if (`val` is CalculationException) `val`.name else `val`
+ }
+
+ /**
+ * Copy the formula references with offsets
+ *
+ * @param int[row,col] offsets to move the references
+ * @return
+ */
+ @Throws(FormulaNotFoundException::class)
+ fun moveCellRefs(fmh: FormulaHandle, offsets: IntArray) {
+ // get the current offsets from the FMH references
+ val celladdys = fmh.ranges
+
+ // iterate
+ for (x in celladdys.indices) {
+ val s = ExcelTools.stripSheetNameFromRange(celladdys[x])
+ val sh = s[0] // sheet portion of address,if any
+ var range = s[1] // range or single address
+ val rangeIdx = range.indexOf(":")
+ var secondAddress: String? = null
+ if (rangeIdx > -1) { // separate out addresses within a range
+ secondAddress = range.substring(rangeIdx + 1)
+ range = range.substring(0, rangeIdx)
+ }
+ var orig = ExcelTools.getRowColFromString(range)
+ var relCol = !range.startsWith("$") // 20100603 KSC: handle relative refs
+ var relRow = !(range.length > 0 && range.substring(1).indexOf('$') > -1)
+ if (relRow)
+ // only move if relative ref
+ orig[0] += offsets[0] //row
+ if (relCol)
+ // only move if relative ref
+ orig[1] += offsets[1] //col
+ var newAddress = ExcelTools.formatLocation(orig, relRow, relCol)
+ if (orig[0] < 0 || orig[1] < 0) newAddress = "#REF!"
+ if (secondAddress != null) {
+ orig = ExcelTools.getRowColFromString(secondAddress)
+ relCol = !secondAddress.startsWith("$") // handle relative refs
+ relRow = !(secondAddress.length > 0 && secondAddress.substring(1).indexOf('$') > -1)
+ if (orig[0] >= 0) {
+ if (relRow)
+ // only move if relative ref
+ orig[0] += offsets[0] //row
+ }
+ if (orig[1] >= 0) { //if not wholerow/wholecol ref
+ if (relCol)
+ // only move if relative ref
+ orig[1] += offsets[1] //col
+ }
+ val newAddress1 = ExcelTools.formatLocation(orig, relRow, relCol)
+ newAddress = "$newAddress:$newAddress1"
+ }
+ if (sh != null)
+ // TODO: handle refs with multiple sheets
+ newAddress = "$sh!$newAddress"
+ if (!fmh.changeFormulaLocation(celladdys[x], newAddress)) {
+ Logger.logErr("Could not change Formula Reference: " + celladdys[x] + " to: " + newAddress)
+ }
+ }
+ return
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/GetInfo.java b/src/main/java/io/starter/OpenXLS/GetInfo.java
deleted file mode 100644
index 7a3db6d..0000000
--- a/src/main/java/io/starter/OpenXLS/GetInfo.java
+++ /dev/null
@@ -1,77 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- * ) {
+ // Product name and version
+ io.starter.toolkit.Logger.log("This is OpenXLS " + getVersion())
+ }
+}
diff --git a/src/main/java/io/starter/OpenXLS/Handle.java b/src/main/java/io/starter/OpenXLS/Handle.java
deleted file mode 100644
index 7910bb1..0000000
--- a/src/main/java/io/starter/OpenXLS/Handle.java
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- *
- insert images into your spreadsheet
- set the position of the image
- set the width and height of the image
- write spreadsheet image files to any outputstream
-
-
- "); sb.append("\r\n");
- // top left coords
- sb.append("");
- sb.append("" + bounds[1]*EMU + " ");
- sb.append("" + bounds[2] + " ");
- sb.append("" + bounds[3]*EMU + " ");
- sb.append(" "); sb.append("\r\n");
- // bottom right coords
- sb.append("");
- sb.append("" + bounds[5]*EMU + " ");
- sb.append("" + bounds[6] + " ");
- sb.append("" + bounds[7]*EMU + " ");
- sb.append(" "); sb.append("\r\n");
- // Picture details - req. child elements= nvPicPr (non-visual picture properties), blipFill (links to image), spPr (shape properties)
- sb.append(""); sb.append("\r\n");
- sb.append("");
- sb.append("");
- sb.append("");
- sb.append(" ");
- sb.append(" "); sb.append("\r\n");
- // Picture relationship Id and relationship to the package
- sb.append("");
- sb.append(" "); sb.append("\r\n");
- // shape properties
- sb.append(""/* bwMode=\"auto\">"*/);
- sb.append("");
- int x=this.getX()*EMU, y=this.getY()*EMU, cx= this.getWidth()*EMU, cy= this.getHeight()*EMU;
- sb.append(" ");
- sb.append(""); // preset geometry, appears necessary for images ...
- sb.append(" ");
- sb.append(" ");
- sb.append(" "); sb.append("\r\n");
- sb.append(" ");
- return sb.toString();
- }
- /**
- * return the (00)XML (or DrawingML) representation of this image
- * @param rId relationship id for image file
- * @return String
- */
- public String getOOXML(int rId) {
- TwoCellAnchor t= new TwoCellAnchor(this.editMovement);
- t.setAsImage(rId, this.getImageName(), this.getShapeName(), this.getMsodrawing().getSPID(), this.getSpPr());
- t.setBounds(TwoCellAnchor.convertBoundsFromBIFF8(this.getSheet(), this.getBounds())); // adjust BIFF8 bounds to OOXML units
- return t.getOOXML();
- // missing in
- //
- //
- // \r\n");
- // top left coords
- sb.append("");
- sb.append("" + bounds[0] + " "); // 1-based column
- sb.append("" + bounds[1]+ " ");
- sb.append("" + bounds[2] + " ");
- sb.append("" + bounds[3] + " ");
- sb.append(" "); sb.append("\r\n");
- // bottom right coords
- sb.append("");
- sb.append("" + bounds[4] + " "); // 1-based column
- sb.append("" + bounds[5] + " ");
- sb.append("" + bounds[6] + " ");
- sb.append("" + bounds[7] + " ");
- sb.append(" "); sb.append("\r\n");
- // Picture details - req. child elements= nvPicPr (non-visual picture properties), blipFill (links to image), spPr (shape properties)
- sb.append(""); sb.append("\r\n");
- sb.append("");
- sb.append("");
- sb.append("");
- sb.append(" ");
- sb.append(" "); sb.append("\r\n");
- // Picture relationship Id and relationship to the package
- sb.append("");
- sb.append(" "); sb.append("\r\n");
- // shape properties
- if (imagesp!=null)
- sb.append(imagesp.getOOXML());
- else { // default basic
- sb.append("");
- sb.append("");
- int x=this.getX()*EMU, y=this.getY()*EMU, cx= this.getWidth()*EMU, cy= this.getHeight()*EMU;
- sb.append(" ");
- sb.append(""); // preset geometry, appears necessary for images ...
- sb.append(" ");
- sb.append(" "); sb.append("\r\n");
- }
- sb.append(" "); sb.append("\r\n");
- sb.append("
+ * insert images into your spreadsheet
+ * set the position of the image
+ * set the width and height of the image
+ * write spreadsheet image files to any outputstream
+ *
+ *
+ * ")
+ sb.append("\r\n")
+ // top left coords
+ sb.append("")
+ sb.append("" + bounds[1] * EMU + " ")
+ sb.append("" + bounds[2] + " ")
+ sb.append("" + bounds[3] * EMU + " ")
+ sb.append(" ")
+ sb.append("\r\n")
+ // bottom right coords
+ sb.append("")
+ sb.append("" + bounds[5] * EMU + " ")
+ sb.append("" + bounds[6] + " ")
+ sb.append("" + bounds[7] * EMU + " ")
+ sb.append(" ")
+ sb.append("\r\n")
+ // Picture details - req. child elements= nvPicPr (non-visual picture properties), blipFill (links to image), spPr (shape properties)
+ sb.append("")
+ sb.append("\r\n")
+ sb.append("")
+ sb.append("")
+ sb.append("")
+ sb.append(" ")
+ sb.append(" ")
+ sb.append("\r\n")
+ // Picture relationship Id and relationship to the package
+ sb.append("")
+ sb.append("")
+ // ")
+ sb.append("\r\n")
+ // shape properties
+ sb.append(""/* bwMode=\"auto\">"*/)
+ sb.append("")
+ val x = this.getX() * EMU
+ val y = this.getY() * EMU
+ val cx = this.getWidth() * EMU
+ val cy = this.getHeight() * EMU
+ sb.append("") // offsets= location
+ sb.append("") // extents= size of bounding box enclosing pic in EMUs
+ sb.append(" ")
+ sb.append("") // preset geometry, appears necessary for images ...
+ sb.append(" ")
+ sb.append(" ")
+ sb.append(" ")
+ sb.append("\r\n")
+ sb.append(" ")
+ return sb.toString()
+ }
+
+ /**
+ * return the (00)XML (or DrawingML) representation of this image
+ *
+ * @param rId relationship id for image file
+ * @return String
+ */
+ fun getOOXML(rId: Int): String {
+ val t = TwoCellAnchor(this.editMovement)
+ t.setAsImage(rId, this.imageName, this.shapeName, this.msodrawing!!.spid, this.spPr)
+ t.bounds = TwoCellAnchor.convertBoundsFromBIFF8(this.sheet, this.bounds!!) // adjust BIFF8 bounds to OOXML units
+ return t.ooxml
+ // missing in
+ //
+ //
+ // \r\n");
+ // top left coords
+ sb.append("");
+ sb.append("" + bounds[0] + " "); // 1-based column
+ sb.append("" + bounds[1]+ " ");
+ sb.append("" + bounds[2] + " ");
+ sb.append("" + bounds[3] + " ");
+ sb.append(" "); sb.append("\r\n");
+ // bottom right coords
+ sb.append("");
+ sb.append("" + bounds[4] + " "); // 1-based column
+ sb.append("" + bounds[5] + " ");
+ sb.append("" + bounds[6] + " ");
+ sb.append("" + bounds[7] + " ");
+ sb.append(" "); sb.append("\r\n");
+ // Picture details - req. child elements= nvPicPr (non-visual picture properties), blipFill (links to image), spPr (shape properties)
+ sb.append(""); sb.append("\r\n");
+ sb.append("");
+ sb.append("");
+ sb.append("");
+ sb.append(" ");
+ sb.append(" "); sb.append("\r\n");
+ // Picture relationship Id and relationship to the package
+ sb.append("");
+ sb.append(" "); sb.append("\r\n");
+ // shape properties
+ if (imagesp!=null)
+ sb.append(imagesp.getOOXML());
+ else { // default basic
+ sb.append("");
+ sb.append("");
+ int x=this.getX()*EMU, y=this.getY()*EMU, cx= this.getWidth()*EMU, cy= this.getHeight()*EMU;
+ sb.append(" ");
+ sb.append(""); // preset geometry, appears necessary for images ...
+ sb.append(" ");
+ sb.append(" "); sb.append("\r\n");
+ }
+ sb.append(" "); sb.append("\r\n");
+ sb.append("
- get a handle to the Cells in a Name
- \n");
- try{
- CellHandle[] cells= getCells();
-
- for (int i= 0; i < cells.length; i++) {
- retXML.append("\t\t" + cells[i].getXML() + "\n");
- }
- }catch(CellNotFoundException ex) {
- Logger.logErr("NameHandle.getExpandedXML failed: ",ex);
- }
- retXML.append(" \n");
-
- return retXML.toString();
- }
- /** sets the default format id for the Name's Cells
-
- @param int Format Id for all Cells in Name
- */
- public void setFormatId(int i){
- // myName.setXFRecord(i);
- // TODO: why doesn't this work with myName?
- try {
- CellHandle[] cs = this.getCells();
- for(int t = 0;t1) {
- throw new WorkBookException("NamedRange.updateRow Object array failed: too many CellRanges.",WorkBookException.RUNTIME_ERROR);
- }else if(rngs.length ==0){
- throw new WorkBookException("NamedRange.updateRow Object array failed: zero CellRanges",WorkBookException.RUNTIME_ERROR);
- }
-
- //
- WorkSheetHandle shtx = rngs[0].getSheet();
- int x = rngs[0].firstcellrow;
-
-
- RowHandle[] rx = rngs[0].getRows();
- boolean found = false;
- // iterate, find, update
- for(int t=0;t1) {
- throw new WorkBookException("NamedRange.updateRow Object array failed: too many CellRanges.",WorkBookException.RUNTIME_ERROR);
- }else if(rngs.length ==0){
- throw new WorkBookException("NamedRange.updateRow Object array failed: zero CellRanges",WorkBookException.RUNTIME_ERROR);
- }
-
- //
- WorkSheetHandle shtx = rngs[0].getSheet();
- int x = rngs[0].firstcellrow;
-
-
- RowHandle[] rx = rngs[0].getRows();
- boolean found = false;
- // iterate, find, update
- for(int t=0;tidxcol){
- if(cx[idxcol].getStringVal().equalsIgnoreCase(objarr[idxcol].toString())){
- found = true;
- for(int z=0;z1) {
- throw new WorkBookException("NamedRange.add Object array failed: too many CellRanges.",WorkBookException.RUNTIME_ERROR);
- }else if(rngs.length ==0){
- throw new WorkBookException("NamedRange.add Object array failed: zero CellRanges",WorkBookException.RUNTIME_ERROR);
- }
-
- //
- WorkSheetHandle shtx = rngs[0].getSheet();
-
- int x = rngs[0].firstcellrow;
- CellHandle[] cxx = shtx.insertRow(x, objarr, true);
-
- //for(int t=0;t1) {
- throw new WorkBookException("NamedRange.addCell failed -- more than one cell range defined in this NameHandle, cannot determine where to add cell.",WorkBookException.RUNTIME_ERROR);
- }
- rngs[0].addCellToRange(cx);
- setLocation(rngs[0].getRange());
- }
-
- /** set the referenced cells for the named range
- *
- * this reference should be in the standard excel syntax including sheetname,
- * for instance "Sheet1!A1:Z255"
- *
- *
- */
- public void setLocation(String strloc){
-
- // if there is no sheetname, and no sheet, then this is an unusable name and cannot be added
- if((strloc.indexOf("!")==-1)&&(strloc.indexOf("=")==-1)){
- if(this.get2DSheetName()==null){
- this.remove();
- throw new IllegalArgumentException("Named Range References must include a Sheet name.");
- }else
- strloc = this.get2DSheetName() + "!" + strloc;
- }
- try{myName.setLocation(strloc);
- }catch(FunctionNotSupportedException e) {
- Logger.logWarn("NameHandle.setLocation :" + strloc + " failed: " + e.toString());
- }
- }
-
- /** get the referenced named cell range as string in standard excel syntax including sheetname,
- *
- * for instance "Sheet1!A1:Z255"
- *
- */
- public String getLocation(){
- try{
- String loc = myName.getLocation();
- return loc;
- }catch(Exception e) {
- Logger.logErr("Error getting named range location" + e);
- return null;
- }
- }
-
-
-
-
-
- /** set the name String for the range definition
-
- @param String definition name
- */
- public void setName(String newname){
- myName.setName(newname);
- }
-
- /** returns the name String for the range definition
-
- @return String definition name
- */
- public String getName(){return myName.getName();}
-
- public String toString(){return getName();}
-
- /** returns the name's formula String for the range definition
-
- @return String the expression string
- */
- public String getExpressionString(){
- try{
- return myName.getExpressionString();
- }catch(Exception e){
- if(DEBUGLEVEL > -1)Logger.logWarn("Could not parse expression string for name: " + this.getName());
- }
- return "#ERR";
- }
-
- /** removes this Named Range from the WorkBook.
- *
- * @return whether the removal was a success
- */
- public boolean remove() {
- boolean success = false;
- try{
- success = this.myName.getWorkBook().removeName(myName);
- }catch(Exception e) {
- return false;
- }
- return success;
- }
-
- /** set whether the CellRanges referenced by the NameHandle
- * will add blank records to the WorkBook for any missing Cells
- * contained within the range.
- *
- * @param b set whether to create blank records for missing Cells
- */
- public void setCreateBlanks(boolean b) {
- createblanks= b;
- }
-
- /** gets the array of Cells in this Name
- *
- * NOTE: this method variation also returns the Sheetname for the name record if not null.
- *
- * Thus this method is limited to use with 2D ranges.
- *
- *
- * @return Cell[] all Cells defined in this Name
- @param fragment whether to enclose result in NameHandle tag
- */
- public String getCellRangeXML(boolean fragment){
- StringBuffer sbx = new StringBuffer();
- if(!fragment)
- sbx.append("");
- sbx.append("");
- sbx.append(getCellRangeXML());
- sbx.append(" ");
- return sbx.toString();
- }
-
- /** gets the array of Cells in this Name
-
- @return Cell[] all Cells defined in this Name
- */
- public String getCellRangeXML(){
- StringBuffer sbx = new StringBuffer();
- try {
- CellHandle[] celx = this.getCells();
- RowHandle rowhold = null;
- for(int x=0;x");
- sbx.append(celx[x].getXML()); // ignores merged ranges here
- }else if(rowhold.getRowNumber() == rx.getRowNumber()){
- sbx.append(celx[x].getXML()); // ignores merged ranges here
- }else{
- sbx.append("");
- rowhold = rx;
- sbx.append("");
- sbx.append(celx[x].getXML()); // ignores merged ranges here
- }
- }
- sbx.append(" ");
- }catch(CellNotFoundException ex) {
- Logger.logErr("NameHandle.getCellRangeXML failed: ",ex);
- }
- // sbx.append("");
- return sbx.toString();
- }
-
- /** gets the array of Cells in this Name
-
- @return Cell[] all Cells defined in this Name
- */
- public CellHandle[] getCells()
- throws CellNotFoundException{
- if(false)
- return null;
- // first get the ptgArea3d from the parsed expression
- try{
- CompatibleVector cellhandles = new CompatibleVector();
- CellRange[] rngz = this.getCellRanges();
- if (rngz!=null) {
- for(int t=0;t=0;b--)cellhandles.add(cells[b]);
- for(int b =0; b< cells.length;b++)
- if(cells[b]!=null)
- cellhandles.add(cells[b]);
- }catch(Exception ex){
- Logger.logWarn("Could not get cells for range: " + rngz[t]);
- }
- }
- } else {
- return null;
- }
- CellHandle[] ret = new CellHandle[cellhandles.size()];
- return (CellHandle[]) cellhandles.toArray(ret);
- }catch(Exception e){
- if(e instanceof CellNotFoundException)
- throw (CellNotFoundException)e;
- throw new CellNotFoundException(e.toString());
- }
- }
-
-
- /** Get an Array of CellRanges, one per referenced WorkSheet.
- *
- * If this method throws CellNotFoundExceptions, then you are
- * addressing a sparsely populated CellRange.
- *
- * Use 'setCreateBlanks(true)' to populate these Cells and avoid
- * this error.
- *
- * @return
- * @throws Exception
- */
- public CellRange[] getCellRanges()
- throws Exception{
- if(initialRange!=null){
- CellRange[] ret = {initialRange};
- return ret;
- }
- // 20100217 KSC: try a better way (that can handle 3D refs and complex cell ranges)
- String loc= myName.getLocation(); // may contain one or more ranges, separated by ","'s if complex
- WorkSheetHandle[] sheets = this.getReferencedSheets();
- // handle commas within quoted sheet names (TestExtenXLSEngine.TestQuotedSheetsWithCommansInNRs)
- // NOTE that sheetnames must be properly qualified for the split to work below
- String[] nranges= loc.split(",(?=([^'|\"]*'[^'|\"]*'|\")*[^'|\"]*$)");
- // below cannot handle commas embedded within quotes
-// String[] nranges= StringTool.splitString(loc, ","); // TODO: can be another delimeter?
- CellRange[] ranges = new CellRange[nranges.length];
- for (int i= 0; i < nranges.length; i++) {
- String r= nranges[i];
- if (r.indexOf("!")==-1) { // no sheetname
- r= sheets[i] + "!" + r;
- }
- ranges[i] = new CellRange(r,mybook,createblanks);
- ranges[i].setParent(this.myName);
- }
-
- return ranges;
- }
-
- /** Get WorkSheetHandles for all of the Boundsheets referenced in
- * this NameHandle.
- *
- * @return an array of WorkSheetHandles referenced in this Name
- */
- public WorkSheetHandle[] getReferencedSheets()
- throws WorkSheetNotFoundException{
- //first get the ptgArea3d from the parsed expression
- Boundsheet[] bs = myName.getBoundSheets();
- if(bs == null)
- throw new WorkSheetNotFoundException("Worksheet for Named Range: "+this.toString()+":"+ this.myName.getExpressionString());
- if(bs[0]==null)
- throw new WorkSheetNotFoundException("Worksheet for Named Range: "+this.toString()+":" + this.myName.getExpressionString());
- WorkSheetHandle[] ret = new WorkSheetHandle[bs.length];
- for(int x=0;x
+ * get a handle to the Cells in a Name *
+ * \n")
+ try {
+ val cells = cells
+
+ for (i in cells!!.indices) {
+ retXML.append("\t\t" + cells[i].xml + "\n")
+ }
+ } catch (ex: CellNotFoundException) {
+ Logger.logErr("NameHandle.getExpandedXML failed: ", ex)
+ }
+
+ retXML.append(" \n")
+
+ return retXML.toString()
+ }
+
+ /**
+ * get the referenced named cell range as string in standard excel syntax including sheetname,
+ *
+ *
+ * for instance "Sheet1!A1:Z255"
+ */
+ /**
+ * set the referenced cells for the named range
+ *
+ *
+ * this reference should be in the standard excel syntax including sheetname,
+ * for instance "Sheet1!A1:Z255"
+ */
+ // if there is no sheetname, and no sheet, then this is an unusable name and cannot be added
+ var location: String?
+ get() {
+ try {
+ return myName!!.location
+ } catch (e: Exception) {
+ Logger.logErr("Error getting named range location$e")
+ return null
+ }
+
+ }
+ set(strloc) {
+ var strloc = strloc
+ if (strloc.indexOf("!") == -1 && strloc.indexOf("=") == -1) {
+ if (this .2 DSheetName == null)
+ {
+ this.remove()
+ throw IllegalArgumentException("Named Range References must include a Sheet name.")
+ }
+ else
+ strloc = this.2DSheetName+"!"+strloc
+ }
+ try {
+ myName!!.location = strloc
+ } catch (e: FunctionNotSupportedException) {
+ Logger.logWarn("NameHandle.setLocation :$strloc failed: $e")
+ }
+
+ }
+
+ /**
+ * returns the name String for the range definition
+ *
+ * @return String definition name
+ */
+ /**
+ * set the name String for the range definition
+ *
+ * @param String definition name
+ */
+ var name: String
+ get() = myName!!.name
+ set(newname) {
+ myName!!.name = newname
+ }
+
+ /**
+ * returns the name's formula String for the range definition
+ *
+ * @return String the expression string
+ */
+ val expressionString: String
+ get() {
+ try {
+ return myName!!.expressionString
+ } catch (e: Exception) {
+ if (DEBUGLEVEL > -1) Logger.logWarn("Could not parse expression string for name: " + this.name)
+ }
+
+ return "#ERR"
+ }
+
+ /**
+ * gets the array of Cells in this Name
+ *
+ * @return Cell[] all Cells defined in this Name
+ */
+ // ignores merged ranges here
+ // ignores merged ranges here
+ // ignores merged ranges here
+ // sbx.append("");
+ val cellRangeXML: String
+ get() {
+ val sbx = StringBuffer()
+ try {
+ val celx = this.cells
+ var rowhold: RowHandle? = null
+ for (x in celx!!.indices) {
+ val rx = celx[x].row
+ if (x == 0) {
+ rowhold = rx
+ sbx.append("")
+ sbx.append(celx[x].xml)
+ } else if (rowhold!!.rowNumber == rx.rowNumber) {
+ sbx.append(celx[x].xml)
+ } else {
+ sbx.append(" ")
+ rowhold = rx
+ sbx.append("")
+ sbx.append(celx[x].xml)
+ }
+ }
+ sbx.append(" ")
+ } catch (ex: CellNotFoundException) {
+ Logger.logErr("NameHandle.getCellRangeXML failed: ", ex)
+ }
+
+ return sbx.toString()
+ }
+
+ /**
+ * gets the array of Cells in this Name
+ *
+ * @return Cell[] all Cells defined in this Name
+ */
+ // first get the ptgArea3d from the parsed expression
+ // for(int b = (cells.length-1);b>=0;b--)cellhandles.add(cells[b]);
+ val cells: Array?
+ @Throws(CellNotFoundException::class)
+ get() {
+ if (false)
+ return null
+ try {
+ val cellhandles = CompatibleVector()
+ val rngz = this.cellRanges
+ if (rngz != null) {
+ for (t in rngz.indices) {
+ try {
+ val cells = rngz[t].getCells()
+ for (b in cells!!.indices)
+ if (cells[b] != null)
+ cellhandles.add(cells[b])
+ } catch (ex: Exception) {
+ Logger.logWarn("Could not get cells for range: " + rngz[t])
+ }
+
+ }
+ } else {
+ return null
+ }
+ val ret = arrayOfNulls(cellhandles.size)
+ return cellhandles.toTypedArray() as Array
+ } catch (e: Exception) {
+ if (e is CellNotFoundException)
+ throw e
+ throw CellNotFoundException(e.toString())
+ }
+
+ }
+
+
+ /**
+ * Get an Array of CellRanges, one per referenced WorkSheet.
+ *
+ *
+ * If this method throws CellNotFoundExceptions, then you are
+ * addressing a sparsely populated CellRange.
+ *
+ *
+ * Use 'setCreateBlanks(true)' to populate these Cells and avoid
+ * this error.
+ *
+ * @return
+ * @throws Exception
+ */
+ // 20100217 KSC: try a better way (that can handle 3D refs and complex cell ranges)
+ // may contain one or more ranges, separated by ","'s if complex
+ // handle commas within quoted sheet names (TestExtenXLSEngine.TestQuotedSheetsWithCommansInNRs)
+ // NOTE that sheetnames must be properly qualified for the split to work below
+ // below cannot handle commas embedded within quotes
+ // String[] nranges= StringTool.splitString(loc, ","); // TODO: can be another delimeter?
+ // no sheetname
+ val cellRanges: Array
+ @Throws(Exception::class)
+ get() {
+ if (initialRange != null) {
+ return arrayOf(initialRange)
+ }
+ val loc = myName!!.location
+ val sheets = this.referencedSheets
+ val nranges = loc!!.split(",(?=([^'|\"]*'[^'|\"]*'|\")*[^'|\"]*$)".toRegex()).dropLastWhile({ it.isEmpty() }).toTypedArray()
+ val ranges = arrayOfNulls(nranges.size)
+ for (i in nranges.indices) {
+ var r = nranges[i]
+ if (r.indexOf("!") == -1) {
+ r = sheets[i].toString() + "!" + r
+ }
+ ranges[i] = CellRange(r, mybook, createblanks)
+ ranges[i].setParent(this.myName)
+ }
+
+ return ranges
+ }
+
+ /**
+ * Get WorkSheetHandles for all of the Boundsheets referenced in
+ * this NameHandle.
+ *
+ * @return an array of WorkSheetHandles referenced in this Name
+ */
+ //first get the ptgArea3d from the parsed expression
+ val referencedSheets: Array
+ @Throws(WorkSheetNotFoundException::class)
+ get() {
+ val bs = myName!!.boundSheets
+ ?: throw WorkSheetNotFoundException("Worksheet for Named Range: " + this.toString() + ":" + this.myName!!.expressionString)
+ if (bs[0] == null)
+ throw WorkSheetNotFoundException("Worksheet for Named Range: " + this.toString() + ":" + this.myName!!.expressionString)
+ val ret = arrayOfNulls(bs.size)
+ for (x in ret.indices) {
+ ret[x] = mybook!!.getWorkSheet(bs[x].toString())
+ }
+ return ret
+ }
+
+ /**
+ * return the calculated value of this Name
+ * if it contains a parsed Expression (Formula)
+ *
+ * @return
+ * @throws FunctionNotSupportedException
+ */
+ val calculatedValue: Any
+ @Throws(FunctionNotSupportedException::class)
+ get() = myName!!.calculatedValue
+
+ /**
+ * Return a JSON object representing this name Handle.
+ * name:'nameOfRange'
+ * cellrange:'Sheet1!A1:B1'
+ *
+ * @return
+ */
+ val json: String
+ get() = getJSON(false)
+
+ /**
+ * Returns a JSON object in the same format as [CellRange.getJSON].
+ */
+ val jsonCellRange: JSONObject
+ get() {
+ val theRange = JSONObject()
+ val cells = JSONArray()
+ try {
+ val chandles = cells
+ for (i in chandles.indices) {
+ val thisCell = chandles[i]
+ val result = JSONObject()
+
+ result.put(JSON_CELL, thisCell.jsonObject)
+ cells.put(result)
+ }
+ theRange.put(JSON_CELLS, cells)
+ } catch (e: Exception) {
+ Logger.logErr("Error getting NamedRange JSON: $e")
+ }
+
+ return theRange
+ }
+
+ /**
+ * return the sheetname for a 2D named range
+ *
+ *
+ * NOTE: Does not work for 3D ranges
+ *
+ * @return the Sheet name if this is a 2d range
+ */
+ val 2DSheetName:String?
+ get()
+ {
+ try {
+ return this.myName!!.boundSheets!![0].sheetName
+ } catch (e: Exception) {
+ try {
+ return this.myName!!.sheet!!.sheetName
+ } catch (ex: Exception) {
+ return null
+ }
+
+ }
+
+ }
+
+ /**
+ * Creates a new Named Range from a CellRange
+ *
+ * @param Name of the Range, the CellRange referenced by the Name
+ */
+ constructor(namestr: String, cr: CellRange) {
+ mybook = cr.workBook
+ initialRange = cr // cache
+ myName = Name(mybook!!.workBook, namestr)
+ this.name = namestr
+ this.location = cr.toString()
+ }
+
+ /**
+ * Create a NameHandle from an internal Name record
+ *
+ * @param c
+ * @param myb
+ */
+ constructor(c: Name, myb: WorkBookHandle) {
+ myName = c
+ mybook = myb
+ }
+
+ /**
+ * Create a new named range in the workbook
+ * note that this does not set the actual range, just the workbook and name,
+ * follow up with setLocation
+ *
+ * @param namestr
+ * @param myb
+ */
+ @Deprecated("")
+ constructor(namestr: String, myb: WorkBookHandle) {
+ mybook = myb
+ myName = Name(mybook!!.workBook, namestr)
+ this.name = namestr
+ }
+
+ /**
+ * Create a new named range in the workbook
+ *
+ * @param name name that should be used to reference this named range
+ * @param location rangeDef Range of the cells for this named range, in excel syntax including sheet name, ie "Sheet1!A1:D1"
+ * @param book WorkBookHandle to insert this named range into
+ */
+ constructor(name: String, location: String, book: WorkBookHandle) {
+ mybook = book
+ myName = Name(mybook!!.workBook, name)
+ this.name = name
+ this.location = location
+ mybook!!.workBook.associateDereferencedNames(myName!!)
+ }
+
+ /**
+ * sets the default format id for the Name's Cells
+ *
+ * @param int Format Id for all Cells in Name
+ */
+ fun setFormatId(i: Int) {
+ // myName.setXFRecord(i);
+ // TODO: why doesn't this work with myName?
+ try {
+ val cs = this.cells
+ for (t in cs!!.indices) {
+ cs[t].formatId = i
+ }
+ } catch (ex: CellNotFoundException) {
+ Logger.logErr("NameHandle.setFormatId failed: ", ex)
+ }
+
+ }
+
+ /**
+ * deletes a row of cells in this named range, shifts subsequent
+ * rows up.
+ *
+ * @param the column to use as unique index
+ */
+ @Throws(Exception::class)
+ fun deleteRow(idxcol: Int) {
+ val rngs = cellRanges
+ if (rngs.size > 1) {
+ throw WorkBookException("NamedRange.updateRow Object array failed: too many CellRanges.", WorkBookException.RUNTIME_ERROR)
+ } else if (rngs.size == 0) {
+ throw WorkBookException("NamedRange.updateRow Object array failed: zero CellRanges", WorkBookException.RUNTIME_ERROR)
+ }
+
+ //
+ val shtx = rngs[0].sheet
+ val x = rngs[0].firstcellrow
+
+
+ val rx = rngs[0].rows
+ val found = false
+ // iterate, find, update
+ for (t in rx.indices) {
+
+ }
+ }
+
+ /**
+ * update a row of cells in this named range
+ *
+ * @param an array of Objects to update existing
+ * @param the column to use as unique index
+ */
+ @Throws(Exception::class)
+ fun updateRow(objarr: Array, idxcol: Int) {
+ val rngs = cellRanges
+ if (rngs.size > 1) {
+ throw WorkBookException("NamedRange.updateRow Object array failed: too many CellRanges.", WorkBookException.RUNTIME_ERROR)
+ } else if (rngs.size == 0) {
+ throw WorkBookException("NamedRange.updateRow Object array failed: zero CellRanges", WorkBookException.RUNTIME_ERROR)
+ }
+
+ //
+ val shtx = rngs[0].sheet
+ val x = rngs[0].firstcellrow
+
+
+ val rx = rngs[0].rows
+ var found = false
+ // iterate, find, update
+ for (t in rx.indices) {
+
+ val cx = rx[t].cells
+ if (cx.size > idxcol) {
+ if (cx[idxcol].stringVal!!.equals(objarr[idxcol].toString(), ignoreCase = true)) {
+ found = true
+ for (z in cx.indices) {
+ cx[z].`val` = objarr[z]
+ }
+ }
+ }
+ }
+
+ if (!found)
+ this.addRow(objarr)
+ }
+
+
+ /**
+ * add a row of cells to this named range
+ *
+ * @param an array of Objects to insert at last rown
+ */
+ @Throws(Exception::class)
+ fun addRow(objarr: Array) {
+ val rngs = cellRanges
+ if (rngs.size > 1) {
+ throw WorkBookException("NamedRange.add Object array failed: too many CellRanges.", WorkBookException.RUNTIME_ERROR)
+ } else if (rngs.size == 0) {
+ throw WorkBookException("NamedRange.add Object array failed: zero CellRanges", WorkBookException.RUNTIME_ERROR)
+ }
+
+ //
+ val shtx = rngs[0].sheet
+
+ val x = rngs[0].firstcellrow
+ val cxx = shtx!!.insertRow(x, objarr, true)
+
+ //for(int t=0;t 1) {
+ throw WorkBookException("NamedRange.addCell failed -- more than one cell range defined in this NameHandle, cannot determine where to add cell.", WorkBookException.RUNTIME_ERROR)
+ }
+ rngs[0].addCellToRange(cx)
+ location = rngs[0].getRange()
+ }
+
+ override fun toString(): String {
+ return name
+ }
+
+ /**
+ * removes this Named Range from the WorkBook.
+ *
+ * @return whether the removal was a success
+ */
+ fun remove(): Boolean {
+ var success = false
+ try {
+ success = this.myName!!.workBook!!.removeName(myName)
+ } catch (e: Exception) {
+ return false
+ }
+
+ return success
+ }
+
+ /**
+ * set whether the CellRanges referenced by the NameHandle
+ * will add blank records to the WorkBook for any missing Cells
+ * contained within the range.
+ *
+ * @param b set whether to create blank records for missing Cells
+ */
+ fun setCreateBlanks(b: Boolean) {
+ createblanks = b
+ }
+
+ /**
+ * gets the array of Cells in this Name
+ *
+ *
+ * NOTE: this method variation also returns the Sheetname for the name record if not null.
+ *
+ *
+ * Thus this method is limited to use with 2D ranges.
+ *
+ * @param fragment whether to enclose result in NameHandle tag
+ * @return Cell[] all Cells defined in this Name
+ */
+ fun getCellRangeXML(fragment: Boolean): String {
+ val sbx = StringBuffer()
+ if (!fragment)
+ sbx.append("")
+ sbx.append("")
+ sbx.append(cellRangeXML)
+ sbx.append(" ")
+ return sbx.toString()
+ }
+
+ /**
+ * Sets the location lock on the Cell Reference at the
+ * specified location
+ *
+ *
+ * Used to prevent updating of the Cell Reference when
+ * Cells are moved.
+ *
+ * @param location of the Cell Reference to be locked/unlocked
+ * @param lock status setting
+ * @return boolean whether the Cell Reference was found and modified
+ */
+ fun setLocationLocked(loc: String, l: Boolean): Boolean {
+ var x = Ptg.PTG_LOCATION_POLICY_UNLOCKED
+ if (l) x = Ptg.PTG_LOCATION_POLICY_LOCKED
+ return myName!!.setLocationPolicy(loc, x)
+ }
+
+
+ /**
+ * Return a JSON object representing this name Handle.
+ * name:'nameOfRange'
+ * cellrange:'Sheet1!A1:B1'
+ * cells:celldata
+ *
+ * @param whether to return cell data
+ * @return
+ */
+ fun getJSON(celldata: Boolean): String {
+ val theNameHandle = JSONObject()
+ try {
+ theNameHandle.put("name", this.name)
+ theNameHandle.put("cellrange", myName!!.location)
+
+ if (celldata) {
+ val ret = StringBuffer()
+ val cx1 = cells
+ var p = cx1!![0].rowNum
+ for (x in cx1.indices) {
+ if (cx1[x] != null) {
+ if (cx1[x].rowNum != p) {
+ ret.append("\r\n")
+ p = cx1[x].rowNum
+ }
+ ret.append("'")
+ try {
+ ret.append(cx1[x].stringVal)
+ } catch (ex: Exception) { // handles empties
+ //
+ }
+
+ if (x != cx1.size - 1)
+ ret.append("',")
+ else
+ ret.append("'")
+ }
+ }
+
+ theNameHandle.put("celldata", ret.toString())
+ }
+ } catch (e: Exception) {
+ Logger.logErr("Error creating JSON name handle: $e")
+ }
+
+ return theNameHandle.toString()
+ }
+
+}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/PivotTableHandle.java b/src/main/java/io/starter/OpenXLS/PivotTableHandle.java
deleted file mode 100644
index ee6bb15..0000000
--- a/src/main/java/io/starter/OpenXLS/PivotTableHandle.java
+++ /dev/null
@@ -1,574 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- *
- * The valid formats are:
- *
- * PivotTableHandle.AUTO_FORMAT_Report1
- * PivotTableHandle.AUTO_FORMAT_Report2
- * PivotTableHandle.AUTO_FORMAT_Report3
- * PivotTableHandle.AUTO_FORMAT_Report4
- * PivotTableHandle.AUTO_FORMAT_Report5
- * PivotTableHandle.AUTO_FORMAT_Report6
- * PivotTableHandle.AUTO_FORMAT_Report7
- * PivotTableHandle.AUTO_FORMAT_Report8
- * PivotTableHandle.AUTO_FORMAT_Report9
- * PivotTableHandle.AUTO_FORMAT_Report10
- * PivotTableHandle.AUTO_FORMAT_Table1
- * PivotTableHandle.AUTO_FORMAT_Table2
- * PivotTableHandle.AUTO_FORMAT_Table3
- * PivotTableHandle.AUTO_FORMAT_Table4
- * PivotTableHandle.AUTO_FORMAT_Table5
- * PivotTableHandle.AUTO_FORMAT_Table6
- * PivotTableHandle.AUTO_FORMAT_Table7
- * PivotTableHandle.AUTO_FORMAT_Table8
- * PivotTableHandle.AUTO_FORMAT_Table9
- * PivotTableHandle.AUTO_FORMAT_Table10
- *
- *
- * @param int the auto format Id for the table
- */
- public void setAutoFormatId(int b) {
- pt.setItblAutoFmt((short) b);
- }
-
- /**
- * get the auto format for the Table
- *
- * @return int the auto format Id for the table
- */
- public int getAutoFormatId() {
- return pt.getItblAutoFmt();
- }
-
- /**
- * set whether to auto format the Table
- *
- * @param boolean whether to auto format the table
- */
- public void setUsesAutoFormat(boolean b) {
- pt.setFAutoFormat(b);
- }
-
- /**
- * get whether table has auto format applied
- *
- * @param boolean whether table has auto format applied
- */
- public boolean getUsesAutoFormat() {
- return pt.getFAutoFormat();
- }
-
- /**
- * set Width/Height Autoformat is applied
- *
- * @param boolean whether to apply the Width/Height Autoformat
- */
- public void setAutoWidthHeight(boolean b) {
- pt.setFWH(b);
- }
-
- /**
- * get whether Width/Height Autoformat is applied
- *
- * @return boolean whether the Width/Height Autoformat is applied
- */
- public boolean getAutoWidthHeight() {
- return pt.getFWH();
- }
-
- /**
- * set whether Font Autoformat is applied
- *
- * @param boolean whether to apply the Font Autoformat
- */
- public void setAutoFont(boolean b) {
- pt.setFFont(b);
- }
-
- /**
- * get whether Font Autoformat is applied
- *
- * @return boolean whether the Font Autoformat is applied
- */
- public boolean getAutoFont() {
- return pt.getFFont();
- }
-
- public void removeArtifacts() {
- int[] coords = { pt.getRwFirst() - 2, pt.getColFirst(), pt.getRwLast(),
- pt.getColLast() };
- try {
- CellRange newr = new CellRange(worksheet, coords, true);
- CellHandle[] ch = newr.getCells();
- for (int r = 0; r < ch.length; r++) {
- if (ch[r] != null)
- ch[r].remove(true);
- }
- } catch (Exception e) {
- Logger.logWarn("could not remove artifacts in PivotTableHandle: "
- + e);
- }
- }
-
- /**
- * set whether Alignment Autoformat is applied
- *
- * @param boolean whether to apply the Alignment Autoformat
- */
- public void setAutoAlign(boolean b) {
- pt.setFAlign(b);
- }
-
- /**
- * get whether Alignment Autoformat is applied
- *
- * @return boolean whether the Alignment Autoformat is applied
- */
- public boolean getAutoAlign() {
- return pt.getFAlign();
- }
-
- /**
- * set whether Border Autoformat is applied
- *
- * @param boolean whether to apply the Border Autoformat
- */
- public void setAutoBorder(boolean b) {
- pt.setFBorder(b);
- }
-
- /**
- * get whether Border Autoformat is applied
- *
- * @return boolean whether the Border Autoformat is applied
- */
- public boolean getAutoBorder() {
- return pt.getFBorder();
- }
-
- /**
- * set whether Pattern Autoformat is applied
- *
- * @param boolean whether to apply the Pattern Autoformat
- */
- public void setAutoPattern(boolean b) {
- pt.setFPattern(b);
- }
-
- /**
- * get whether Pattern Autoformat is applied
- *
- * @return boolean whether the Pattern Autoformat is applied
- */
- public boolean getAutoPattern() {
- return pt.getFPattern();
- }
-
- /**
- * set whether Number Autoformat is applied
- *
- * @param boolean whether to apply the Number Autoformat
- */
- public void setAutoNumber(boolean b) {
- pt.setFNumber(b);
- }
-
- /**
- * get whether Number Autoformat is applied
- *
- * @return boolean whether the Number Autoformat is applied
- */
- public boolean getAutoNumber() {
- return pt.getFNumber();
- }
-
- /**
- * set the first row in the PivotTable
- */
- public void setRowFirst(int s) {
- // s--; // these are zero-based rows
- pt.setRwFirst((short) s);
- }
-
- /**
- * get the first row in the PivotTable
- */
- public int getRowFirst() {
- return (int) pt.getRwFirst() + 1;
- }
-
- /**
- * set the last row in the PivotTable
- */
- public void setRowLast(int s) {
- s--;
- pt.setRwLast((short) s);
- }
-
- /**
- * get the last row in the PivotTable
- */
- public int getRowLast() {
- return (int) pt.getRwLast() + 1;
- }
-
- /**
- * set the first Column in the PivotTable
- */
- public void setColFirst(int s) {
- pt.setColFirst((short) s);
- }
-
- /**
- * get the first Column in the PivotTable
- */
- public int getColFirst() {
- return (int) pt.getColFirst();
- }
-
- /**
- * set the last Column in the PivotTable
- */
- public void setColLast(int s) {
- pt.setColLast((short) s);
- }
-
- /**
- * get the last Column in the PivotTable
- */
- public int getColLast() {
- return (int) pt.getColLast();
- }
-
- /**
- * set the first header row
- */
- public void setRowFirstHead(int s) {
- s--;
- pt.setRwFirstHead((short) s);
- }
-
- /**
- * get the first header row
- */
- public int getRowFirstHead() {
- return (int) pt.getRwFirstHead() + 1;
- }
-
- /**
- * set the first Row containing data
- */
- public void setRowFirstData(int s) {
- s--; // zero-based rows
- pt.setRwFirstData((short) s);
- }
-
- /**
- * get the first Row containing data
- */
- public int getRowFirstData() {
- return (int) pt.getRwFirstData() + 1;
- }
-
- /**
- * set the first Column containing data
- */
- public void setColFirstData(int s) {
- pt.setColFirstData((short) s);
- }
-
- /**
- * get the first Column containing data
- */
- public int getColFirstData() {
- return (int) pt.getColFirstData();
- }
-
- /**
- * returns the JSON representation of this PivotTable
- *
- * @return JSON Pivot Table representation
- */
- public String getJSON() {
- // copy all methods to this sucker
- JSONObject thePivot = new JSONObject();
-
- try {
- thePivot.put("title", this.getTableName());
-// thePivot.put("cellrange", this.getCellRange().getRange());
-
- } catch (Exception e) {
- throw new WorkBookException("PivotTableHandle.getJSON failed:" + e,
- WorkBookException.RUNTIME_ERROR);
- }
- return thePivot.toString();
- }
-
-
-}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/PivotTableHandle.kt b/src/main/java/io/starter/OpenXLS/PivotTableHandle.kt
new file mode 100644
index 0000000..24c754d
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/PivotTableHandle.kt
@@ -0,0 +1,536 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ *
+ * The valid formats are:
+ *
+ * PivotTableHandle.AUTO_FORMAT_Report1
+ * PivotTableHandle.AUTO_FORMAT_Report2
+ * PivotTableHandle.AUTO_FORMAT_Report3
+ * PivotTableHandle.AUTO_FORMAT_Report4
+ * PivotTableHandle.AUTO_FORMAT_Report5
+ * PivotTableHandle.AUTO_FORMAT_Report6
+ * PivotTableHandle.AUTO_FORMAT_Report7
+ * PivotTableHandle.AUTO_FORMAT_Report8
+ * PivotTableHandle.AUTO_FORMAT_Report9
+ * PivotTableHandle.AUTO_FORMAT_Report10
+ * PivotTableHandle.AUTO_FORMAT_Table1
+ * PivotTableHandle.AUTO_FORMAT_Table2
+ * PivotTableHandle.AUTO_FORMAT_Table3
+ * PivotTableHandle.AUTO_FORMAT_Table4
+ * PivotTableHandle.AUTO_FORMAT_Table5
+ * PivotTableHandle.AUTO_FORMAT_Table6
+ * PivotTableHandle.AUTO_FORMAT_Table7
+ * PivotTableHandle.AUTO_FORMAT_Table8
+ * PivotTableHandle.AUTO_FORMAT_Table9
+ * PivotTableHandle.AUTO_FORMAT_Table10
+ *
+ *
+ * @param int the auto format Id for the table
+ */
+ var autoFormatId: Int
+ get() = pt.itblAutoFmt.toInt()
+ set(b) {
+ pt.itblAutoFmt = b.toShort()
+ }
+
+ /**
+ * get whether table has auto format applied
+ *
+ * @param boolean whether table has auto format applied
+ */
+ /**
+ * set whether to auto format the Table
+ *
+ * @param boolean whether to auto format the table
+ */
+ var usesAutoFormat: Boolean
+ get() = pt.fAutoFormat
+ set(b) {
+ pt.fAutoFormat = b
+ }
+
+ /**
+ * get whether Width/Height Autoformat is applied
+ *
+ * @return boolean whether the Width/Height Autoformat is applied
+ */
+ /**
+ * set Width/Height Autoformat is applied
+ *
+ * @param boolean whether to apply the Width/Height Autoformat
+ */
+ var autoWidthHeight: Boolean
+ get() = pt.fwh
+ set(b) {
+ pt.fwh = b
+ }
+
+ /**
+ * get whether Font Autoformat is applied
+ *
+ * @return boolean whether the Font Autoformat is applied
+ */
+ /**
+ * set whether Font Autoformat is applied
+ *
+ * @param boolean whether to apply the Font Autoformat
+ */
+ var autoFont: Boolean
+ get() = pt.fFont
+ set(b) {
+ pt.fFont = b
+ }
+
+ /**
+ * get whether Alignment Autoformat is applied
+ *
+ * @return boolean whether the Alignment Autoformat is applied
+ */
+ /**
+ * set whether Alignment Autoformat is applied
+ *
+ * @param boolean whether to apply the Alignment Autoformat
+ */
+ var autoAlign: Boolean
+ get() = pt.fAlign
+ set(b) {
+ pt.fAlign = b
+ }
+
+ /**
+ * get whether Border Autoformat is applied
+ *
+ * @return boolean whether the Border Autoformat is applied
+ */
+ /**
+ * set whether Border Autoformat is applied
+ *
+ * @param boolean whether to apply the Border Autoformat
+ */
+ var autoBorder: Boolean
+ get() = pt.fBorder
+ set(b) {
+ pt.fBorder = b
+ }
+
+ /**
+ * get whether Pattern Autoformat is applied
+ *
+ * @return boolean whether the Pattern Autoformat is applied
+ */
+ /**
+ * set whether Pattern Autoformat is applied
+ *
+ * @param boolean whether to apply the Pattern Autoformat
+ */
+ var autoPattern: Boolean
+ get() = pt.fPattern
+ set(b) {
+ pt.fPattern = b
+ }
+
+ /**
+ * get whether Number Autoformat is applied
+ *
+ * @return boolean whether the Number Autoformat is applied
+ */
+ /**
+ * set whether Number Autoformat is applied
+ *
+ * @param boolean whether to apply the Number Autoformat
+ */
+ var autoNumber: Boolean
+ get() = pt.fNumber
+ set(b) {
+ pt.fNumber = b
+ }
+
+ /**
+ * get the first row in the PivotTable
+ */
+ /**
+ * set the first row in the PivotTable
+ */
+ // s--; // these are zero-based rows
+ var rowFirst: Int
+ get() = pt.rwFirst.toInt() + 1
+ set(s) {
+ pt.rwFirst = s.toShort()
+ }
+
+ /**
+ * get the last row in the PivotTable
+ */
+ /**
+ * set the last row in the PivotTable
+ */
+ var rowLast: Int
+ get() = pt.rwLast.toInt() + 1
+ set(s) {
+ var s = s
+ s--
+ pt.rwLast = s.toShort()
+ }
+
+ /**
+ * get the first Column in the PivotTable
+ */
+ /**
+ * set the first Column in the PivotTable
+ */
+ var colFirst: Int
+ get() = pt.colFirst.toInt()
+ set(s) {
+ pt.colFirst = s.toShort()
+ }
+
+ /**
+ * get the last Column in the PivotTable
+ */
+ /**
+ * set the last Column in the PivotTable
+ */
+ var colLast: Int
+ get() = pt.colLast.toInt()
+ set(s) {
+ pt.colLast = s.toShort()
+ }
+
+ /**
+ * get the first header row
+ */
+ /**
+ * set the first header row
+ */
+ var rowFirstHead: Int
+ get() = pt.rwFirstHead.toInt() + 1
+ set(s) {
+ var s = s
+ s--
+ pt.rwFirstHead = s.toShort()
+ }
+
+ /**
+ * get the first Row containing data
+ */
+ /**
+ * set the first Row containing data
+ */
+ // zero-based rows
+ var rowFirstData: Int
+ get() = pt.rwFirstData.toInt() + 1
+ set(s) {
+ var s = s
+ s--
+ pt.rwFirstData = s.toShort()
+ }
+
+ /**
+ * get the first Column containing data
+ */
+ /**
+ * set the first Column containing data
+ */
+ var colFirstData: Int
+ get() = pt.colFirstData.toInt()
+ set(s) {
+ pt.colFirstData = s.toShort()
+ }
+
+ /**
+ * returns the JSON representation of this PivotTable
+ *
+ * @return JSON Pivot Table representation
+ */
+ // copy all methods to this sucker
+ // thePivot.put("cellrange", this.getCellRange().getRange());
+ val json: String
+ get() {
+ val thePivot = JSONObject()
+
+ try {
+ thePivot.put("title", this.tableName)
+
+ } catch (e: Exception) {
+ throw WorkBookException("PivotTableHandle.getJSON failed:$e",
+ WorkBookException.RUNTIME_ERROR)
+ }
+
+ return thePivot.toString()
+ }
+
+ /**
+ * Sets the Pivot Table Range to represent the Data to analyse
+ *
- * Example Usage:
- *
- ...
- PrinterSettingsHandle printersetup = sheet.getPrinterSettings();
- // Paper Size
- printersetup.setPaperSize(PrinterSettingsHandle.PAPER_SIZE_LEDGER_17x11);
- // Scaling
- printersetup.setScale(125);
- // resolution
- printersetup.setResolution(300);
- ...
-
- *
- *
- */
-/* order of records in Page Settings Block:
- * HORIZONTALPAGEBREAKS
- VERTICALPAGEBREAKS
- HEADER
- FOOTER
- HCENTER
- VCENTER
- LEFTMARGIN
- RIGHTMARGIN
- TOPMARGIN
- BOTTOMMARGIN
- PLS
- SETUP
- BITMAP
- *
- */
-public class PrinterSettingsHandle implements Handle {
-
-
-// paper size ints
- public static final int PAPER_SIZE_UNDEFINED = 0;
- public static final int PAPER_SIZE_LETTER_8_5x11 = 1; // Letter 81/2" x 11"
- public static final int PAPER_SIZE_LETTER_SMALL = 2; // Letter small 81/2" x 11"
- public static final int PAPER_SIZE_TABLOID_11x17 = 3; // Tabloid 11" x 17"
- public static final int PAPER_SIZE_LEDGER_17x11 = 4; // Ledger 17" x 11"
- public static final int PAPER_SIZE_LEGAL_8_5x14 = 5; // Legal 81/2" x 14"
- public static final int PAPER_SIZE_STATEMENT_5_5x8_5 = 6; // Statement 51/2" x 81/2"
- public static final int PAPER_SIZE_LETTER_EXTRA_9_5Ax12 = 50 ; // Letter Extra 91/2" x 12
- public static final int PAPER_SIZE_LEGAL_EXTRA_9_5Ax15 = 51 ; // Legal Extra 91/2" x 15"
- public static final int PAPER_SIZE_TABLOID_EXTRA_1111_16Ax18 = 52 ; // Tabloid Extra 1111/16" x 18"
- public static final int PAPER_SIZE_A4_EXTRA_235MM_X_322MM = 53 ; // A4 Extra 235mm x 322mm
- public static final int PAPER_SIZE_LETTER_TRANSVERSE_8_5Ax11 = 54 ; // Letter Transverse 81/2" x 11"
- public static final int PAPER_SIZE_EXECUTIVE_7_QUARTER_X_10_5 = 7 ; // Executive 71/4" x 101/2"
- public static final int PAPER_SIZE_TRANSVERSE_210MM_X_297MM = 55 ; // A4 Transverse 210mm x 297mm
- public static final int PAPER_SIZE_A3_297MM_X_420MM = 8 ; // 8 A3 297mm x 420mm
- public static final int PAPER_SIZE_LETTER_EXTRA_TRANSV_9_5_X_12 = 56 ; // 56 Letter Extra Transv. 91/2" x 12"
- public static final int PAPER_SIZE_A4_210MM_X_297MM = 9 ; // A4 210mm x 297mm
- public static final int PAPER_SIZE_SUPER_A_A4_227MM_X_356MM = 57 ; // Super A/A4 227mm x 356mm
- public static final int PAPER_SIZE_A4_SMALL_210MM_X_297MM = 10 ; // A4 small 210mm x 297mm
- public static final int PAPER_SIZE_SUPER_B_A3_305MM_X_487MM = 58 ; // Super B/A3 305mm x 487mm
- public static final int PAPER_SIZE_A5_148MM_X_210MM = 11 ; // A5 148mm x 210mm
- public static final int PAPER_SIZE_LETTER_PLUS = 59 ; // Letter Plus
- public static final int PAPER_SIZE_2_X_1211_16 = 81 ; // 2" x 1211/16"
- public static final int PAPER_SIZE_B4_JIS_257MM_X_364MM = 12 ; // B4 (JIS) 257mm x 364mm
- public static final int PAPER_SIZE_A4_PLUS_210MM_X_330MM = 60 ; // A4 Plus 210mm x 330mm
- public static final int PAPER_SIZE_B5_JIS_182MM_X_257MM = 13 ; // B5 (JIS) 182mm x 257mm
- public static final int PAPER_SIZE_A5_TRANSVERSE_148MM_X_210MM = 61 ; // A5 Transverse 148mm x 210mm
- public static final int PAPER_SIZE_FOLIO_8_5_X_13 = 14 ; // Folio 81/2" x 13"
- public static final int PAPER_SIZE_B5_JIS_TRANSVERSE_182MM_X_257MM = 62 ; // B5 (JIS) Transverse 182mm x 257mm
- public static final int PAPER_SIZE_QUATRO_215MM_X_275MM = 15 ; // Quarto 215mm x 275mm
- public static final int PAPER_SIZE_A3_EXTRA_322MM_X_445MM = 63 ; // A3 Extra 322mm x 445mm
- public static final int PAPER_SIZE_10Ax14_10_X_14 = 16 ; // 10x14 10" x 14"
- public static final int PAPER_SIZE_A5_EXTRA_174MM_X_235 = 64 ; // A5 Extra 174mm x 235mm
- public static final int PAPER_SIZE_11Ax17_11_X_17 = 17 ; // 11x17 11" x 17"
- public static final int PAPER_SIZE_B5_ISO_EXTRA_201MM_X_276MM = 65 ; // B5 (ISO) Extra 201mm x 276mm
- public static final int PAPER_SIZE_NOTE_8_5_X_11 = 18 ; // Note 81/2" x 11"
- public static final int PAPER_SIZE_A2_420MM_X_594MM = 66 ; // A2 420mm x 594mm
- public static final int PAPER_SIZE_ENVELOPE_9_3_78_X_8_78 = 19 ; // Envelope #9 37/8" x 87/8"
- public static final int PAPER_SIZE_A3_TRANSVERSE_297MM_X_420MM = 67 ; // A3 Transverse 297mm x 420mm
- public static final int PAPER_SIZE_ENVELOPE_10_4_18_X_9_5 = 20 ; // Envelope #10 41/8" x 91/2"
- public static final int PAPER_SIZE_EXTRA_TRANSVERSE_322MM_X_445MM = 68 ; // A3 Extra Transverse 322mm x 445mm
- public static final int PAPER_SIZE_ENVELOPE_11_4_5_X_10_38 = 21 ; // Envelope #11 41/2" x 103/8"
- public static final int PAPER_SIZE_DBL_JAP_POSTCARD_200MM_X_148MM = 69 ; // Dbl. Japanese Postcard 200mm x 148mm
- public static final int PAPER_SIZE_ENVELOPE_12_4_34_X_11 = 22 ; // Envelope #12 43/4" x 11"
- public static final int PAPER_SIZE_A6_105MM_X_148MM = 70 ; // A6 105mm x 148mm
- public static final int PAPER_SIZE_ENVELOPE_14_5_X_11_5 = 23 ; // Envelope #14 5" x 111/2"
- public static final int PAPER_SIZE_C_17_X_22_72 = 24 ; // C 17" x 22" 72
- public static final int PAPER_SIZE_D_22_X_34_73 = 25 ; // D 22" x 34" 73
- public static final int PAPER_SIZE_E_34_X_44_74 = 26 ; // E 34" x 44" 74
- public static final int PAPER_SIZE_DL_ENVELOPE_110MM_X_110MM_X_220MM = 27 ; // Envelope DL 110mm x 220mm
- public static final int PAPER_SIZE_LETTER_ROTATED_11_X_8_5 = 75 ; // Letter Rotated 11" x 81/2"
- public static final int PAPER_SIZE_ENVELOPE_C5_162MM_X_229M = 28 ; // Envelope C5 162mm x 229mm
- public static final int PAPER_SIZE_A3_ROTATED_420MM_X_297MM = 76 ; // A3 Rotated 420mm x 297mm
- public static final int PAPER_SIZE_ENVELOPE_C3_324MM_X_458MM = 29 ; // Envelope C3 324mm x 458mm
- public static final int PAPER_SIZE_A4_ROTATED_297MM_X_210MM = 77 ; // A4 Rotated 297mm x 210mm
- public static final int PAPER_SIZE_ENVELOPE_C4_229MM_X_324MM = 30 ; // Envelope C4 229mm x 324mm
- public static final int PAPER_SIZE_A5_ROTATED_210MM_X_148MM = 78 ; // A5 Rotated 210mm x 148mm
- public static final int PAPER_SIZE_ENVELOPE_C6_115MM_X_162MM = 31 ; // Envelope C6 114mm x 162mm
- public static final int PAPER_SIZE_ENVELOPE_C6_C5_114MM_X_229MM = 32 ; // Envelope C6/C5 114mm x 229mm
- public static final int PAPER_SIZE_B4_ISO_250MM_X_353MM = 33 ; // B4 (ISO) 250mm x 353mm
- public static final int PAPER_SIZE_B5_ISO_176MM_X_250MM = 34 ; // B5 (ISO) 176mm x 250mm
- public static final int PAPER_SIZE_DBL_JAP_POSTCARD_ROT_148MM_X_200MM = 82 ; // Dbl. Jap. Postcard Rot. 148mm x 200mm
- public static final int PAPER_SIZE_B6_ISO_125MM_X_176MM = 35 ; // B6 (ISO) 125mm x 176mm
- public static final int PAPER_SIZE_ENVELOPE_ITALY_10MM_X_230MM = 36 ; // Envelope Italy 110mm x 230mm 84
- public static final int PAPER_SIZE_ENVELOPE_MONARCH_3_7_8_X_7_5 = 37 ; // Envelope Monarch 37/8" x 71/2" 85
- public static final int PAPER_SIZE_6_3_4_ENVELOPE_3_5_8_X_6_5 = 38 ; // 63/4 Envelope 35/8" x 61/2" 86
- public static final int PAPER_SIZE_US_STANDARD_FANFOLD_147_8_X_11 = 39 ; // US Standard Fanfold 147/8" x 11" 87
- public static final int PAPER_SIZE_GERMAN_STD_FANFOLD_8_5_X_12 = 40 ; // German Std. Fanfold 81/2" x 12"
- public static final int PAPER_SIZE_GERMAN_LEGAL_FANFOLD_8_5_X_13 = 41 ; // German Legal Fanfold 81/2" x 13"
- // public static final int PAPER_SIZE_B4_ISO_250MM_X_353MM = 42 ; // B4 (ISO) 250mm x 353mm
- public static final int PAPER_SIZE_JAP_POSTCARD_100M_X_148MM = 43 ; // Japanese Postcard 100mm x 148mm
- public static final int PAPER_SIZE_9_X_11 = 44 ; // 9x11 9" x 11"
- public static final int PAPER_SIZE_10_X_11 = 45 ; // 10x11 10" x 11"
- public static final int PAPER_SIZE_15_X_11 = 46 ; // 15x11 15" x 11"
- public static final int PAPER_SIZE_ENVELOPE_INVITE_220MM_X_220MM = 47 ; // Envelope Invite 220mm x 220mm
- public static final int PAPER_SIZE_B4_JIS_ROTATED_364MM_X_257MM = 79 ; // B4 (JIS) Rotated 364mm x 257mm
- public static final int PAPER_SIZE_B5_JIS_ROTATED_257MMX_X_182MM = 80 ; // B5 (JIS) Rotated 257mm x 182mm
- public static final int PAPER_SIZE_JAP_POSTCARD_ROT_148MM_X_100MM = 81 ; // Japanese Postcard Rot. 148mm x 100mm
- public static final int PAPER_SIZE_A6_ROTATED_148MM_X_105MM = 83 ; // A6 Rotated 148mm x 105mm
- public static final int PAPER_SIZE_B6_JIS_128MM_X_182MM = 88 ; // B6 (JIS) 128mm x 182mm
- public static final int PAPER_SIZE_B6_JIS_ROT_182MM_X_128MM = 89 ; // B6 (JIS) Rotated 182mm x 128mm
- public static final int PAPER_SIZE_12_X_11 = 90 ; // 12x11 12" x 11"
-
- /**
- * default constructor
- */
- public PrinterSettingsHandle (Boundsheet sheet) {
- this.sheet = sheet;
-
- Iterator iter = sheet.getPrintRecs().iterator();
- while (iter.hasNext()) {
- BiffRec record = (BiffRec) iter.next();
-
- if (record instanceof Setup)
- printerSettings = (Setup) record;
- else if (record instanceof HCenter)
- hCenter = (HCenter) record;
- else if (record instanceof VCenter)
- vCenter = (VCenter) record;
- else if (record instanceof LeftMargin)
- leftMargin = (LeftMargin) record; // missing in default set of records
- else if (record instanceof RightMargin)
- rightMargin = (RightMargin) record; // missing in default set of records
- else if (record instanceof TopMargin)
- topMargin = (TopMargin) record; // missing in default set of records
- else if (record instanceof BottomMargin)
- bottomMargin = (BottomMargin) record; // missing in default set of records
- else if (record instanceof PrintGrid)
- grid = (PrintGrid) record;
- else if (record instanceof PrintRowCol)
- headers = (PrintRowCol) record;
- else if (record instanceof WsBool)
- wsBool = (WsBool) record;
- }
- // Actually, the below comment is incorrect: do NOT do this unconditionally
- //printerSettings.setNoPrintData(false); // there IS printer setup data
- }
-
- Boundsheet sheet;
-
- private Setup printerSettings;
- private HCenter hCenter;
- private VCenter vCenter;
- private LeftMargin leftMargin;
- private RightMargin rightMargin;
- private TopMargin topMargin;
- private BottomMargin bottomMargin;
- private PrintGrid grid;
- private PrintRowCol headers;
- private WsBool wsBool;
-
- // the following are unimplemented printer setting recs:
- // HORIZONTALPAGEBREAKS;
- // VERTICALPAGEBREAKS;
-
-
- /**
- * get the number of copies to print
- *
- * @return the number of copies
- */
- public short getCopies() {
- return printerSettings.getCopies();
- }
-
-
- /**
- * get the footer margin size in inches
- *
- * @return the footer margin in inches
- */
- public double getFooterMargin() {
- return printerSettings.getFooterMargin();
- }
-
- /**
- * get the header margin size in inches
- *
- * @return the header margin in inches
- */
- public double getHeaderMargin() {
- return printerSettings.getHeaderMargin();
- }
-
- /** Gets the left print margin. */
- public double getLeftMargin() {
- if (leftMargin==null) {
- leftMargin= new LeftMargin();
- this.sheet.addMarginRecord(leftMargin);
- }
- return leftMargin.getMargin();
- }
-
- /** Gets the right print margin. */
- public double getRightMargin() {
- if (rightMargin==null) {
- rightMargin= new RightMargin();
- this.sheet.addMarginRecord(rightMargin);
- }
- return rightMargin.getMargin();
- }
-
- /** Gets the top print margin. */
- public double getTopMargin() {
- if (topMargin==null) {
- topMargin= new TopMargin();
- this.sheet.addMarginRecord(topMargin);
- }
- return topMargin.getMargin();
- }
-
- /** Gets the bottom print margin. */
- public double getBottomMargin() {
- if (bottomMargin==null) {
- bottomMargin= new BottomMargin();
- this.sheet.addMarginRecord(bottomMargin);
- }
- return bottomMargin.getMargin();
- }
-
- /**
- * get the landscape orientation
- *
- * @return whether the print orientation is set to landscape
- *
- */
- public boolean getLandscape() {
- return printerSettings.getLandscape();
- }
-
- /**
- * get the left-to-right print orientation
- *
- * @return whether the print orientation is set to left-to-right
- */
- public boolean getLeftToRight() {
- return printerSettings.getLeftToRight();
- }
-
- /**
- * get whether printing is in black and white
- *
- * @return black and white
- */
- public boolean getNoColor() {
- return printerSettings.getNoColor();
- }
-
- /**
- * get whether to ignore orientation
- *
- * @return ignore orientation
- */
- public boolean getNoOrient() {
- return printerSettings.getNoOrient();
- }
-
- /**
- * get whether printer data is missing
- *
- * @return whether the printer data is missing
- */
- public boolean getNoPrintData() {
- return printerSettings.getNoPrintData();
- }
-
- /**
- * get the page to start printing from
- *
- * @return the page to start printing from
- *
- */
- public short getPageStart() {
- return printerSettings.getPageStart();
- }
-
- /**
- * Returns the paper size setting for the printer setup based on the
- * following table:
- *
- *
- *
- * @return paper size
- */
- public short getPaperSize() {
- return printerSettings.getPaperSize();
- }
-
- /**
- * @return
- * @return whether to print Notes.
- */
- public boolean getPrintNotes() {
- return printerSettings.getPrintNotes();
- }
-
-
- /**
- * get the print resolution
- *
- * @return the printer resolution in DPI
- */
- public short getResolution() {
- return printerSettings.getResolution();
- }
-
- /**
- * get the scale of the printer output in whole percentages
- *
- * ie: 25 = 25%
- *
- * @return the scale of printer output
- */
- public short getScale() {
- return printerSettings.getScale();
- }
-
- /**
- * use custom start page for auto numbering
- *
- * @return Returns whether to use a custom start page
- */
- public boolean getUsePage() {
- return printerSettings.getUsePage();
- }
-
- /**
- * get the vertical print resolution
- *
- * @return the vertical printer resolution in DPI
- */
- public short getVerticalResolution() {
- return printerSettings.getVerticalResolution();
- }
-
- /** Whether the sheet should be centered horizontally. */
- public boolean isHCenter() {
- return hCenter.isHCenter();
- }
-
- /** Whether the sheet should be centered vertically. */
- public boolean isVCenter() {
- return vCenter.isVCenter();
- }
-
- /** Whether the grid lines will be printed. */
- public boolean isPrintGridLines() {
- return grid.isPrintGrid();
- }
-
- /** Whether the row and column headers will be printed. */
- public boolean isPrintRowColHeaders() {
- return headers.isPrintHeaders();
- }
-
- /** Gets whether the sheet will be printed fit to some number of pages. */
- public boolean isFitToPage() {
- return wsBool.isFitToPage();
- }
-
- /**
- * set for draft quality output
- *
- * @param whether to use draft quality
- */
- public void setDraft(boolean b) {
- printerSettings.setDraft(b);
- }
-
- /**
- * Set the output to print onto this number of pages high
- *
- * ie: setFitHeight(10) will stretch the print out to fit 10
- * pages high
- *
- * @param number of pages to fit to height
- */
- public void setFitHeight(int numpages) {
- printerSettings.setFitHeight((short)numpages);
- }
-
- /**
- * Set the output to print onto this number of pages wide
- *
- * ie: setFitWidth(10) will stretch the print out to fit 10
- * pages wide
- *
- * @param number of pages to fit to width
- */
- public void setFitWidth(int numpages) {
- printerSettings.setFitWidth((short)numpages);
- }
-
- /** Sets whether the sheet will be printed fit to some number of pages. */
- public void setFitToPage (boolean value) {
- wsBool.setFitToPage( value );
- }
-
- /**
- * sets the footer margin in inches
- *
- * @param footer margin
- */
- public void setFooterMargin(double f) {
- printerSettings.setFooterMargin(f);
- }
-
- /** Sets whether the page should be centered horizontally. */
- public void setHCenter (boolean center) {
- hCenter.setHCenter( center );
- }
-
- /**
- * sets the Header margin in inches
- *
- * @param header margin
- */
- public void setHeaderMargin(double h) {
- printerSettings.setHeaderMargin(h);
- }
-
- /** Sets the sheet's left print margin. */
- public void setLeftMargin (double value) {
- if (leftMargin==null) {
- leftMargin= new LeftMargin();
- this.sheet.addMarginRecord(leftMargin);
- }
- leftMargin.setMargin( value );
- }
-
- /** Sets the sheet's right print margin. */
- public void setRightMargin (double value) {
- if (rightMargin==null) {
- rightMargin= new RightMargin();
- this.sheet.addMarginRecord(rightMargin);
- }
- rightMargin.setMargin( value );
- }
-
- /** Sets the sheet's top print margin. */
- public void setTopMargin (double value) {
- if (topMargin==null) {
- topMargin= new TopMargin();
- this.sheet.addMarginRecord(topMargin);
- }
- topMargin.setMargin( value );
- }
-
- /** Sets the sheet's bottom print margin. */
- public void setBottomMargin (double value) {
- if (bottomMargin==null) {
- bottomMargin= new BottomMargin();
- this.sheet.addMarginRecord(bottomMargin);
- }
- bottomMargin.setMargin( value );
- }
-
- /**
- * set the print orientation to landscape or portrait
- *
- * @param landscape
- */
- public void setLandscape(boolean b) {
- printerSettings.setNoOrient(false); // use the orientation setting
- printerSettings.setLandscape(b);
- }
-
- /**
- * set the print orientation to left-to-right printing
- *
- * @param leftToRight
- */
- public void setLeftToRight(boolean b) {
- printerSettings.setLeftToRight(b);
- }
-
- /**
- * sets the output to black and white
- *
- * @param noColor
- */
- public void setNoColor(boolean b) {
- printerSettings.setNoColor(b);
- }
-
- /**
- * set the default page to start printing from
- *
- * @param p
- */
- public void setPageStart(short p) {
- printerSettings.setPageStart(p);
- }
-
- /**
- * sets the whether to print cell notes
- *
- * @param printNotes whether to print Notes.
- */
- public void setPrintNotes(boolean b) {
- printerSettings.setPrintNotes(b);
- }
-
- /**
- * Set the output printer resolution
- *
- * @param resolution The resolution to set in DPI.
- */
- public void setResolution(int r) {
- printerSettings.setResolution((short)r);
- }
-
- /**
- * scale the printer output in whole percentages
- *
- * ie: 25 = 25%
- *
- * @param scale The scale to set.
- */
- public void setScale(int scale) {
- printerSettings.setScale((short)scale);
- }
-
- /**
- * @param usePage whether to use custom Page to start printing from.
- */
- public void setUsePage(boolean usePage) {
- printerSettings.setUsePage(usePage);
- }
-
- /**
- * @param verticalResolution The vertical Resolution in DPI
- */
- public void setVerticalResolution(short verticalResolution) {
- printerSettings.setVerticalResolution(verticalResolution);
- }
-
- /**
- * @param copies The number of copies to print
- */
- public void setCopies(int copies) {
- printerSettings.setCopies((short)copies);
- }
-
- /**
- * sets the paper size based on the paper size table
- *
- * @param the paper size index
- */
- public void setPaperSize(int p) {
- printerSettings.setPaperSize((short)p);
- }
-
- /**
- * get the draft quality setting
- *
- * @return draft quality
- */
- public boolean getDraft() {
- return printerSettings.getDraft();
- }
-
- /**
- * get the number of pages to fit the printout to height
- *
- * @return fit to height
- */
- public short getFitHeight() {
- return printerSettings.getFitHeight();
- }
-
- /**
- * get the number of pages to fit the printout to width
- *
- * @return fit to width
- */
- public short getFitWidth() {
- return printerSettings.getFitWidth();
- }
-
- /** Sets whether the sheet should be centered vertically. */
- public void setVCenter (boolean center) {
- vCenter.setVCenter( center );
- }
-
- /** Sets whether to print the grid lines. */
- public void setPrintGrid (boolean print) {
- grid.setPrintGrid( print );
- }
-
- /** Sets whether to print the row and column headers. */
- public void setPrintRowColHeaders (boolean print) {
- headers.setPrintHeaders( print );
- }
-
- /** Gets the range specifying the titles printed on each page.
- */
- public String getTitles() {
- Name range = sheet.getName( "Built-in: PRINT_TITLES" );
- if (range == null) return null;
- return range.getExpressionString();
- }
-
- /** Sets the range specifying the titles printed on each page.
- * The reference for the row(s) to repeat e.g. $1:$1 for row 1
- * For Columns, type the reference to the column or columns that
- * you want to set as a title e.g. $A:$B for columns A and B
- */
- // note: MUST be in $ROW:$ROW or $COL:$COL format, for both
- // can be $R:$R, $C:$C for both
- public void setTitles (String range) {
- Name name = sheet.getName( "Built-in: PRINT_TITLES" );
- if (name == null) try {
- name = new Name( sheet.getWorkBook(), "Print_Titles" );
- name.setBuiltIn( (byte)0x07 ); //do before setNewScope as it blows out itab
- name.setNewScope( sheet.getSheetNum() + 1 );
- } catch (WorkSheetNotFoundException e) {
- // This shouldn't be possible.
- throw new Error ("sheet not found re-scoping name");
- }
- // pre-process range to ensure in proper format, ensure all absolute ($) refs +
- // handle wholerow-wholecol refs + complex ranges
- if (range==null) return; // TODO: Do what?? remove??
- String[] ranges= range.split(",");
- range= "";
- for (int i= 0; i < ranges.length; i++) {
- if (i > 0) // concatenate terms into one ptgmemfunc-style expression
- range+=",";
- String r= "";
- int[] rc= ExcelTools.getRangeCoords(ranges[i]);
- if (rc[0]==rc[2]) // varies by column
- r= "$" + ExcelTools.getAlphaVal(rc[1]) + ":$" + ExcelTools.getAlphaVal(rc[3]);
- if (rc[1]==rc[3]) {// varies by row
- r= "$" + rc[0] + ":$" + rc[2];
- }
- range+= sheet.getSheetName() + "!" + r;
- }
- name.setLocation( range );
-}
-
-}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/PrinterSettingsHandle.kt b/src/main/java/io/starter/OpenXLS/PrinterSettingsHandle.kt
new file mode 100644
index 0000000..a342bf1
--- /dev/null
+++ b/src/main/java/io/starter/OpenXLS/PrinterSettingsHandle.kt
@@ -0,0 +1,703 @@
+/*
+ * --------- BEGIN COPYRIGHT NOTICE ---------
+ * Copyright 2002-2012 Extentech Inc.
+ * Copyright 2013 Infoteria America Corp.
+ *
+ * This file is part of OpenXLS.
+ *
+ * OpenXLS is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * OpenXLS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with OpenXLS. If not, see
+ *
+ * ...
+ * PrinterSettingsHandle printersetup = sheet.getPrinterSettings();
+ * // Paper Size
+ * printersetup.setPaperSize(PrinterSettingsHandle.PAPER_SIZE_LEDGER_17x11);
+ * // Scaling
+ * printersetup.setScale(125);
+ * // resolution
+ * printersetup.setResolution(300);
+ * ...
+ *
+ */
+/* order of records in Page Settings Block:
+ * HORIZONTALPAGEBREAKS
+ VERTICALPAGEBREAKS
+ HEADER
+ FOOTER
+ HCENTER
+ VCENTER
+ LEFTMARGIN
+ RIGHTMARGIN
+ TOPMARGIN
+ BOTTOMMARGIN
+ PLS
+ SETUP
+ BITMAP
+ *
+ */
+class PrinterSettingsHandle
+/**
+ * default constructor
+ */
+(internal var sheet: Boundsheet) : Handle {
+
+ private var printerSettings: Setup? = null
+ private var hCenter: HCenter? = null
+ private var vCenter: VCenter? = null
+ private var leftMargin: LeftMargin? = null
+ private var rightMargin: RightMargin? = null
+ private var topMargin: TopMargin? = null
+ private var bottomMargin: BottomMargin? = null
+ private var grid: PrintGrid? = null
+ private var headers: PrintRowCol? = null
+ private var wsBool: WsBool? = null
+
+ // the following are unimplemented printer setting recs:
+ // HORIZONTALPAGEBREAKS;
+ // VERTICALPAGEBREAKS;
+
+
+ /**
+ * get the number of copies to print
+ *
+ * @return the number of copies
+ */
+ val copies: Short
+ get() = printerSettings!!.copies
+
+
+ /**
+ * get the footer margin size in inches
+ *
+ * @return the footer margin in inches
+ */
+ /**
+ * sets the footer margin in inches
+ *
+ * @param footer margin
+ */
+ var footerMargin: Double
+ get() = printerSettings!!.footerMargin
+ set(f) {
+ printerSettings!!.footerMargin = f
+ }
+
+ /**
+ * get the header margin size in inches
+ *
+ * @return the header margin in inches
+ */
+ /**
+ * sets the Header margin in inches
+ *
+ * @param header margin
+ */
+ var headerMargin: Double
+ get() = printerSettings!!.headerMargin
+ set(h) {
+ printerSettings!!.headerMargin = h
+ }
+
+ /**
+ * get the landscape orientation
+ *
+ * @return whether the print orientation is set to landscape
+ */
+ /**
+ * set the print orientation to landscape or portrait
+ *
+ * @param landscape
+ */
+ // use the orientation setting
+ var landscape: Boolean
+ get() = printerSettings!!.landscape
+ set(b) {
+ printerSettings!!.noOrient = false
+ printerSettings!!.landscape = b
+ }
+
+ /**
+ * get the left-to-right print orientation
+ *
+ * @return whether the print orientation is set to left-to-right
+ */
+ /**
+ * set the print orientation to left-to-right printing
+ *
+ * @param leftToRight
+ */
+ var leftToRight: Boolean
+ get() = printerSettings!!.leftToRight
+ set(b) {
+ printerSettings!!.leftToRight = b
+ }
+
+ /**
+ * get whether printing is in black and white
+ *
+ * @return black and white
+ */
+ /**
+ * sets the output to black and white
+ *
+ * @param noColor
+ */
+ var noColor: Boolean
+ get() = printerSettings!!.noColor
+ set(b) {
+ printerSettings!!.noColor = b
+ }
+
+ /**
+ * get whether to ignore orientation
+ *
+ * @return ignore orientation
+ */
+ val noOrient: Boolean
+ get() = printerSettings!!.noOrient
+
+ /**
+ * get whether printer data is missing
+ *
+ * @return whether the printer data is missing
+ */
+ val noPrintData: Boolean
+ get() = printerSettings!!.noPrintData
+
+ /**
+ * get the page to start printing from
+ *
+ * @return the page to start printing from
+ */
+ /**
+ * set the default page to start printing from
+ *
+ * @param p
+ */
+ var pageStart: Short
+ get() = printerSettings!!.pageStart
+ set(p) {
+ printerSettings!!.pageStart = p
+ }
+
+ /**
+ * Returns the paper size setting for the printer setup based on the
+ * following table:
+ *
+ * @return paper size
+ */
+ val paperSize: Short
+ get() = printerSettings!!.paperSize
+
+ /**
+ * @return whether to print Notes.
+ */
+ /**
+ * sets the whether to print cell notes
+ *
+ * @param printNotes whether to print Notes.
+ */
+ var printNotes: Boolean
+ get() = printerSettings!!.printNotes
+ set(b) {
+ printerSettings!!.printNotes = b
+ }
+
+
+ /**
+ * get the print resolution
+ *
+ * @return the printer resolution in DPI
+ */
+ val resolution: Short
+ get() = printerSettings!!.resolution
+
+ /**
+ * get the scale of the printer output in whole percentages
+ *
+ *
+ * ie: 25 = 25%
+ *
+ * @return the scale of printer output
+ */
+ val scale: Short
+ get() = printerSettings!!.scale
+
+ /**
+ * use custom start page for auto numbering
+ *
+ * @return Returns whether to use a custom start page
+ */
+ /**
+ * @param usePage whether to use custom Page to start printing from.
+ */
+ var usePage: Boolean
+ get() = printerSettings!!.usePage
+ set(usePage) {
+ printerSettings!!.usePage = usePage
+ }
+
+ /**
+ * get the vertical print resolution
+ *
+ * @return the vertical printer resolution in DPI
+ */
+ /**
+ * @param verticalResolution The vertical Resolution in DPI
+ */
+ var verticalResolution: Short
+ get() = printerSettings!!.verticalResolution
+ set(verticalResolution) {
+ printerSettings!!.verticalResolution = verticalResolution
+ }
+
+ /**
+ * Whether the sheet should be centered horizontally.
+ */
+ /**
+ * Sets whether the page should be centered horizontally.
+ */
+ var isHCenter: Boolean
+ get() = hCenter!!.isHCenter
+ set(center) {
+ hCenter!!.isHCenter = center
+ }
+
+ /**
+ * Whether the sheet should be centered vertically.
+ */
+ /**
+ * Sets whether the sheet should be centered vertically.
+ */
+ var isVCenter: Boolean
+ get() = vCenter!!.isVCenter
+ set(center) {
+ vCenter!!.isVCenter = center
+ }
+
+ /**
+ * Whether the grid lines will be printed.
+ */
+ val isPrintGridLines: Boolean
+ get() = grid!!.isPrintGrid
+
+ /**
+ * Whether the row and column headers will be printed.
+ */
+ /**
+ * Sets whether to print the row and column headers.
+ */
+ var isPrintRowColHeaders: Boolean
+ get() = headers!!.isPrintHeaders
+ set(print) {
+ headers!!.isPrintHeaders = print
+ }
+
+ /**
+ * Gets whether the sheet will be printed fit to some number of pages.
+ */
+ /**
+ * Sets whether the sheet will be printed fit to some number of pages.
+ */
+ var isFitToPage: Boolean
+ get() = wsBool!!.isFitToPage
+ set(value) {
+ wsBool!!.isFitToPage = value
+ }
+
+ /**
+ * get the draft quality setting
+ *
+ * @return draft quality
+ */
+ /**
+ * set for draft quality output
+ *
+ * @param whether to use draft quality
+ */
+ var draft: Boolean
+ get() = printerSettings!!.draft
+ set(b) {
+ printerSettings!!.draft = b
+ }
+
+ /**
+ * get the number of pages to fit the printout to height
+ *
+ * @return fit to height
+ */
+ val fitHeight: Short
+ get() = printerSettings!!.fitHeight
+
+ /**
+ * get the number of pages to fit the printout to width
+ *
+ * @return fit to width
+ */
+ val fitWidth: Short
+ get() = printerSettings!!.fitWidth
+
+ /**
+ * Gets the range specifying the titles printed on each page.
+ */
+ /**
+ * Sets the range specifying the titles printed on each page.
+ * The reference for the row(s) to repeat e.g. $1:$1 for row 1
+ * For Columns, type the reference to the column or columns that
+ * you want to set as a title e.g. $A:$B for columns A and B
+ */
+ // note: MUST be in $ROW:$ROW or $COL:$COL format, for both
+ // can be $R:$R, $C:$C for both
+ //do before setNewScope as it blows out itab
+ // This shouldn't be possible.
+ // pre-process range to ensure in proper format, ensure all absolute ($) refs +
+ // handle wholerow-wholecol refs + complex ranges
+ // TODO: Do what?? remove??
+ // concatenate terms into one ptgmemfunc-style expression
+ // varies by column
+ // varies by row
+ var titles: String?
+ get() {
+ val range = sheet.getName("Built-in: PRINT_TITLES") ?: return null
+ return range.expressionString
+ }
+ set(range) {
+ var range = range
+ var name = sheet.getName("Built-in: PRINT_TITLES")
+ if (name == null)
+ try {
+ name = Name(sheet.workBook, "Print_Titles")
+ name.setBuiltIn(0x07.toByte())
+ name.setNewScope(sheet.sheetNum + 1)
+ } catch (e: WorkSheetNotFoundException) {
+ throw Error("sheet not found re-scoping name")
+ }
+
+ if (range == null) return
+ val ranges = range.split(",".toRegex()).dropLastWhile({ it.isEmpty() }).toTypedArray()
+ range = ""
+ for (i in ranges.indices) {
+ if (i > 0)
+ range += ","
+ var r = ""
+ val rc = ExcelTools.getRangeCoords(ranges[i])
+ if (rc[0] == rc[2])
+ r = "$" + ExcelTools.getAlphaVal(rc[1]) + ":$" + ExcelTools.getAlphaVal(rc[3])
+ if (rc[1] == rc[3]) {
+ r = "$" + rc[0] + ":$" + rc[2]
+ }
+ range += sheet.sheetName + "!" + r
+ }
+ name.location = range
+ }
+
+ init {
+
+ val iter = sheet.printRecs.iterator()
+ while (iter.hasNext()) {
+ val record = iter.next() as BiffRec
+
+ if (record is Setup)
+ printerSettings = record
+ else if (record is HCenter)
+ hCenter = record
+ else if (record is VCenter)
+ vCenter = record
+ else if (record is LeftMargin)
+ leftMargin = record // missing in default set of records
+ else if (record is RightMargin)
+ rightMargin = record // missing in default set of records
+ else if (record is TopMargin)
+ topMargin = record // missing in default set of records
+ else if (record is BottomMargin)
+ bottomMargin = record // missing in default set of records
+ else if (record is PrintGrid)
+ grid = record
+ else if (record is PrintRowCol)
+ headers = record
+ else if (record is WsBool)
+ wsBool = record
+ }
+ // Actually, the below comment is incorrect: do NOT do this unconditionally
+ //printerSettings.setNoPrintData(false); // there IS printer setup data
+ }
+
+ /**
+ * Gets the left print margin.
+ */
+ fun getLeftMargin(): Double {
+ if (leftMargin == null) {
+ leftMargin = LeftMargin()
+ this.sheet.addMarginRecord(leftMargin!!)
+ }
+ return leftMargin!!.margin
+ }
+
+ /**
+ * Gets the right print margin.
+ */
+ fun getRightMargin(): Double {
+ if (rightMargin == null) {
+ rightMargin = RightMargin()
+ this.sheet.addMarginRecord(rightMargin!!)
+ }
+ return rightMargin!!.margin
+ }
+
+ /**
+ * Gets the top print margin.
+ */
+ fun getTopMargin(): Double {
+ if (topMargin == null) {
+ topMargin = TopMargin()
+ this.sheet.addMarginRecord(topMargin!!)
+ }
+ return topMargin!!.margin
+ }
+
+ /**
+ * Gets the bottom print margin.
+ */
+ fun getBottomMargin(): Double {
+ if (bottomMargin == null) {
+ bottomMargin = BottomMargin()
+ this.sheet.addMarginRecord(bottomMargin!!)
+ }
+ return bottomMargin!!.margin
+ }
+
+ /**
+ * Set the output to print onto this number of pages high
+ *
+ *
+ * ie: setFitHeight(10) will stretch the print out to fit 10
+ * pages high
+ *
+ * @param number of pages to fit to height
+ */
+ fun setFitHeight(numpages: Int) {
+ printerSettings!!.fitHeight = numpages.toShort()
+ }
+
+ /**
+ * Set the output to print onto this number of pages wide
+ *
+ *
+ * ie: setFitWidth(10) will stretch the print out to fit 10
+ * pages wide
+ *
+ * @param number of pages to fit to width
+ */
+ fun setFitWidth(numpages: Int) {
+ printerSettings!!.fitWidth = numpages.toShort()
+ }
+
+ /**
+ * Sets the sheet's left print margin.
+ */
+ fun setLeftMargin(value: Double) {
+ if (leftMargin == null) {
+ leftMargin = LeftMargin()
+ this.sheet.addMarginRecord(leftMargin!!)
+ }
+ leftMargin!!.margin = value
+ }
+
+ /**
+ * Sets the sheet's right print margin.
+ */
+ fun setRightMargin(value: Double) {
+ if (rightMargin == null) {
+ rightMargin = RightMargin()
+ this.sheet.addMarginRecord(rightMargin!!)
+ }
+ rightMargin!!.margin = value
+ }
+
+ /**
+ * Sets the sheet's top print margin.
+ */
+ fun setTopMargin(value: Double) {
+ if (topMargin == null) {
+ topMargin = TopMargin()
+ this.sheet.addMarginRecord(topMargin!!)
+ }
+ topMargin!!.margin = value
+ }
+
+ /**
+ * Sets the sheet's bottom print margin.
+ */
+ fun setBottomMargin(value: Double) {
+ if (bottomMargin == null) {
+ bottomMargin = BottomMargin()
+ this.sheet.addMarginRecord(bottomMargin!!)
+ }
+ bottomMargin!!.margin = value
+ }
+
+ /**
+ * Set the output printer resolution
+ *
+ * @param resolution The resolution to set in DPI.
+ */
+ fun setResolution(r: Int) {
+ printerSettings!!.resolution = r.toShort()
+ }
+
+ /**
+ * scale the printer output in whole percentages
+ *
+ *
+ * ie: 25 = 25%
+ *
+ * @param scale The scale to set.
+ */
+ fun setScale(scale: Int) {
+ printerSettings!!.scale = scale.toShort()
+ }
+
+ /**
+ * @param copies The number of copies to print
+ */
+ fun setCopies(copies: Int) {
+ printerSettings!!.copies = copies.toShort()
+ }
+
+ /**
+ * sets the paper size based on the paper size table
+ *
+ * @param the paper size index
+ */
+ fun setPaperSize(p: Int) {
+ printerSettings!!.paperSize = p.toShort()
+ }
+
+ /**
+ * Sets whether to print the grid lines.
+ */
+ fun setPrintGrid(print: Boolean) {
+ grid!!.isPrintGrid = print
+ }
+
+ companion object {
+
+
+ // paper size ints
+ val PAPER_SIZE_UNDEFINED = 0
+ val PAPER_SIZE_LETTER_8_5x11 = 1 // Letter 81/2" x 11"
+ val PAPER_SIZE_LETTER_SMALL = 2 // Letter small 81/2" x 11"
+ val PAPER_SIZE_TABLOID_11x17 = 3 // Tabloid 11" x 17"
+ val PAPER_SIZE_LEDGER_17x11 = 4 // Ledger 17" x 11"
+ val PAPER_SIZE_LEGAL_8_5x14 = 5 // Legal 81/2" x 14"
+ val PAPER_SIZE_STATEMENT_5_5x8_5 = 6 // Statement 51/2" x 81/2"
+ val PAPER_SIZE_LETTER_EXTRA_9_5Ax12 = 50 // Letter Extra 91/2" x 12
+ val PAPER_SIZE_LEGAL_EXTRA_9_5Ax15 = 51 // Legal Extra 91/2" x 15"
+ val PAPER_SIZE_TABLOID_EXTRA_1111_16Ax18 = 52 // Tabloid Extra 1111/16" x 18"
+ val PAPER_SIZE_A4_EXTRA_235MM_X_322MM = 53 // A4 Extra 235mm x 322mm
+ val PAPER_SIZE_LETTER_TRANSVERSE_8_5Ax11 = 54 // Letter Transverse 81/2" x 11"
+ val PAPER_SIZE_EXECUTIVE_7_QUARTER_X_10_5 = 7 // Executive 71/4" x 101/2"
+ val PAPER_SIZE_TRANSVERSE_210MM_X_297MM = 55 // A4 Transverse 210mm x 297mm
+ val PAPER_SIZE_A3_297MM_X_420MM = 8 // 8 A3 297mm x 420mm
+ val PAPER_SIZE_LETTER_EXTRA_TRANSV_9_5_X_12 = 56 // 56 Letter Extra Transv. 91/2" x 12"
+ val PAPER_SIZE_A4_210MM_X_297MM = 9 // A4 210mm x 297mm
+ val PAPER_SIZE_SUPER_A_A4_227MM_X_356MM = 57 // Super A/A4 227mm x 356mm
+ val PAPER_SIZE_A4_SMALL_210MM_X_297MM = 10 // A4 small 210mm x 297mm
+ val PAPER_SIZE_SUPER_B_A3_305MM_X_487MM = 58 // Super B/A3 305mm x 487mm
+ val PAPER_SIZE_A5_148MM_X_210MM = 11 // A5 148mm x 210mm
+ val PAPER_SIZE_LETTER_PLUS = 59 // Letter Plus
+ val PAPER_SIZE_2_X_1211_16 = 81 // 2" x 1211/16"
+ val PAPER_SIZE_B4_JIS_257MM_X_364MM = 12 // B4 (JIS) 257mm x 364mm
+ val PAPER_SIZE_A4_PLUS_210MM_X_330MM = 60 // A4 Plus 210mm x 330mm
+ val PAPER_SIZE_B5_JIS_182MM_X_257MM = 13 // B5 (JIS) 182mm x 257mm
+ val PAPER_SIZE_A5_TRANSVERSE_148MM_X_210MM = 61 // A5 Transverse 148mm x 210mm
+ val PAPER_SIZE_FOLIO_8_5_X_13 = 14 // Folio 81/2" x 13"
+ val PAPER_SIZE_B5_JIS_TRANSVERSE_182MM_X_257MM = 62 // B5 (JIS) Transverse 182mm x 257mm
+ val PAPER_SIZE_QUATRO_215MM_X_275MM = 15 // Quarto 215mm x 275mm
+ val PAPER_SIZE_A3_EXTRA_322MM_X_445MM = 63 // A3 Extra 322mm x 445mm
+ val PAPER_SIZE_10Ax14_10_X_14 = 16 // 10x14 10" x 14"
+ val PAPER_SIZE_A5_EXTRA_174MM_X_235 = 64 // A5 Extra 174mm x 235mm
+ val PAPER_SIZE_11Ax17_11_X_17 = 17 // 11x17 11" x 17"
+ val PAPER_SIZE_B5_ISO_EXTRA_201MM_X_276MM = 65 // B5 (ISO) Extra 201mm x 276mm
+ val PAPER_SIZE_NOTE_8_5_X_11 = 18 // Note 81/2" x 11"
+ val PAPER_SIZE_A2_420MM_X_594MM = 66 // A2 420mm x 594mm
+ val PAPER_SIZE_ENVELOPE_9_3_78_X_8_78 = 19 // Envelope #9 37/8" x 87/8"
+ val PAPER_SIZE_A3_TRANSVERSE_297MM_X_420MM = 67 // A3 Transverse 297mm x 420mm
+ val PAPER_SIZE_ENVELOPE_10_4_18_X_9_5 = 20 // Envelope #10 41/8" x 91/2"
+ val PAPER_SIZE_EXTRA_TRANSVERSE_322MM_X_445MM = 68 // A3 Extra Transverse 322mm x 445mm
+ val PAPER_SIZE_ENVELOPE_11_4_5_X_10_38 = 21 // Envelope #11 41/2" x 103/8"
+ val PAPER_SIZE_DBL_JAP_POSTCARD_200MM_X_148MM = 69 // Dbl. Japanese Postcard 200mm x 148mm
+ val PAPER_SIZE_ENVELOPE_12_4_34_X_11 = 22 // Envelope #12 43/4" x 11"
+ val PAPER_SIZE_A6_105MM_X_148MM = 70 // A6 105mm x 148mm
+ val PAPER_SIZE_ENVELOPE_14_5_X_11_5 = 23 // Envelope #14 5" x 111/2"
+ val PAPER_SIZE_C_17_X_22_72 = 24 // C 17" x 22" 72
+ val PAPER_SIZE_D_22_X_34_73 = 25 // D 22" x 34" 73
+ val PAPER_SIZE_E_34_X_44_74 = 26 // E 34" x 44" 74
+ val PAPER_SIZE_DL_ENVELOPE_110MM_X_110MM_X_220MM = 27 // Envelope DL 110mm x 220mm
+ val PAPER_SIZE_LETTER_ROTATED_11_X_8_5 = 75 // Letter Rotated 11" x 81/2"
+ val PAPER_SIZE_ENVELOPE_C5_162MM_X_229M = 28 // Envelope C5 162mm x 229mm
+ val PAPER_SIZE_A3_ROTATED_420MM_X_297MM = 76 // A3 Rotated 420mm x 297mm
+ val PAPER_SIZE_ENVELOPE_C3_324MM_X_458MM = 29 // Envelope C3 324mm x 458mm
+ val PAPER_SIZE_A4_ROTATED_297MM_X_210MM = 77 // A4 Rotated 297mm x 210mm
+ val PAPER_SIZE_ENVELOPE_C4_229MM_X_324MM = 30 // Envelope C4 229mm x 324mm
+ val PAPER_SIZE_A5_ROTATED_210MM_X_148MM = 78 // A5 Rotated 210mm x 148mm
+ val PAPER_SIZE_ENVELOPE_C6_115MM_X_162MM = 31 // Envelope C6 114mm x 162mm
+ val PAPER_SIZE_ENVELOPE_C6_C5_114MM_X_229MM = 32 // Envelope C6/C5 114mm x 229mm
+ val PAPER_SIZE_B4_ISO_250MM_X_353MM = 33 // B4 (ISO) 250mm x 353mm
+ val PAPER_SIZE_B5_ISO_176MM_X_250MM = 34 // B5 (ISO) 176mm x 250mm
+ val PAPER_SIZE_DBL_JAP_POSTCARD_ROT_148MM_X_200MM = 82 // Dbl. Jap. Postcard Rot. 148mm x 200mm
+ val PAPER_SIZE_B6_ISO_125MM_X_176MM = 35 // B6 (ISO) 125mm x 176mm
+ val PAPER_SIZE_ENVELOPE_ITALY_10MM_X_230MM = 36 // Envelope Italy 110mm x 230mm 84
+ val PAPER_SIZE_ENVELOPE_MONARCH_3_7_8_X_7_5 = 37 // Envelope Monarch 37/8" x 71/2" 85
+ val PAPER_SIZE_6_3_4_ENVELOPE_3_5_8_X_6_5 = 38 // 63/4 Envelope 35/8" x 61/2" 86
+ val PAPER_SIZE_US_STANDARD_FANFOLD_147_8_X_11 = 39 // US Standard Fanfold 147/8" x 11" 87
+ val PAPER_SIZE_GERMAN_STD_FANFOLD_8_5_X_12 = 40 // German Std. Fanfold 81/2" x 12"
+ val PAPER_SIZE_GERMAN_LEGAL_FANFOLD_8_5_X_13 = 41 // German Legal Fanfold 81/2" x 13"
+ // public static final int PAPER_SIZE_B4_ISO_250MM_X_353MM = 42 ; // B4 (ISO) 250mm x 353mm
+ val PAPER_SIZE_JAP_POSTCARD_100M_X_148MM = 43 // Japanese Postcard 100mm x 148mm
+ val PAPER_SIZE_9_X_11 = 44 // 9x11 9" x 11"
+ val PAPER_SIZE_10_X_11 = 45 // 10x11 10" x 11"
+ val PAPER_SIZE_15_X_11 = 46 // 15x11 15" x 11"
+ val PAPER_SIZE_ENVELOPE_INVITE_220MM_X_220MM = 47 // Envelope Invite 220mm x 220mm
+ val PAPER_SIZE_B4_JIS_ROTATED_364MM_X_257MM = 79 // B4 (JIS) Rotated 364mm x 257mm
+ val PAPER_SIZE_B5_JIS_ROTATED_257MMX_X_182MM = 80 // B5 (JIS) Rotated 257mm x 182mm
+ val PAPER_SIZE_JAP_POSTCARD_ROT_148MM_X_100MM = 81 // Japanese Postcard Rot. 148mm x 100mm
+ val PAPER_SIZE_A6_ROTATED_148MM_X_105MM = 83 // A6 Rotated 148mm x 105mm
+ val PAPER_SIZE_B6_JIS_128MM_X_182MM = 88 // B6 (JIS) 128mm x 182mm
+ val PAPER_SIZE_B6_JIS_ROT_182MM_X_128MM = 89 // B6 (JIS) Rotated 182mm x 128mm
+ val PAPER_SIZE_12_X_11 = 90 // 12x11 12" x 11"
+ }
+
+}
\ No newline at end of file
diff --git a/src/main/java/io/starter/OpenXLS/RowHandle.java b/src/main/java/io/starter/OpenXLS/RowHandle.java
deleted file mode 100644
index 655aa00..0000000
--- a/src/main/java/io/starter/OpenXLS/RowHandle.java
+++ /dev/null
@@ -1,527 +0,0 @@
-/*
- * --------- BEGIN COPYRIGHT NOTICE ---------
- * Copyright 2002-2012 Extentech Inc.
- * Copyright 2013 Infoteria America Corp.
- *
- * This file is part of OpenXLS.
- *
- * OpenXLS is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation, either version 3 of
- * the License, or (at your option) any later version.
- *
- * OpenXLS is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with OpenXLS. If not, see
- *
- get a handle to the Cells in a row
-
- @see WorkBookHandle
- @see WorkSheetHandle
- @see FormulaHandle
-*/
-public class RowHandle {
- // FYI: do not change lightly -- these match Excel 2007 almost exactly
- public static int ROW_HEIGHT_DIVISOR = 17;
-
- public Row myRow;
- private FormatHandle formatter;
- private WorkBook wbh;
- private WorkSheetHandle wsh;
-
- protected RowHandle(Row c, WorkSheetHandle ws){
- myRow = c;
- wbh = ws.getWorkBook();
- wsh = ws;
- }
-
- /**
- * Return the row height of an existing row.
- *
- * These values are returned in twips, 1/20th of a character.
- *
- @return int Height of Row in twips
- */
- public int getHeight(){
- return myRow.getRowHeight();
- }
-
- /**
- * returns the row height in Excel units, which depends upon the default font
- * iAdjust= new ArrayList();
- ImageHandle[] images= myRow.getSheet().getImages();
- if(images!=null) {
- // for each image that falls over this row, trap index + original width -- to be reset after setting row height
- for (int z= 0; z < images.length; z++) {
- ImageHandle ih= images[z];
- int r0= ih.getRow();
- int r1= ih.getRow1();
- int row= myRow.getRowNumber();
- if (row>=r0 && row<=r1) {
- int h= ih.getHeight();
- iAdjust.add(new int[]{z,h});
- }
- }
- }
- myRow.setRowHeight(newHeight);
- for (int z= 0; z < iAdjust.size(); z++) {
- ImageHandle ih= images[((int[]) iAdjust.get(z))[0]];
- ih.setHeight(((int[]) iAdjust.get(z))[1]);
- }
-
- }
-
- /**
- * Determines if the row passes through
- * a vertical merge range
- *
- * @return
- */
- public boolean containsVerticalMergeRange() {
- CellHandle[] c = this.getCells();
- for (int i=0;i1)return true;
- }catch (Exception e) {};
- }
- }
- return false;
- }
- /** sets the default format id for the Row's Cells
-
- @param int Format Id for all Cells in Row
- */
- public void setFormatId(int i){
- myRow.setIxfe(i);
- }
-
- /** Gets the FormatHandle for this Row.
-
- @return FormatHandle - a Format object to apply to this Row
-*/
- public FormatHandle getFormatHandle(){
- if(this.formatter==null)this.setFormatHandle();
- return this.formatter;
- }
-
-
- /**
- * Set up the format handle for this row
- *
- */
- private void setFormatHandle() {
- if(formatter!=null)return;
- formatter = new FormatHandle(wbh, this.getFormatId());
- formatter.setRowHandle(this);
- }
-
- /** gets the current default row format id. May be overwritten by contained cells
- *
- * @return format id of row
- */
- public int getFormatId(){
- if(myRow.getExplicitFormatSet())return myRow.getIxfe();
- return this.getWorkBook().getWorkBook().getDefaultIxfe();
- }
-
- /** Returns the array of Cells in this Row
-
- @return Cell[] all Cells in this Row
- @param cache cellhandles flag
- */
- public CellHandle[] getCells(boolean cached){
- Collection ct = myRow.getCells();
- Iterator it = ct.iterator();
- CellHandle[] ch = new CellHandle[ct.size()];
- int t = 0;
- Mulblank aMul= null;
- short c= -1;
- while(it.hasNext()) {
- BiffRec rc = (BiffRec)it.next();
- try{ // use cache of Cellhandles!
- if (rc.getOpcode()!=XLSConstants.MULBLANK) {
- ch[t] = this.wsh.getCell(rc.getRowNumber(), rc.getColNumber(), cached);
- } else {
- // handle Mulblanks: ref a range of cells; to get correct cell address,
- // traverse thru range and set cellhandle ref to correct column
- if (rc==aMul) {
- c++;
- } else {
- aMul= (Mulblank)rc;
- c= (short)aMul.getColFirst();
- }
- ch[t]= this.wsh.getCell(rc.getRowNumber(), c, cached);
- }
- }catch(CellNotFoundException cnfe){
- rc.setXFRecord();
- ch[t] = new CellHandle(rc,null);
- ch[t].setWorkSheetHandle(null); //TODO: implement if causing grief -jm
- if (rc.getOpcode()==XLSConstants.MULBLANK) {
- // handle Mulblanks: ref a range of cells; to get correct cell address,
- // traverse thru range and set cellhandle ref to correct column
- if (rc==aMul) {
- c++;
- } else {
- aMul= (Mulblank)rc;
- c= (short)aMul.getColFirst();
- }
- ch[t].setBlankRef(c); // for Mulblank use only -sets correct column reference for multiple blank cells ...
- }
-
- }
- t++;
- }
- return ch;
- }
-
- /** Returns the array of Cells in this Row
-
- @return Cell[] all Cells in this Row
- */
- public CellHandle[] getCells(){
- return getCells(false); // don't use cache
- }
-
-
- /**
- * Get the JSON object for this row.
- *
- * @return
- */
- public String getJSON() {
- return getJSON( 255 ).toString();
- }
-
- public JSONObject getJSON (int maxcols) {
- JSONObject theRange = new JSONObject();
- JSONArray cells = new JSONArray();
- try {
- theRange.put(JSON_ROW, getRowNumber());
-
- theRange.put( JSON_ROW_BORDER_TOP, getHasAnyThickTopBorder() );
- theRange.put( JSON_ROW_BORDER_BOTTOM, getHasAnyBottomBorder() );
- if (getFormatId()!=getWorkBook().getWorkBook().getDefaultIxfe())theRange.put("xf", getFormatId());
- theRange.put(JSON_HEIGHT, (getHeight()/ROW_HEIGHT_DIVISOR)+5); // the default is TOO SMALL!
- CellHandle[] chandles = getCells(false);
- for (int i=0;i | |