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   
57   package org.apache.poi.hssf.record;
58   
59   
60   
61   import org.apache.poi.util.*;
62   
63   /**
64    * Specifies the window's zoom magnification.  If this record isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
65    * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
66    *       remove the record in src/records/definitions.
67   
68    * @author Andrew C. Oliver (acoliver at apache.org)
69    */
70   public class SCLRecord
71       extends Record
72   {
73       public final static short      sid                             = 0xa0;
74       private  short      field_1_numerator;
75       private  short      field_2_denominator;
76   
77   
78       public SCLRecord()
79       {
80   
81       }
82   
83       /**
84        * Constructs a SCL record and sets its fields appropriately.
85        *
86        * @param id    id must be 0xa0 or an exception
87        *              will be throw upon validation
88        * @param size  size the size of the data area of the record
89        * @param data  data of the record (should not contain sid/len)
90        */
91   
92       public SCLRecord(short id, short size, byte [] data)
93       {
94           super(id, size, data);
95       }
96   
97       /**
98        * Constructs a SCL record and sets its fields appropriately.
99        *
100       * @param id    id must be 0xa0 or an exception
101       *              will be throw upon validation
102       * @param size  size the size of the data area of the record
103       * @param data  data of the record (should not contain sid/len)
104       * @param offset of the record's data
105       */
106  
107      public SCLRecord(short id, short size, byte [] data, int offset)
108      {
109          super(id, size, data, offset);
110      }
111  
112      /**
113       * Checks the sid matches the expected side for this record
114       *
115       * @param id   the expected sid.
116       */
117      protected void validateSid(short id)
118      {
119          if (id != sid)
120          {
121              throw new RecordFormatException("Not a SCL record");
122          }
123      }
124  
125      protected void fillFields(byte [] data, short size, int offset)
126      {
127          field_1_numerator               = LittleEndian.getShort(data, 0x0 + offset);
128          field_2_denominator             = LittleEndian.getShort(data, 0x2 + offset);
129  
130      }
131  
132      public String toString()
133      {
134          StringBuffer buffer = new StringBuffer();
135  
136          buffer.append("[SCL]\n");
137  
138          buffer.append("    .numerator            = ")
139              .append("0x")
140              .append(HexDump.toHex((short)getNumerator()))
141              .append(" (").append(getNumerator()).append(" )\n");
142  
143          buffer.append("    .denominator          = ")
144              .append("0x")
145              .append(HexDump.toHex((short)getDenominator()))
146              .append(" (").append(getDenominator()).append(" )\n");
147  
148          buffer.append("[/SCL]\n");
149          return buffer.toString();
150      }
151  
152      public int serialize(int offset, byte[] data)
153      {
154          LittleEndian.putShort(data, 0 + offset, sid);
155          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
156  
157          LittleEndian.putShort(data, 4 + offset, field_1_numerator);
158          LittleEndian.putShort(data, 6 + offset, field_2_denominator);
159  
160          return getRecordSize();
161      }
162  
163      /**
164       * Size of record (exluding 4 byte header)
165       */
166      public int getRecordSize()
167      {
168          return 4 + 2 + 2;
169      }
170  
171      public short getSid()
172      {
173          return this.sid;
174      }
175  
176  
177      /**
178       * Get the numerator field for the SCL record.
179       */
180      public short getNumerator()
181      {
182          return field_1_numerator;
183      }
184  
185      /**
186       * Set the numerator field for the SCL record.
187       */
188      public void setNumerator(short field_1_numerator)
189      {
190          this.field_1_numerator = field_1_numerator;
191      }
192  
193      /**
194       * Get the denominator field for the SCL record.
195       */
196      public short getDenominator()
197      {
198          return field_2_denominator;
199      }
200  
201      /**
202       * Set the denominator field for the SCL record.
203       */
204      public void setDenominator(short field_2_denominator)
205      {
206          this.field_2_denominator = field_2_denominator;
207      }
208  
209  
210  }  // END OF CLASS
211  
212  
213  
214  
215