/* ====================================================================
|
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.
|
==================================================================== */
|
|
namespace HH.WMS.Utils.NPOI.SS.Formula.PTG
|
{
|
using System;
|
using System.Text;
|
using HH.WMS.Utils.NPOI.Util;
|
using HH.WMS.Utils.NPOI.SS.Util;
|
using HH.WMS.Utils.NPOI.HSSF.Record;
|
|
|
|
/**
|
* Specifies a rectangular area of cells A1:A4 for instance.
|
* @author andy
|
* @author Jason Height (jheight at chariot dot net dot au)
|
*/
|
[Serializable]
|
public abstract class AreaPtgBase : OperandPtg, AreaI
|
{
|
/**
|
* TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
|
* see similar comment in ReferencePtg
|
*/
|
protected Exception NotImplemented()
|
{
|
return new NotImplementedException("Coding Error: This method should never be called. This ptg should be Converted");
|
}
|
protected AreaPtgBase()
|
{
|
// do nothing
|
}
|
|
/** zero based, Unsigned 16 bit */
|
private int field_1_first_row;
|
/** zero based, Unsigned 16 bit */
|
private int field_2_last_row;
|
/** zero based, Unsigned 8 bit */
|
private int field_3_first_column;
|
/** zero based, Unsigned 8 bit */
|
private int field_4_last_column;
|
|
private static BitField rowRelative = BitFieldFactory.GetInstance(0x8000);
|
private static BitField colRelative = BitFieldFactory.GetInstance(0x4000);
|
private static BitField columnMask = BitFieldFactory.GetInstance(0x3FFF);
|
|
protected AreaPtgBase(String arearef)
|
{
|
AreaReference ar = new AreaReference(arearef);
|
CellReference firstCell = ar.FirstCell;
|
CellReference lastCell = ar.LastCell;
|
FirstRow = firstCell.Row;
|
FirstColumn = firstCell.Col;
|
LastRow = lastCell.Row;
|
LastColumn = lastCell.Col;
|
IsFirstColRelative = !firstCell.IsColAbsolute;
|
IsLastColRelative = !lastCell.IsColAbsolute;
|
IsFirstRowRelative = !firstCell.IsRowAbsolute;
|
IsLastRowRelative = !lastCell.IsRowAbsolute;
|
}
|
protected AreaPtgBase(AreaReference ar)
|
{
|
CellReference firstCell = ar.FirstCell;
|
CellReference lastCell = ar.LastCell;
|
FirstRow = (firstCell.Row);
|
FirstColumn = (firstCell.Col == -1 ? 0 : (int)firstCell.Col);
|
LastRow = (lastCell.Row);
|
LastColumn = (lastCell.Col == -1 ? 0xFF : (int)lastCell.Col);
|
IsFirstColRelative = (!firstCell.IsColAbsolute);
|
IsLastColRelative = (!lastCell.IsColAbsolute);
|
IsFirstRowRelative = (!firstCell.IsRowAbsolute);
|
IsLastRowRelative = (!lastCell.IsRowAbsolute);
|
}
|
protected AreaPtgBase(int firstRow, int lastRow, int firstColumn, int lastColumn,
|
bool firstRowRelative, bool lastRowRelative, bool firstColRelative, bool lastColRelative)
|
{
|
|
CheckColumnBounds(firstColumn);
|
CheckColumnBounds(lastColumn);
|
CheckRowBounds(firstRow);
|
CheckRowBounds(lastRow);
|
FirstRow = firstRow;
|
LastRow = lastRow;
|
FirstColumn = firstColumn;
|
LastColumn = lastColumn;
|
IsFirstRowRelative = firstRowRelative;
|
IsLastRowRelative = lastRowRelative;
|
IsFirstColRelative = firstColRelative;
|
IsLastColRelative = lastColRelative;
|
}
|
protected void ReadCoordinates(ILittleEndianInput in1)
|
{
|
field_1_first_row = in1.ReadUShort();
|
field_2_last_row = in1.ReadUShort();
|
field_3_first_column = in1.ReadUShort();
|
field_4_last_column = in1.ReadUShort();
|
}
|
protected void WriteCoordinates(ILittleEndianOutput out1)
|
{
|
out1.WriteShort(field_1_first_row);
|
out1.WriteShort(field_2_last_row);
|
out1.WriteShort(field_3_first_column);
|
out1.WriteShort(field_4_last_column);
|
}
|
|
protected void WriteCoordinates(byte[] array, int offset)
|
{
|
LittleEndian.PutUShort(array, offset + 0, field_1_first_row);
|
LittleEndian.PutUShort(array, offset + 2, field_2_last_row);
|
LittleEndian.PutUShort(array, offset + 4, field_3_first_column);
|
LittleEndian.PutUShort(array, offset + 6, field_4_last_column);
|
}
|
private static void CheckColumnBounds(int colIx)
|
{
|
if ((colIx & 0x0FF) != colIx)
|
{
|
throw new ArgumentException("colIx (" + colIx + ") Is out of range");
|
}
|
}
|
private static void CheckRowBounds(int rowIx)
|
{
|
if ((rowIx & 0x0FFFF) != rowIx)
|
{
|
throw new ArgumentException("rowIx (" + rowIx + ") Is out of range");
|
}
|
}
|
|
protected AreaPtgBase(RecordInputStream in1)
|
{
|
field_1_first_row = in1.ReadUShort();
|
field_2_last_row = in1.ReadUShort();
|
field_3_first_column = in1.ReadUShort();
|
field_4_last_column = in1.ReadUShort();
|
}
|
|
/**
|
* @return the first row in the area
|
*/
|
public virtual int FirstRow
|
{
|
get { return field_1_first_row; }
|
set
|
{
|
CheckRowBounds(value);
|
field_1_first_row = value;
|
}
|
}
|
|
/**
|
* @return last row in the range (x2 in x1,y1-x2,y2)
|
*/
|
public virtual int LastRow
|
{
|
get { return field_2_last_row; }
|
set
|
{
|
CheckRowBounds(value);
|
field_2_last_row = value;
|
}
|
}
|
|
/**
|
* @return the first column number in the area.
|
*/
|
public virtual int FirstColumn
|
{
|
get { return columnMask.GetValue(field_3_first_column); }
|
set
|
{
|
CheckColumnBounds(value);
|
field_3_first_column = columnMask.SetValue(field_3_first_column, value);
|
}
|
}
|
|
|
/**
|
* @return whether or not the first row is a relative reference or not.
|
*/
|
public virtual bool IsFirstRowRelative
|
{
|
get { return rowRelative.IsSet(field_3_first_column); }
|
set { field_3_first_column = rowRelative.SetBoolean(field_3_first_column, value); }
|
}
|
|
/**
|
* @return Isrelative first column to relative or not
|
*/
|
public virtual bool IsFirstColRelative
|
{
|
get { return colRelative.IsSet(field_3_first_column); }
|
set { field_3_first_column = colRelative.SetBoolean(field_3_first_column, value); }
|
}
|
|
/**
|
* @return lastcolumn in the area
|
*/
|
public virtual int LastColumn
|
{
|
get { return columnMask.GetValue(field_4_last_column); }
|
set
|
{
|
CheckColumnBounds(value);
|
field_4_last_column = columnMask.SetValue(field_4_last_column, value);
|
}
|
}
|
|
/**
|
* @return last column and bitmask (the raw field)
|
*/
|
public virtual short LastColumnRaw
|
{
|
get
|
{
|
return (short)field_4_last_column;
|
}
|
}
|
|
/**
|
* @return last row relative or not
|
*/
|
public virtual bool IsLastRowRelative
|
{
|
get { return rowRelative.IsSet(field_4_last_column); }
|
set { field_4_last_column = rowRelative.SetBoolean(field_4_last_column, value); }
|
}
|
|
/**
|
* @return lastcol relative or not
|
*/
|
public virtual bool IsLastColRelative
|
{
|
get { return colRelative.IsSet(field_4_last_column); }
|
set { field_4_last_column = colRelative.SetBoolean(field_4_last_column, value); }
|
}
|
|
|
/**
|
* Set the last column irrespective of the bitmasks
|
*/
|
public void SetLastColumnRaw(short column)
|
{
|
field_4_last_column = column;
|
}
|
|
public override String ToFormulaString()
|
{
|
return FormatReferenceAsString();
|
}
|
|
public override byte DefaultOperandClass
|
{
|
get { return Ptg.CLASS_REF; }
|
}
|
|
protected String FormatReferenceAsString()
|
{
|
CellReference topLeft = new CellReference(FirstRow, FirstColumn, !IsFirstRowRelative, !IsFirstColRelative);
|
CellReference botRight = new CellReference(LastRow, LastColumn, !IsLastRowRelative, !IsLastColRelative);
|
|
if (AreaReference.IsWholeColumnReference(topLeft, botRight))
|
{
|
return (new AreaReference(topLeft, botRight)).FormatAsString();
|
}
|
return topLeft.FormatAsString() + ":" + botRight.FormatAsString();
|
}
|
}
|
}
|
