195 lines
6.3 KiB
Java
195 lines
6.3 KiB
Java
/* ====================================================================
|
|
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.formula;
|
|
|
|
import org.apache.poi.hssf.record.RecordInputStream;
|
|
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
|
import org.apache.poi.hssf.util.CellReference;
|
|
import org.apache.poi.hssf.util.RangeAddress;
|
|
import org.apache.poi.hssf.util.SheetReferences;
|
|
import org.apache.poi.util.BitField;
|
|
import org.apache.poi.util.BitFieldFactory;
|
|
import org.apache.poi.util.LittleEndian;
|
|
|
|
/**
|
|
* Title: Reference 3D Ptg <P>
|
|
* Description: Defined a cell in extern sheet. <P>
|
|
* REFERENCE: <P>
|
|
* @author Libin Roman (Vista Portal LDT. Developer)
|
|
* @author Jason Height (jheight at chariot dot net dot au)
|
|
* @version 1.0-pre
|
|
*/
|
|
public final class Ref3DPtg extends OperandPtg {
|
|
public final static byte sid = 0x3a;
|
|
private final static int SIZE = 7; // 6 + 1 for Ptg
|
|
private short field_1_index_extern_sheet;
|
|
/** The row index - zero based unsigned 16 bit value */
|
|
private int field_2_row;
|
|
/** Field 2
|
|
* - lower 8 bits is the zero based unsigned byte column index
|
|
* - bit 16 - isRowRelative
|
|
* - bit 15 - isColumnRelative
|
|
*/
|
|
private int field_3_column;
|
|
private BitField rowRelative = BitFieldFactory.getInstance(0x8000);
|
|
private BitField colRelative = BitFieldFactory.getInstance(0x4000);
|
|
|
|
/** Creates new AreaPtg */
|
|
public Ref3DPtg() {}
|
|
|
|
public Ref3DPtg(RecordInputStream in) {
|
|
field_1_index_extern_sheet = in.readShort();
|
|
field_2_row = in.readShort();
|
|
field_3_column = in.readShort();
|
|
}
|
|
|
|
public Ref3DPtg(String cellref, short externIdx ) {
|
|
CellReference c= new CellReference(cellref);
|
|
setRow(c.getRow());
|
|
setColumn(c.getCol());
|
|
setColRelative(!c.isColAbsolute());
|
|
setRowRelative(!c.isRowAbsolute());
|
|
setExternSheetIndex(externIdx);
|
|
}
|
|
|
|
public String toString() {
|
|
CellReference cr = new CellReference(getRow(), getColumn(), !isRowRelative(),!isColRelative());
|
|
StringBuffer sb = new StringBuffer();
|
|
sb.append(getClass().getName());
|
|
sb.append(" [");
|
|
sb.append("sheetIx=").append(getExternSheetIndex());
|
|
sb.append(" ! ");
|
|
sb.append(cr.formatAsString());
|
|
sb.append("]");
|
|
return sb.toString();
|
|
}
|
|
|
|
public void writeBytes(byte [] array, int offset) {
|
|
array[ 0 + offset ] = (byte) (sid + getPtgClass());
|
|
LittleEndian.putShort(array, 1 + offset , getExternSheetIndex());
|
|
LittleEndian.putShort(array, 3 + offset , (short)getRow());
|
|
LittleEndian.putShort(array, 5 + offset , (short)getColumnRaw());
|
|
}
|
|
|
|
public int getSize() {
|
|
return SIZE;
|
|
}
|
|
|
|
public short getExternSheetIndex(){
|
|
return field_1_index_extern_sheet;
|
|
}
|
|
|
|
public void setExternSheetIndex(short index){
|
|
field_1_index_extern_sheet = index;
|
|
}
|
|
|
|
public int getRow() {
|
|
return field_2_row;
|
|
}
|
|
|
|
public void setRow(int row) {
|
|
field_2_row = row;
|
|
}
|
|
|
|
public int getColumn() {
|
|
return field_3_column & 0xFF;
|
|
}
|
|
|
|
public int getColumnRaw() {
|
|
return field_3_column;
|
|
}
|
|
|
|
public boolean isRowRelative()
|
|
{
|
|
return rowRelative.isSet(field_3_column);
|
|
}
|
|
|
|
public void setRowRelative(boolean rel) {
|
|
field_3_column=rowRelative.setBoolean(field_3_column,rel);
|
|
}
|
|
|
|
public boolean isColRelative()
|
|
{
|
|
return colRelative.isSet(field_3_column);
|
|
}
|
|
|
|
public void setColRelative(boolean rel) {
|
|
field_3_column=colRelative.setBoolean(field_3_column,rel);
|
|
}
|
|
public void setColumn(short column) {
|
|
field_3_column &= 0xFF00;
|
|
field_3_column |= column & 0xFF;
|
|
}
|
|
|
|
public void setColumnRaw(short column) {
|
|
field_3_column = column;
|
|
}
|
|
|
|
/* public String getArea(){
|
|
RangeAddress ra = new RangeAddress("");
|
|
|
|
String result = (ra.numTo26Sys(getColumn()) + (getRow() + 1));
|
|
|
|
return result;
|
|
}*/
|
|
|
|
public void setArea(String ref){
|
|
RangeAddress ra = new RangeAddress(ref);
|
|
|
|
String from = ra.getFromCell();
|
|
|
|
setColumn((short) (ra.getXPosition(from) -1));
|
|
setRow((short) (ra.getYPosition(from) -1));
|
|
|
|
}
|
|
|
|
// TODO - find a home for this method
|
|
// There is already a method on HSSFWorkbook called getSheetName but it seems to do something different.
|
|
static String getSheetName(HSSFWorkbook book, int externSheetIndex) {
|
|
// TODO - there are 3 ways this method can return null. Is each valid?
|
|
if (book == null) {
|
|
return null;
|
|
}
|
|
|
|
SheetReferences refs = book.getSheetReferences();
|
|
if (refs == null) {
|
|
return null;
|
|
}
|
|
return refs.getSheetName(externSheetIndex);
|
|
}
|
|
/**
|
|
* @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(HSSFWorkbook book)
|
|
{
|
|
StringBuffer retval = new StringBuffer();
|
|
String sheetName = getSheetName(book, field_1_index_extern_sheet);
|
|
if(sheetName != null) {
|
|
SheetNameFormatter.appendFormat(retval, sheetName);
|
|
retval.append( '!' );
|
|
}
|
|
retval.append((new CellReference(getRow(),getColumn(),!isRowRelative(),!isColRelative())).formatAsString());
|
|
return retval.toString();
|
|
}
|
|
|
|
public byte getDefaultOperandClass() {
|
|
return Ptg.CLASS_REF;
|
|
}
|
|
}
|