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       /**
99        * Constructs a SCL record and sets its fields appropriately.
100       *
101       * @param id    id must be 0xa0 or an exception
102       *              will be throw upon validation
103       * @param size  size the size of the data area of the record
104       * @param data  data of the record (should not contain sid/len)
105       * @param offset of the record's data
106       */
107  
108      public SCLRecord(short id, short size, byte [] data, int offset)
109      {
110          super(id, size, data, offset);
111      
112      }
113  
114      /**
115       * Checks the sid matches the expected side for this record
116       *
117       * @param id   the expected sid.
118       */
119      protected void validateSid(short id)
120      {
121          if (id != sid)
122          {
123              throw new RecordFormatException("Not a SCL record");
124          }
125      }
126  
127      protected void fillFields(byte [] data, short size, int offset)
128      {
129  
130          int pos = 0;
131          field_1_numerator              = LittleEndian.getShort(data, pos + 0x0 + offset);
132          field_2_denominator            = LittleEndian.getShort(data, pos + 0x2 + offset);
133  
134      }
135  
136      public String toString()
137      {
138          StringBuffer buffer = new StringBuffer();
139  
140          buffer.append("[SCL]\n");
141          buffer.append("    .numerator            = ")
142              .append("0x").append(HexDump.toHex(  getNumerator ()))
143              .append(" (").append( getNumerator() ).append(" )");
144          buffer.append(System.getProperty("line.separator")); 
145          buffer.append("    .denominator          = ")
146              .append("0x").append(HexDump.toHex(  getDenominator ()))
147              .append(" (").append( getDenominator() ).append(" )");
148          buffer.append(System.getProperty("line.separator")); 
149  
150          buffer.append("[/SCL]\n");
151          return buffer.toString();
152      }
153  
154      public int serialize(int offset, byte[] data)
155      {
156          int pos = 0;
157  
158          LittleEndian.putShort(data, 0 + offset, sid);
159          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
160  
161          LittleEndian.putShort(data, 4 + offset + pos, field_1_numerator);
162          LittleEndian.putShort(data, 6 + offset + pos, field_2_denominator);
163  
164          return getRecordSize();
165      }
166  
167      /**
168       * Size of record (exluding 4 byte header)
169       */
170      public int getRecordSize()
171      {
172          return 4  + 2 + 2;
173      }
174  
175      public short getSid()
176      {
177          return this.sid;
178      }
179  
180      public Object clone() {
181          SCLRecord rec = new SCLRecord();
182      
183          rec.field_1_numerator = field_1_numerator;
184          rec.field_2_denominator = field_2_denominator;
185          return rec;
186      }
187  
188  
189  
190  
191      /**
192       * Get the numerator field for the SCL record.
193       */
194      public short getNumerator()
195      {
196          return field_1_numerator;
197      }
198  
199      /**
200       * Set the numerator field for the SCL record.
201       */
202      public void setNumerator(short field_1_numerator)
203      {
204          this.field_1_numerator = field_1_numerator;
205      }
206  
207      /**
208       * Get the denominator field for the SCL record.
209       */
210      public short getDenominator()
211      {
212          return field_2_denominator;
213      }
214  
215      /**
216       * Set the denominator field for the SCL record.
217       */
218      public void setDenominator(short field_2_denominator)
219      {
220          this.field_2_denominator = field_2_denominator;
221      }
222  
223  
224  }  // END OF CLASS
225  
226  
227  
228  
229