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    * The font basis record stores various font metrics.
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 Glen Stampoultzis (glens at apache.org)
69    */
70   public class FontBasisRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1060;
74       private  short      field_1_xBasis;
75       private  short      field_2_yBasis;
76       private  short      field_3_heightBasis;
77       private  short      field_4_scale;
78       private  short      field_5_indexToFontTable;
79   
80   
81       public FontBasisRecord()
82       {
83   
84       }
85   
86       /**
87        * Constructs a FontBasis record and sets its fields appropriately.
88        *
89        * @param id    id must be 0x1060 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 FontBasisRecord(short id, short size, byte [] data)
96       {
97           super(id, size, data);
98       
99       }
100  
101      /**
102       * Constructs a FontBasis record and sets its fields appropriately.
103       *
104       * @param id    id must be 0x1060 or an exception
105       *              will be throw upon validation
106       * @param size  size the size of the data area of the record
107       * @param data  data of the record (should not contain sid/len)
108       * @param offset of the record's data
109       */
110  
111      public FontBasisRecord(short id, short size, byte [] data, int offset)
112      {
113          super(id, size, data, offset);
114      
115      }
116  
117      /**
118       * Checks the sid matches the expected side for this record
119       *
120       * @param id   the expected sid.
121       */
122      protected void validateSid(short id)
123      {
124          if (id != sid)
125          {
126              throw new RecordFormatException("Not a FontBasis record");
127          }
128      }
129  
130      protected void fillFields(byte [] data, short size, int offset)
131      {
132  
133          int pos = 0;
134          field_1_xBasis                 = LittleEndian.getShort(data, pos + 0x0 + offset);
135          field_2_yBasis                 = LittleEndian.getShort(data, pos + 0x2 + offset);
136          field_3_heightBasis            = LittleEndian.getShort(data, pos + 0x4 + offset);
137          field_4_scale                  = LittleEndian.getShort(data, pos + 0x6 + offset);
138          field_5_indexToFontTable       = LittleEndian.getShort(data, pos + 0x8 + offset);
139  
140      }
141  
142      public String toString()
143      {
144          StringBuffer buffer = new StringBuffer();
145  
146          buffer.append("[FBI]\n");
147          buffer.append("    .xBasis               = ")
148              .append("0x").append(HexDump.toHex(  getXBasis ()))
149              .append(" (").append( getXBasis() ).append(" )");
150          buffer.append(System.getProperty("line.separator")); 
151          buffer.append("    .yBasis               = ")
152              .append("0x").append(HexDump.toHex(  getYBasis ()))
153              .append(" (").append( getYBasis() ).append(" )");
154          buffer.append(System.getProperty("line.separator")); 
155          buffer.append("    .heightBasis          = ")
156              .append("0x").append(HexDump.toHex(  getHeightBasis ()))
157              .append(" (").append( getHeightBasis() ).append(" )");
158          buffer.append(System.getProperty("line.separator")); 
159          buffer.append("    .scale                = ")
160              .append("0x").append(HexDump.toHex(  getScale ()))
161              .append(" (").append( getScale() ).append(" )");
162          buffer.append(System.getProperty("line.separator")); 
163          buffer.append("    .indexToFontTable     = ")
164              .append("0x").append(HexDump.toHex(  getIndexToFontTable ()))
165              .append(" (").append( getIndexToFontTable() ).append(" )");
166          buffer.append(System.getProperty("line.separator")); 
167  
168          buffer.append("[/FBI]\n");
169          return buffer.toString();
170      }
171  
172      public int serialize(int offset, byte[] data)
173      {
174          int pos = 0;
175  
176          LittleEndian.putShort(data, 0 + offset, sid);
177          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
178  
179          LittleEndian.putShort(data, 4 + offset + pos, field_1_xBasis);
180          LittleEndian.putShort(data, 6 + offset + pos, field_2_yBasis);
181          LittleEndian.putShort(data, 8 + offset + pos, field_3_heightBasis);
182          LittleEndian.putShort(data, 10 + offset + pos, field_4_scale);
183          LittleEndian.putShort(data, 12 + offset + pos, field_5_indexToFontTable);
184  
185          return getRecordSize();
186      }
187  
188      /**
189       * Size of record (exluding 4 byte header)
190       */
191      public int getRecordSize()
192      {
193          return 4  + 2 + 2 + 2 + 2 + 2;
194      }
195  
196      public short getSid()
197      {
198          return this.sid;
199      }
200  
201      public Object clone() {
202          FontBasisRecord rec = new FontBasisRecord();
203      
204          rec.field_1_xBasis = field_1_xBasis;
205          rec.field_2_yBasis = field_2_yBasis;
206          rec.field_3_heightBasis = field_3_heightBasis;
207          rec.field_4_scale = field_4_scale;
208          rec.field_5_indexToFontTable = field_5_indexToFontTable;
209          return rec;
210      }
211  
212  
213  
214  
215      /**
216       * Get the x Basis field for the FontBasis record.
217       */
218      public short getXBasis()
219      {
220          return field_1_xBasis;
221      }
222  
223      /**
224       * Set the x Basis field for the FontBasis record.
225       */
226      public void setXBasis(short field_1_xBasis)
227      {
228          this.field_1_xBasis = field_1_xBasis;
229      }
230  
231      /**
232       * Get the y Basis field for the FontBasis record.
233       */
234      public short getYBasis()
235      {
236          return field_2_yBasis;
237      }
238  
239      /**
240       * Set the y Basis field for the FontBasis record.
241       */
242      public void setYBasis(short field_2_yBasis)
243      {
244          this.field_2_yBasis = field_2_yBasis;
245      }
246  
247      /**
248       * Get the height basis field for the FontBasis record.
249       */
250      public short getHeightBasis()
251      {
252          return field_3_heightBasis;
253      }
254  
255      /**
256       * Set the height basis field for the FontBasis record.
257       */
258      public void setHeightBasis(short field_3_heightBasis)
259      {
260          this.field_3_heightBasis = field_3_heightBasis;
261      }
262  
263      /**
264       * Get the scale field for the FontBasis record.
265       */
266      public short getScale()
267      {
268          return field_4_scale;
269      }
270  
271      /**
272       * Set the scale field for the FontBasis record.
273       */
274      public void setScale(short field_4_scale)
275      {
276          this.field_4_scale = field_4_scale;
277      }
278  
279      /**
280       * Get the index to font table field for the FontBasis record.
281       */
282      public short getIndexToFontTable()
283      {
284          return field_5_indexToFontTable;
285      }
286  
287      /**
288       * Set the index to font table field for the FontBasis record.
289       */
290      public void setIndexToFontTable(short field_5_indexToFontTable)
291      {
292          this.field_5_indexToFontTable = field_5_indexToFontTable;
293      }
294  
295  
296  }  // END OF CLASS
297  
298  
299  
300  
301