src/java/org/apache/poi/hssf/record/formula/AreaPtg.java

   1 /* ====================================================================
   2    Licensed to the Apache Software Foundation (ASF) under one or more
   3    contributor license agreements.  See the NOTICE file distributed with
   4    this work for additional information regarding copyright ownership.
   5    The ASF licenses this file to You under the Apache License, Version 2.0
   6    (the "License"); you may not use this file except in compliance with
   7    the License.  You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 ==================================================================== */
  17
  18
  19 package org.apache.poi.hssf.record.formula;
  20
  21 import org.apache.poi.util.LittleEndian;
  22 import org.apache.poi.util.BitField;
  23 import org.apache.poi.util.BitFieldFactory;
  24
  25 import org.apache.poi.hssf.util.AreaReference;
  26 import org.apache.poi.hssf.util.CellReference;
  27 import org.apache.poi.hssf.model.Workbook;
  28 import org.apache.poi.hssf.record.RecordInputStream;
  29
  30 /**
  31  * Specifies a rectangular area of cells A1:A4 for instance.
  32  * @author  andy
  33  * @author Jason Height (jheight at chariot dot net dot au)
  34  */
  35
  36 public class AreaPtg
  37     extends Ptg
  38 {
  39     public final static short sid  = 0x25;
  40     private final static int  SIZE = 9;
  41     private short             field_1_first_row;
  42     private short             field_2_last_row;
  43     private short             field_3_first_column;
  44     private short             field_4_last_column;
  45
  46     private final static BitField   rowRelative = BitFieldFactory.getInstance(0x8000);
  47     private final static BitField   colRelative = BitFieldFactory.getInstance(0x4000);
  48     private final static BitField   columnMask      = BitFieldFactory.getInstance(0x3FFF);
  49
  50     protected AreaPtg() {
  51       //Required for clone methods
  52     }
  53
  54     public AreaPtg(String arearef) {
  55         AreaReference ar = new AreaReference(arearef);
  56         setFirstRow((short)ar.getCells()[0].getRow());
  57         setFirstColumn((short)ar.getCells()[0].getCol());
  58         setLastRow((short)ar.getCells()[1].getRow());
  59         setLastColumn((short)ar.getCells()[1].getCol());
  60         setFirstColRelative(!ar.getCells()[0].isColAbsolute());
  61         setLastColRelative(!ar.getCells()[1].isColAbsolute());
  62         setFirstRowRelative(!ar.getCells()[0].isRowAbsolute());
  63         setLastRowRelative(!ar.getCells()[1].isRowAbsolute());
  64     }
  65
  66     public AreaPtg(short firstRow, short lastRow, short firstColumn, short lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative) {
  67       setFirstRow(firstRow);
  68       setLastRow(lastRow);
  69       setFirstColumn(firstColumn);
  70       setLastColumn(lastColumn);
  71       setFirstRowRelative(firstRowRelative);
  72       setLastRowRelative(lastRowRelative);
  73       setFirstColRelative(firstColRelative);
  74       setLastColRelative(lastColRelative);
  75     }
  76
  77     public AreaPtg(RecordInputStream in)
  78     {
  79         field_1_first_row    = in.readShort();
  80         field_2_last_row     = in.readShort();
  81         field_3_first_column = in.readShort();
  82         field_4_last_column  = in.readShort();
  83         //System.out.println(toString());
  84     }
  85
  86     public String getAreaPtgName() {
  87       return "AreaPtg";
  88     }
  89
  90     public String toString()
  91     {
  92         StringBuffer buffer = new StringBuffer();
  93
  94         buffer.append(getAreaPtgName());
  95         buffer.append("\n");
  96         buffer.append("firstRow = " + getFirstRow()).append("\n");
  97         buffer.append("lastRow  = " + getLastRow()).append("\n");
  98         buffer.append("firstCol = " + getFirstColumn()).append("\n");
  99         buffer.append("lastCol  = " + getLastColumn()).append("\n");
 100         buffer.append("firstColRowRel= "
 101                       + isFirstRowRelative()).append("\n");
 102         buffer.append("lastColRowRel = "
 103                       + isLastRowRelative()).append("\n");
 104         buffer.append("firstColRel   = " + isFirstColRelative()).append("\n");
 105         buffer.append("lastColRel    = " + isLastColRelative()).append("\n");
 106         return buffer.toString();
 107     }
 108
 109     public void writeBytes(byte [] array, int offset) {
 110         array[offset] = (byte) (sid + ptgClass);
 111         LittleEndian.putShort(array,offset+1,field_1_first_row);
 112         LittleEndian.putShort(array,offset+3,field_2_last_row);
 113         LittleEndian.putShort(array,offset+5,field_3_first_column);
 114         LittleEndian.putShort(array,offset+7,field_4_last_column);
 115     }
 116
 117     public int getSize()
 118     {
 119         return SIZE;
 120     }
 121
 122     /**
 123      * @return the first row in the area
 124      */
 125     public short getFirstRow()
 126     {
 127         return field_1_first_row;
 128     }
 129
 130     /**
 131      * sets the first row
 132      * @param row number (0-based)
 133      */
 134     public void setFirstRow(short row)
 135     {
 136         field_1_first_row = row;
 137     }
 138
 139     /**
 140      * @return last row in the range (x2 in x1,y1-x2,y2)
 141      */
 142     public short getLastRow()
 143     {
 144         return field_2_last_row;
 145     }
 146
 147     /**
 148      * @param row last row number in the area
 149      */
 150     public void setLastRow(short row)
 151     {
 152         field_2_last_row = row;
 153     }
 154
 155     /**
 156      * @return the first column number in the area.
 157      */
 158     public short getFirstColumn()
 159     {
 160         return columnMask.getShortValue(field_3_first_column);
 161     }
 162
 163     /**
 164      * @return the first column number + the options bit settings unstripped
 165      */
 166     public short getFirstColumnRaw()
 167     {
 168         return field_3_first_column;
 169     }
 170
 171     /**
 172      * @return whether or not the first row is a relative reference or not.
 173      */
 174     public boolean isFirstRowRelative()
 175     {
 176         return rowRelative.isSet(field_3_first_column);
 177     }
 178
 179     /**
 180      * sets the first row to relative or not
 181      * @param rel is relative or not.
 182      */
 183     public void setFirstRowRelative(boolean rel) {
 184         field_3_first_column=rowRelative.setShortBoolean(field_3_first_column,rel);
 185     }
 186
 187     /**
 188      * @return isrelative first column to relative or not
 189      */
 190     public boolean isFirstColRelative()
 191     {
 192         return colRelative.isSet(field_3_first_column);
 193     }
 194
 195     /**
 196      * set whether the first column is relative
 197      */
 198     public void setFirstColRelative(boolean rel) {
 199         field_3_first_column=colRelative.setShortBoolean(field_3_first_column,rel);
 200     }
 201
 202     /**
 203      * set the first column in the area
 204      */
 205     public void setFirstColumn(short column)
 206     {
 207         field_3_first_column=columnMask.setShortValue(field_3_first_column, column);
 208     }
 209
 210     /**
 211      * set the first column irespective of the bitmasks
 212      */
 213     public void setFirstColumnRaw(short column)
 214     {
 215         field_3_first_column = column;
 216     }
 217
 218     /**
 219      * @return lastcolumn in the area
 220      */
 221     public short getLastColumn()
 222     {
 223         return columnMask.getShortValue(field_4_last_column);
 224     }
 225
 226     /**
 227      * @return last column and bitmask (the raw field)
 228      */
 229     public short getLastColumnRaw()
 230     {
 231         return field_4_last_column;
 232     }
 233
 234     /**
 235      * @return last row relative or not
 236      */
 237     public boolean isLastRowRelative()
 238     {
 239         return rowRelative.isSet(field_4_last_column);
 240     }
 241
 242     /**
 243      * set whether the last row is relative or not
 244      * @param rel <code>true</code> if the last row relative, else
 245      * <code>false</code>
 246      */
 247     public void setLastRowRelative(boolean rel) {
 248         field_4_last_column=rowRelative.setShortBoolean(field_4_last_column,rel);
 249     }
 250
 251     /**
 252      * @return lastcol relative or not
 253      */
 254     public boolean isLastColRelative()
 255     {
 256         return colRelative.isSet(field_4_last_column);
 257     }
 258
 259     /**
 260      * set whether the last column should be relative or not
 261      */
 262     public void setLastColRelative(boolean rel) {
 263         field_4_last_column=colRelative.setShortBoolean(field_4_last_column,rel);
 264     }
 265
 266
 267     /**
 268      * set the last column in the area
 269      */
 270     public void setLastColumn(short column)
 271     {
 272         field_4_last_column=columnMask.setShortValue(field_4_last_column, column);
 273     }
 274
 275     /**
 276      * set the last column irrespective of the bitmasks
 277      */
 278     public void setLastColumnRaw(short column)
 279     {
 280         field_4_last_column = column;
 281     }
 282
 283     public String toFormulaString(Workbook book)
 284     {
 285          return (new CellReference(getFirstRow(),getFirstColumn(),!isFirstRowRelative(),!isFirstColRelative())).toString() + ":" +
 286                 (new CellReference(getLastRow(),getLastColumn(),!isLastRowRelative(),!isLastColRelative())).toString();
 287     }
 288
 289     public byte getDefaultOperandClass() {
 290         return Ptg.CLASS_REF;
 291     }
 292
 293     public Object clone() {
 294       AreaPtg ptg = new AreaPtg();
 295       ptg.field_1_first_row = field_1_first_row;
 296       ptg.field_2_last_row = field_2_last_row;
 297       ptg.field_3_first_column = field_3_first_column;
 298       ptg.field_4_last_column = field_4_last_column;
 299       ptg.setClass(ptgClass);
 300       return ptg;
 301     }
 302
 303 }