| /* ==================================================================== |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| ==================================================================== */ |
| |
| package org.apache.poi.ss.formula.ptg; |
| |
| import java.util.Map; |
| import java.util.function.Supplier; |
| |
| import org.apache.poi.ss.formula.ExternSheetReferenceToken; |
| import org.apache.poi.ss.formula.FormulaRenderingWorkbook; |
| import org.apache.poi.ss.formula.WorkbookDependentFormula; |
| import org.apache.poi.ss.util.CellReference; |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.LittleEndianInput; |
| import org.apache.poi.util.LittleEndianOutput; |
| |
| /** |
| * Reference 3D Ptg<p> |
| * Defined a cell in extern sheet.<p> |
| * |
| * This is HSSF only, as it matches the HSSF file format way of |
| * referring to the sheet by an extern index. The XSSF equivalent |
| * is {@link Ref3DPxg} |
| */ |
| public final class Ref3DPtg extends RefPtgBase implements WorkbookDependentFormula, ExternSheetReferenceToken { |
| public static final byte sid = 0x3a; |
| |
| private static final int SIZE = 7; // 6 + 1 for Ptg |
| private int field_1_index_extern_sheet; |
| |
| public Ref3DPtg(Ref3DPtg other) { |
| super(other); |
| field_1_index_extern_sheet = other.field_1_index_extern_sheet; |
| } |
| |
| public Ref3DPtg(LittleEndianInput in) { |
| field_1_index_extern_sheet = in.readShort(); |
| readCoordinates(in); |
| } |
| |
| public Ref3DPtg(String cellref, int externIdx ) { |
| this(new CellReference(cellref), externIdx); |
| } |
| |
| public Ref3DPtg(CellReference c, int externIdx) { |
| super(c); |
| setExternSheetIndex(externIdx); |
| } |
| |
| public void write(LittleEndianOutput out) { |
| out.writeByte(sid + getPtgClass()); |
| out.writeShort(getExternSheetIndex()); |
| writeCoordinates(out); |
| } |
| |
| @Override |
| public byte getSid() { |
| return sid; |
| } |
| |
| public int getSize() { |
| return SIZE; |
| } |
| |
| public int getExternSheetIndex() { |
| return field_1_index_extern_sheet; |
| } |
| |
| public void setExternSheetIndex(int index) { |
| field_1_index_extern_sheet = index; |
| } |
| public String format2DRefAsString() { |
| return formatReferenceAsString(); |
| } |
| /** |
| * @return text representation of this cell reference that can be used in text |
| * formulas. The sheet name will get properly delimited if required. |
| */ |
| public String toFormulaString(FormulaRenderingWorkbook book) { |
| return ExternSheetNameResolver.prependSheetName(book, field_1_index_extern_sheet, formatReferenceAsString()); |
| } |
| public String toFormulaString() { |
| throw new RuntimeException("3D references need a workbook to determine formula text"); |
| } |
| |
| @Override |
| public Ref3DPtg copy() { |
| return new Ref3DPtg(this); |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties( |
| "base", super::getGenericProperties, |
| "externSheetIndex", this::getExternSheetIndex |
| ); |
| } |
| } |