1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.record;
57   
58   import org.apache.poi.util.LittleEndian;
59   
60   /**
61    * Title:        Guts Record <P>
62    * Description:  Row/column gutter sizes <P>
63    * REFERENCE:  PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
64    * @author Andrew C. Oliver (acoliver at apache dot org)
65    * @author Jason Height (jheight at chariot dot net dot au)
66    * @version 2.0-pre
67    */
68   
69   public class GutsRecord
70       extends Record
71   {
72       public final static short sid = 0x80;
73       private short             field_1_left_row_gutter;   // size of the row gutter to the left of the rows
74       private short             field_2_top_col_gutter;    // size of the column gutter above the columns
75       private short             field_3_row_level_max;     // maximum outline level for row gutters
76       private short             field_4_col_level_max;     // maximum outline level for column gutters
77   
78       public GutsRecord()
79       {
80       }
81   
82       /**
83        * Constructs a Guts record and sets its fields appropriately.
84        *
85        * @param id     id must be 0x80 or an exception will be throw upon validation
86        * @param size  the size of the data area of the record
87        * @param data  data of the record (should not contain sid/len)
88        */
89   
90       public GutsRecord(short id, short size, byte [] data)
91       {
92           super(id, size, data);
93       }
94   
95       /**
96        * Constructs a Guts record and sets its fields appropriately.
97        *
98        * @param id     id must be 0x80 or an exception will be throw upon validation
99        * @param size  the size of the data area of the record
100       * @param data  data of the record (should not contain sid/len)
101       * @param offset of the record's data
102       */
103  
104      public GutsRecord(short id, short size, byte [] data, int offset)
105      {
106          super(id, size, data, offset);
107      }
108  
109      protected void validateSid(short id)
110      {
111          if (id != sid)
112          {
113              throw new RecordFormatException("NOT A Guts RECORD");
114          }
115      }
116  
117      protected void fillFields(byte [] data, short size, int offset)
118      {
119          field_1_left_row_gutter = LittleEndian.getShort(data, 0 + offset);
120          field_2_top_col_gutter  = LittleEndian.getShort(data, 2 + offset);
121          field_3_row_level_max   = LittleEndian.getShort(data, 4 + offset);
122          field_4_col_level_max   = LittleEndian.getShort(data, 6 + offset);
123      }
124  
125      /**
126       * set the size of the gutter that appears at the left of the rows
127       *
128       * @param gut  gutter size in screen units
129       */
130  
131      public void setLeftRowGutter(short gut)
132      {
133          field_1_left_row_gutter = gut;
134      }
135  
136      /**
137       * set the size of the gutter that appears at the above the columns
138       *
139       * @param gut  gutter size in screen units
140       */
141  
142      public void setTopColGutter(short gut)
143      {
144          field_2_top_col_gutter = gut;
145      }
146  
147      /**
148       * set the maximum outline level for the row gutter.
149       *
150       * @param max  maximum outline level
151       */
152  
153      public void setRowLevelMax(short max)
154      {
155          field_3_row_level_max = max;
156      }
157  
158      /**
159       * set the maximum outline level for the col gutter.
160       *
161       * @param max  maximum outline level
162       */
163  
164      public void setColLevelMax(short max)
165      {
166          field_4_col_level_max = max;
167      }
168  
169      /**
170       * get the size of the gutter that appears at the left of the rows
171       *
172       * @return gutter size in screen units
173       */
174  
175      public short getLeftRowGutter()
176      {
177          return field_1_left_row_gutter;
178      }
179  
180      /**
181       * get the size of the gutter that appears at the above the columns
182       *
183       * @return gutter size in screen units
184       */
185  
186      public short getTopColGutter()
187      {
188          return field_2_top_col_gutter;
189      }
190  
191      /**
192       * get the maximum outline level for the row gutter.
193       *
194       * @return maximum outline level
195       */
196  
197      public short getRowLevelMax()
198      {
199          return field_3_row_level_max;
200      }
201  
202      /**
203       * get the maximum outline level for the col gutter.
204       *
205       * @return maximum outline level
206       */
207  
208      public short getColLevelMax()
209      {
210          return field_4_col_level_max;
211      }
212  
213      public String toString()
214      {
215          StringBuffer buffer = new StringBuffer();
216  
217          buffer.append("[GUTS]\n");
218          buffer.append("    .leftgutter     = ")
219              .append(Integer.toHexString(getLeftRowGutter())).append("\n");
220          buffer.append("    .topgutter      = ")
221              .append(Integer.toHexString(getTopColGutter())).append("\n");
222          buffer.append("    .rowlevelmax    = ")
223              .append(Integer.toHexString(getRowLevelMax())).append("\n");
224          buffer.append("    .collevelmax    = ")
225              .append(Integer.toHexString(getColLevelMax())).append("\n");
226          buffer.append("[/GUTS]\n");
227          return buffer.toString();
228      }
229  
230      public int serialize(int offset, byte [] data)
231      {
232          LittleEndian.putShort(data, 0 + offset, sid);
233          LittleEndian.putShort(data, 2 + offset, ( short ) 0x8);
234          LittleEndian.putShort(data, 4 + offset, getLeftRowGutter());
235          LittleEndian.putShort(data, 6 + offset, getTopColGutter());
236          LittleEndian.putShort(data, 8 + offset, getRowLevelMax());
237          LittleEndian.putShort(data, 10 + offset, getColLevelMax());
238          return getRecordSize();
239      }
240  
241      public int getRecordSize()
242      {
243          return 12;
244      }
245  
246      public short getSid()
247      {
248          return this.sid;
249      }
250  
251      public Object clone() {
252        GutsRecord rec = new GutsRecord();
253        rec.field_1_left_row_gutter = field_1_left_row_gutter;
254        rec.field_2_top_col_gutter = field_2_top_col_gutter;
255        rec.field_3_row_level_max = field_3_row_level_max;
256        rec.field_4_col_level_max = field_4_col_level_max;
257        return rec;
258      }
259  }
260