| /* ==================================================================== |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| ==================================================================== */ |
| |
| package org.apache.poi.hssf.record; |
| |
| import org.apache.poi.ss.formula.ptg.Ptg; |
| import org.apache.poi.hssf.util.CellRangeAddress8Bit; |
| import org.apache.poi.ss.formula.Formula; |
| import org.apache.poi.util.HexDump; |
| import org.apache.poi.util.LittleEndianOutput; |
| |
| /** |
| * ARRAY (0x0221)<p> |
| * |
| * Treated in a similar way to SharedFormulaRecord |
| */ |
| public final class ArrayRecord extends SharedValueRecordBase implements Cloneable { |
| |
| public final static short sid = 0x0221; |
| private static final int OPT_ALWAYS_RECALCULATE = 0x0001; |
| private static final int OPT_CALCULATE_ON_OPEN = 0x0002; |
| |
| private int _options; |
| private int _field3notUsed; |
| private Formula _formula; |
| |
| public ArrayRecord(RecordInputStream in) { |
| super(in); |
| _options = in.readUShort(); |
| _field3notUsed = in.readInt(); |
| int formulaTokenLen = in.readUShort(); |
| int totalFormulaLen = in.available(); |
| _formula = Formula.read(formulaTokenLen, in, totalFormulaLen); |
| } |
| |
| public ArrayRecord(Formula formula, CellRangeAddress8Bit range) { |
| super(range); |
| _options = 0; //YK: Excel 2007 leaves this field unset |
| _field3notUsed = 0; |
| _formula = formula; |
| } |
| |
| public boolean isAlwaysRecalculate() { |
| return (_options & OPT_ALWAYS_RECALCULATE) != 0; |
| } |
| public boolean isCalculateOnOpen() { |
| return (_options & OPT_CALCULATE_ON_OPEN) != 0; |
| } |
| |
| public Ptg[] getFormulaTokens() { |
| return _formula.getTokens(); |
| } |
| |
| protected int getExtraDataSize() { |
| return 2 + 4 + _formula.getEncodedSize(); |
| } |
| protected void serializeExtraData(LittleEndianOutput out) { |
| out.writeShort(_options); |
| out.writeInt(_field3notUsed); |
| _formula.serialize(out); |
| } |
| |
| public short getSid() { |
| return sid; |
| } |
| |
| public String toString() { |
| StringBuffer sb = new StringBuffer(); |
| sb.append(getClass().getName()).append(" [ARRAY]\n"); |
| sb.append(" range=").append(getRange()).append("\n"); |
| sb.append(" options=").append(HexDump.shortToHex(_options)).append("\n"); |
| sb.append(" notUsed=").append(HexDump.intToHex(_field3notUsed)).append("\n"); |
| sb.append(" formula:").append("\n"); |
| Ptg[] ptgs = _formula.getTokens(); |
| for (int i = 0; i < ptgs.length; i++) { |
| Ptg ptg = ptgs[i]; |
| sb.append(ptg).append(ptg.getRVAType()).append("\n"); |
| } |
| sb.append("]"); |
| return sb.toString(); |
| } |
| |
| @Override |
| public ArrayRecord clone() { |
| ArrayRecord rec = new ArrayRecord(_formula.copy(), getRange()); |
| |
| // they both seem unused, but clone them nevertheless to have an exact copy |
| rec._options = _options; |
| rec._field3notUsed = _field3notUsed; |
| |
| return rec; |
| } |
| } |