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    * @version 2.0-pre
66    */
67   
68   public class GutsRecord
69       extends Record
70   {
71       public final static short sid = 0x80;
72       private short             field_1_left_row_gutter;   // size of the row gutter to the left of the rows
73       private short             field_2_top_col_gutter;    // size of the column gutter above the columns
74       private short             field_3_row_level_max;     // maximum outline level for row gutters
75       private short             field_4_col_level_max;     // maximum outline level for column gutters
76   
77       public GutsRecord()
78       {
79       }
80   
81       /**
82        * Constructs a Guts record and sets its fields appropriately.
83        *
84        * @param id     id must be 0x80 or an exception will be throw upon validation
85        * @param size  the size of the data area of the record
86        * @param data  data of the record (should not contain sid/len)
87        */
88   
89       public GutsRecord(short id, short size, byte [] data)
90       {
91           super(id, size, data);
92       }
93   
94       /**
95        * Constructs a Guts record and sets its fields appropriately.
96        *
97        * @param id     id must be 0x80 or an exception will be throw upon validation
98        * @param size  the size of the data area of the record
99        * @param data  data of the record (should not contain sid/len)
100       * @param offset of the record's data
101       */
102  
103      public GutsRecord(short id, short size, byte [] data, int offset)
104      {
105          super(id, size, data, offset);
106      }
107  
108      protected void validateSid(short id)
109      {
110          if (id != sid)
111          {
112              throw new RecordFormatException("NOT A Guts RECORD");
113          }
114      }
115  
116      protected void fillFields(byte [] data, short size, int offset)
117      {
118          field_1_left_row_gutter = LittleEndian.getShort(data, 0 + offset);
119          field_2_top_col_gutter  = LittleEndian.getShort(data, 2 + offset);
120          field_3_row_level_max   = LittleEndian.getShort(data, 4 + offset);
121          field_4_col_level_max   = LittleEndian.getShort(data, 6 + offset);
122      }
123  
124      /**
125       * set the size of the gutter that appears at the left of the rows
126       *
127       * @param gut  gutter size in screen units
128       */
129  
130      public void setLeftRowGutter(short gut)
131      {
132          field_1_left_row_gutter = gut;
133      }
134  
135      /**
136       * set the size of the gutter that appears at the above the columns
137       *
138       * @param gut  gutter size in screen units
139       */
140  
141      public void setTopColGutter(short gut)
142      {
143          field_2_top_col_gutter = gut;
144      }
145  
146      /**
147       * set the maximum outline level for the row gutter.
148       *
149       * @param max  maximum outline level
150       */
151  
152      public void setRowLevelMax(short max)
153      {
154          field_3_row_level_max = max;
155      }
156  
157      /**
158       * set the maximum outline level for the col gutter.
159       *
160       * @param max  maximum outline level
161       */
162  
163      public void setColLevelMax(short max)
164      {
165          field_4_col_level_max = max;
166      }
167  
168      /**
169       * get the size of the gutter that appears at the left of the rows
170       *
171       * @return gutter size in screen units
172       */
173  
174      public short getLeftRowGutter()
175      {
176          return field_1_left_row_gutter;
177      }
178  
179      /**
180       * get the size of the gutter that appears at the above the columns
181       *
182       * @return gutter size in screen units
183       */
184  
185      public short getTopColGutter()
186      {
187          return field_2_top_col_gutter;
188      }
189  
190      /**
191       * get the maximum outline level for the row gutter.
192       *
193       * @return maximum outline level
194       */
195  
196      public short getRowLevelMax()
197      {
198          return field_3_row_level_max;
199      }
200  
201      /**
202       * get the maximum outline level for the col gutter.
203       *
204       * @return maximum outline level
205       */
206  
207      public short getColLevelMax()
208      {
209          return field_4_col_level_max;
210      }
211  
212      public String toString()
213      {
214          StringBuffer buffer = new StringBuffer();
215  
216          buffer.append("[GUTS]\n");
217          buffer.append("    .leftgutter     = ")
218              .append(Integer.toHexString(getLeftRowGutter())).append("\n");
219          buffer.append("    .topgutter      = ")
220              .append(Integer.toHexString(getTopColGutter())).append("\n");
221          buffer.append("    .rowlevelmax    = ")
222              .append(Integer.toHexString(getRowLevelMax())).append("\n");
223          buffer.append("    .collevelmax    = ")
224              .append(Integer.toHexString(getColLevelMax())).append("\n");
225          buffer.append("[/GUTS]\n");
226          return buffer.toString();
227      }
228  
229      public int serialize(int offset, byte [] data)
230      {
231          LittleEndian.putShort(data, 0 + offset, sid);
232          LittleEndian.putShort(data, 2 + offset, ( short ) 0x8);
233          LittleEndian.putShort(data, 4 + offset, getLeftRowGutter());
234          LittleEndian.putShort(data, 6 + offset, getTopColGutter());
235          LittleEndian.putShort(data, 8 + offset, getRowLevelMax());
236          LittleEndian.putShort(data, 10 + offset, getColLevelMax());
237          return getRecordSize();
238      }
239  
240      public int getRecordSize()
241      {
242          return 12;
243      }
244  
245      public short getSid()
246      {
247          return this.sid;
248      }
249  }
250