123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- /* ====================================================================
- 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 java.util.Map;
- import java.util.function.Supplier;
-
- import org.apache.poi.hssf.util.CellRangeAddress8Bit;
- import org.apache.poi.ss.formula.Formula;
- import org.apache.poi.ss.formula.ptg.Ptg;
- import org.apache.poi.util.GenericRecordUtil;
- import org.apache.poi.util.LittleEndianOutput;
-
- /**
- * ARRAY (0x0221)<p>
- *
- * Treated in a similar way to SharedFormulaRecord
- */
- public final class ArrayRecord extends SharedValueRecordBase {
-
- public static final 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(ArrayRecord other) {
- super(other);
- _options = other._options;
- _field3notUsed = other._field3notUsed;
- _formula = (other._formula == null) ? null : other._formula.copy();
- }
-
- 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;
- }
-
- @Override
- public ArrayRecord copy() {
- return new ArrayRecord(this);
- }
-
- @Override
- public HSSFRecordTypes getGenericRecordType() {
- return HSSFRecordTypes.ARRAY;
- }
-
- @Override
- public Map<String, Supplier<?>> getGenericProperties() {
- return GenericRecordUtil.getGenericProperties(
- "range", this::getRange,
- "options", () -> _options,
- "notUsed", () -> _field3notUsed,
- "formula", () -> _formula
- );
- }
- }
|