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.BitField;
62   import org.apache.poi.util.LittleEndian;
63   import org.apache.poi.util.StringUtil;
64   import org.apache.poi.util.HexDump;
65   
66   /**
67    * The plot growth record specifies the scaling factors used when a font is scaled.
68    * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
69    *       remove the record in src/records/definitions.
70   
71    * @author Glen Stampoultzis (glens at apache.org)
72    */
73   public class PlotGrowthRecord
74       extends Record
75   {
76       public final static short      sid                             = 0x1064;
77       private  int        field_1_horizontalScale;
78       private  int        field_2_verticalScale;
79   
80   
81       public PlotGrowthRecord()
82       {
83   
84       }
85   
86       /**
87        * Constructs a PlotGrowth record and sets its fields appropriately.
88        *
89        * @param id    id must be 0x1064 or an exception
90        *              will be throw upon validation
91        * @param size  size the size of the data area of the record
92        * @param data  data of the record (should not contain sid/len)
93        */
94   
95       public PlotGrowthRecord(short id, short size, byte [] data)
96       {
97           super(id, size, data);
98       }
99   
100      /**
101       * Constructs a PlotGrowth record and sets its fields appropriately.
102       *
103       * @param id    id must be 0x1064 or an exception
104       *              will be throw upon validation
105       * @param size  size the size of the data area of the record
106       * @param data  data of the record (should not contain sid/len)
107       * @param offset of the record's data
108       */
109  
110      public PlotGrowthRecord(short id, short size, byte [] data, int offset)
111      {
112          super(id, size, data, offset);
113      }
114  
115      /**
116       * Checks the sid matches the expected side for this record
117       *
118       * @param id   the expected sid.
119       */
120      protected void validateSid(short id)
121      {
122          if (id != sid)
123          {
124              throw new RecordFormatException("Not a PlotGrowth record");
125          }
126      }
127  
128      protected void fillFields(byte [] data, short size, int offset)
129      {
130          field_1_horizontalScale         = LittleEndian.getInt(data, 0x0 + offset);
131          field_2_verticalScale           = LittleEndian.getInt(data, 0x4 + offset);
132  
133      }
134  
135      public String toString()
136      {
137          StringBuffer buffer = new StringBuffer();
138  
139          buffer.append("[PlotGrowth]\n");
140  
141          buffer.append("    .horizontalScale      = ")
142              .append("0x")
143              .append(HexDump.toHex((int)getHorizontalScale()))
144              .append(" (").append(getHorizontalScale()).append(" )\n");
145  
146          buffer.append("    .verticalScale        = ")
147              .append("0x")
148              .append(HexDump.toHex((int)getVerticalScale()))
149              .append(" (").append(getVerticalScale()).append(" )\n");
150  
151          buffer.append("[/PlotGrowth]\n");
152          return buffer.toString();
153      }
154  
155      public int serialize(int offset, byte[] data)
156      {
157          LittleEndian.putShort(data, 0 + offset, sid);
158          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
159  
160          LittleEndian.putInt(data, 4 + offset, field_1_horizontalScale);
161          LittleEndian.putInt(data, 8 + offset, field_2_verticalScale);
162  
163          return getRecordSize();
164      }
165  
166      /**
167       * Size of record (exluding 4 byte header)
168       */
169      public int getRecordSize()
170      {
171          return 4 + 4 + 4;
172      }
173  
174      public short getSid()
175      {
176          return this.sid;
177      }
178  
179  
180      /**
181       * Get the horizontalScale field for the PlotGrowth record.
182       */
183      public int getHorizontalScale()
184      {
185          return field_1_horizontalScale;
186      }
187  
188      /**
189       * Set the horizontalScale field for the PlotGrowth record.
190       */
191      public void setHorizontalScale(int field_1_horizontalScale)
192      {
193          this.field_1_horizontalScale = field_1_horizontalScale;
194      }
195  
196      /**
197       * Get the verticalScale field for the PlotGrowth record.
198       */
199      public int getVerticalScale()
200      {
201          return field_2_verticalScale;
202      }
203  
204      /**
205       * Set the verticalScale field for the PlotGrowth record.
206       */
207      public void setVerticalScale(int field_2_verticalScale)
208      {
209          this.field_2_verticalScale = field_2_verticalScale;
210      }
211  
212  
213  }  // END OF CLASS
214  
215  
216  
217  
218